This guide describes how to release stimpool on Github and Pypi.
-
Create new branch named
bump-stimpool-version-[version-number]
. -
Add a label to the branch that describes the part of the version number that will be bumped. Possible parts are major, minor, and patch.
-
Bump the version
$ poetry run invoke version part # possible: major / minor / patch
-
Document changes in the CHANGELOG.md (only a summary)
-
Commit the changes
$ git add . $ git commit
-
Push the tags to Github
$ git push $ git push --tags
-
If all checks pass in the ci, merge this branch into the master branch.
-
Complete the final version of the latest release draft on GitHub. This draft was automatically generated by release-drafter.
- Make sure the version and tag associated with it are correct
- Add a summary of the changes
- Revise the draft and make any appropriate changes
-
Publish the draft on GitHub
The release will be automatically published on pypi. Please check the GitHub action named release pypi passed and check everything is correct in pypi.