search

executablebooks / cookiecutter-jupyter-book

Cookiecutter template for a simple jupyter book
https://executablebooks.github.io/cookiecutter-jupyter-book/
BSD 3-Clause "New" or "Revised" License
140 stars 53 forks source link

✨ NEW: include .gitlab-ci.yml for GitLab users #9

Closed slemonide closed 3 years ago

slemonide commented 4 years ago

This solves issue #7.

TomasBeuzen commented 4 years ago

@slemonide - thanks for this PR! I'm not familiar with GitLab and did wonder if GitLab users would be using this project - which is currently very much GitHub-inclined.

I've made a few changes, most notably, I've renamed the "include_github_actions" cookiecutter option to:

Select include_ci:
1 - github
2 - gitlab
3 - no

In future, I'd like to make the interface more platform-agnostic. I'll create an issue about that. Anyway feel free to run an eye over these changes - but otherwise LGTM.

slemonide commented 3 years ago

https://github.com/slemonide/cookiecutter-jupyter-book/blob/845770037be40b84c1a393da10c88607e2a58492/%7B%7Bcookiecutter.book_slug%7D%7D/%7B%7Bcookiecutter.book_slug%7D%7D/_config.yml#L45

This probably also should be changed. But sphinx-book-theme would have to be modified first to support non-github locations.

This will need to be changed too: https://github.com/executablebooks/cookiecutter-jupyter-book/blob/845770037be40b84c1a393da10c88607e2a58492/hooks/post_gen_project.py#L79

slemonide commented 3 years ago

But that should probably be a different issue/pull request.

slemonide commented 3 years ago

There probably also should be some tests to verify that builds with this .github-ci.yml file succeed.

TomasBeuzen commented 3 years ago

I have a few ideas for the above - I'll push some changes to this PR within the next week or so when I get a chance

TomasBeuzen commented 3 years ago

I've opened #10 to address some of the concerns raised in this PR but will merge this in the morning