Skip to content

Release Process

Versioning

This project uses pre-1.0 semantic versioning.

Release Flow

  1. Update documentation and changelog as part of the release PR.
  2. Ensure CI passes on all supported Python versions.
  3. Create a Git tag in the format vX.Y.Z.
  4. Push the tag to GitHub.
  5. GitHub Actions builds the distribution and publishes it to PyPI through Trusted Publishing.

Required Checks

  • ruff check .
  • mypy src
  • pytest -q
  • uv build
  • twine check dist/*
  • mkdocs build