-
Notifications
You must be signed in to change notification settings - Fork 47
Creating and deploying a release
Matthew Evans edited this page Apr 25, 2020
·
5 revisions
The process for creating a release is the following:
- On a local branch at the head of
master
, useinvoke setver --new-ver <version>
to create a new release with the appropriate version. If you are preparing a patch release, simply useinvoke setver --patch
to bump the minor version. - Use
invoke update-openapijson
to generate the Open API schema with the new (semver) version number. - Commit the changes from steps 1 and 2 and push the branch to GitHub.
- Create a PR that contains only the version bumping commit and make an effort to summarize all changes since the last version, broken down by new features, updates and bug fixes (for a complete example, see #251.
- Once the PR has been reviewed, it can be rebased/squashed onto
master
. - Create a git tag on the new head of
master
(i.e. after the PR has been merged) that contains the raw PR description as the tag message. - Create a GitHub release based on this tag; this should then automatically deploy to PyPI.