Release workflow#
Versioneer (optional)#
Upgrade versioneer if a new version is available.
Check the upgrade notes if additional steps are required
Upgrade versioneer
pip3 install --upgrade versioneer
Remove the old versioneer.py file
rm versioneer.py
Install new versioneer.py file
python3 -m versioneer install --vendor
Revert the changes in src/maicos/__init__.py
Commit changes
Create release#
Make sure changelog is up to date and add release date and commit your changes
git commit -m 'Release vX.X'
Tag commit with the new version
git tag -m 'Release vX.X' vX.X
Test locally!!!
git describe
and
pip3 install .
should result in
vX.X
If a new major release create release branch
git branch release-X-X
otherwise update the release branch with respect to the branch
git checkout release-X-X git rebase -i main
Push branch, tag
git push release-X-X git push --tags
Go to the web interface, add changelog as release message
After the release#
Bump version (Create new section in CHANGELOG.rst)