-
Notifications
You must be signed in to change notification settings - Fork 157
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Uploading docs to gh-pages using GitHub Actions #403
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this is very nice!
I was just checking the documentation… and was kind of missing the "customary" documentation badge on top of the readme. Does Github actions provide us with such a thing?
Also reminds me that we should move away from Travis, too…
@matz-e Indeed GitHub supports badges, and it's a good idea to have it. It needed a minor rename, but it is included here! See https://github.com/tdegeus/cppcolormap where I verified that it works |
BTW, I moved to GH Action for CI on almost all my projects. I mussed say, it makes a huge difference. I can highly recommend the use of conda (particularly of conda-forge and mamba) for ease of use an maintainability. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, thanks again!
I like Github actions, although I've mostly used it for my Rust explorations. Pretty easy to set up…
Seems to me that you use conda like a Python virtualenv here. I'm wondering if for our use case here this has advantages over OS-specific package managers… i.e., can we run with different versions of HDF5 (1.10, 1.12) with conda using the Github Action matrix?
@matz-e It is true that using different package managers could be more efficient in the case that you want to use different library versions. Indeed, you can do this in the build matrix with conda, but it will probably involve removing/reinstalling. My remark indeed derives from the case that you use a single version of the library. In that case conda is very easy because its syntax is platform independent, and because you can test the environment also locally (and it gives you a way for future users to establish the same environment easily). |
… gh-pages branches is cleared and overwritten with the newly rendered doxygen output
@matz-e With my other sites I noticed that I missing an option to the action that I fixed here. The option takes care of always having the |
Since recently I have been using GitHub Actions to build my docs and upload them to GitHub pages. I set this now to be done when something is pushed to the master, but it could also be done upon releasing.