The release is automatically handled by the .github/workflows/release.yml
GitHub
action pipeline.
Make sure the version matches the upstream version and increase the last digit in the version number.
We use the tool bump-my-version to handle version changes.
# 0.1.0 -> 0.1.1
poetry run bump-my-version bump patch
# 0.1.1 -> 0.2.0
poetry run bump-my-version bump minor
- add release notes to README
- bumpversion
-
git push
- check build
-
git push --tags
- Check docs with
poetry run mkdocs serve
-
poetry run mkdocs gh-deploy