Release workflow¶
Fill the
CHANGELOG.mdwith the new version. You can write it manually or use the auto-generated release notes by Github:Go to project’s releases and click on
Draft a new releaseIn
Choose a tag, enter the new tagClick on
Generate release notesCopy/paste the generated text from
## What's changeduntil the line before**Full changelog**:...in the CHANGELOG.md replacingWhat's changedwith the tag and the publication date
Change the version number in
__about__.pyApply a git tag with the relevant version:
git tag -a 0.3.0 {git commit hash} -m "New awesome feature"Push tag to main branch:
git push origin --tags
If things go wrong (failed CI/CD pipeline, missed step…), here comes the fix process:
git tag -d old
git push origin :refs/tags/old
git push --tags
And try again!