Skip to content

Release process

This repo uses simple git tags.

Local steps

  1. Ensure tests are green:
python -m unittest discover -s tests -p "test*.py"
  1. Bump the version in pyproject.toml (and CITATION.cff if you keep it in sync).
  2. Update CHANGELOG.md.
  3. Commit and tag:
git commit -am "Release X.Y.Z: ..."
git tag -a vX.Y.Z -m "vX.Y.Z"
  1. Push:
git push origin main --tags

GitHub release

Create a GitHub Release from the new tag and paste the changelog entry.