706 B
706 B
Releasing
This repo uses Semantic Versioning and Release Please to keep releases organized.
Normal Release Flow (recommended)
- Merge changes into
main. - The
release-pleaseworkflow opens/updates a Release PR that:- bumps the version
- updates
CHANGELOG.md
- Merge the Release PR.
- Release Please creates a Git tag (e.g.
v0.2.0) and a GitHub Release.
Manual Release (if automation is disabled)
- Update
__init__.py__version__andVERSIONto the new version. - Add notes under
CHANGELOG.mdand move them into a new version section. - Commit with a message like:
chore(release): vX.Y.Z - Tag and push:
git tag vX.Y.Z
git push --tags