Adds docs generation and PyPI publishing to the release workflow #52
Conversation
This file contains hidden or 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
Maegereg
reviewed
Sep 9, 2025
Contributor
Maegereg
left a comment
There was a problem hiding this comment.
I'd suggest testing the docs-push job before committing. What I usually do is:
- Add my branch to the whitelist for the docs-push environment.
- Set the dry-run argument to the push-docs action.
- Test it.
- Be sure to remove my branch from the docs-push environment when I'm done.
Otherwise, this looks good!
Co-authored-by: dasm <maegereg@gmail.com>
Co-authored-by: dasm <maegereg@gmail.com>
Contributor
Author
|
Thanks for the instructions, the Push-Docs job really needed testing! I think this is ready to merge now. Note that adding this branch ( |
Maegereg
reviewed
Sep 10, 2025
Maegereg
approved these changes
Sep 10, 2025
This was
unlinked from
issues
Sep 10, 2025
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 adds two jobs to the release workflow:
This PR also changes the accepted tags to remove the "dev" suffix, which I don't think we've ever used. Alpha, beta & rc ought to be enough? It adds comments about our CI to workflow definition files and to CONTRIBUTING.md.
I was able to successfully test the publication to PyPI logic (see here). The docs publication logic cannot be tested because it can only be run from a protected branch, if I understand this error correctly. So I think I need to merge this PR and then create a release using a tag from the main branch to make sure that it works. The job logic itself is copied from
commit.yml, with only the version name different and the additional version check.