Releasing

How to release a new version

1. Merge all changes to the main branch.
2. Document all changes in the changelog.
3. Run the following command locally:

   poetry run bump-my-version bump major|minor|patch \
     --verbose --allow-dirty --dry-run
   

   This uses bump-my-version.
4. If everything looks OK, run the same command as in the previous step, but without the --dry-run switch.
5. Push the newly created tag:

   git push --verbose origin --tags
   

6. The GitHub Workflow will take care of the release to PyPI and to GitHub Releases.
7. Edit the release message in the GitHub repository to be nicely formatted, and then link to this documentation.