build: Only deploy docs for latest tag #207
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This brings us one step towards having docs for every tagged version. For now (after the next tag push) there should only be one website for the latest tagged version. Earlier versions can be built offline. Progress to #199. In any case, it is better than the current situation: html documentation is being deployed for every single push on `main`, and the docs website did not indicate a version number anywhere. With these GH workflow adjustments, the docs should still be _built_ for each PR/push to main, allowing to catch errors in the documentation setup as they arise, but the html pages will not deployed to GitHub Pages if there is no tag. The version (obtained from `git describe`) is also indicated clearly on the website landing page and in the API docs sidebar footer. Related things that I rolled in here: - new make target to build docs (simply `make html` in the action spec) - favicon and proper branding (multiple resolutions of logo) - removed a duplicated sentence from the README - `docs/template/README.md` to explain how to maintain the template - fixed `rm -r` -> `rm -rf` in `make clean` recipe
This comment was marked as resolved.
This comment was marked as resolved.
|
I just realised that based on this log maybe I don't need to duplicate the common job steps after all (b2f7d77). I guess the if-check in L63 of docs.yml only evaluates after the "Build" task has completed, so even if we aren't on top of a tag it should still check that |
Patol75
requested changes
Aug 5, 2024
adigitoleo
force-pushed
the
docs-deploy-only-tags
branch
from
9b9bb57
to
006aec9
Compare
Patol75
approved these changes
Aug 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This brings us one step towards having docs for every tagged version. For now (after the next tag push) there should only be one website for the latest tagged version. Earlier versions can be built offline. Progress to #199.
In any case, it is better than the current situation: html documentation is being deployed for every single push on
main, and the docs website did not indicate a version number anywhere. With these GH workflow adjustments, the docs should still be built for each PR/push to main, allowing to catch errors in the documentation setup as they arise, but the html pages will not deployed to GitHub Pages if there is no tag. The version (obtained fromgit describe) is also indicated clearly on the website landing page and in the API docs sidebar footer.Related things that I rolled in here:
make htmlin the action spec)docs/template/README.mdto explain how to maintain the templaterm -r->rm -rfinmake cleanrecipe