-
Notifications
You must be signed in to change notification settings - Fork 11
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
Automate documentation releases #242
Conversation
4dd3926
to
3318098
Compare
It would be nice to test this automation a bit - perhaps merging it, but commenting out the publication to PyPI (maybe even using TestPyPI instead). After making sure it all works, the workflow should be updated again to its current rendition (publishing to PyPI). |
Tagged this as |
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.
Smart with the changelog, I realise I need to step up on typos :)
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.
Looks good to me
Don't include the prepended `v` in the version name for the documentation.
Update API reference to include `emmopy.emmopy`.
7f8cf80
to
54fab0b
Compare
The "Check documentation" CI will fail now, since I added a step to test the build of the documentation using the |
Description:
Closes #232.
This implements several CI/CD jobs:
latest
(aliasmaster
) whenever a push event happens formaster
.master
.stable
to point to it) whenever a new release is published.This also implements a changelog.
The changelog is auto-generated using the github-changelog-generator in the form of the CharMixer GitHub action.
The changelog will only update on new releases.
Furthermore, a special "this release version" changelog is created and appended to the release description.
An example of this can be seen here, where everything above
# Changelog
is the original release description.Type of change:
Checklist:
This checklist can be used as a help for the reviewer.
Comments:
To see the new changelog in the documentation do the following:
Then go to http://127.0.0.1:8000/EMMO-python/CHANGELOG to see the changelog.