PyPi Release Checklist¶

For Every Release¶

Check out release branch, merge all changes from master/main to release
Update history.md - Be noticed that github workflow will generate a changelog in changelog.md for you automatically.

Commit the changes:

git add HISTORY.md
git commit -m "Changelog for upcoming release 0.1.1."

Update version number (can also be patch or major)
```
poetry patch
```
Run the tests:
```
tox
```
Push the commit to release branch:
```
git push
```
Push the tags, creating the new release on both GitHub and PyPi:
```
git tag %tag_name%
git push --tags
```
tag_name has to be started with v, to leverage github release workflow.
Check the PyPI listing page to make sure that the README, release notes, and road map display properly. If tox test passed, this should be ok, since we have already run twine check during tox test.

This checklist has been adapted from:

It assumes that you are using all features of Cookiecutter PyPackage.