Releasing

How maintainers cut a RowGuard release.

Checklist

  1. Ensure main is green (CI: tests, docs, examples).

  2. Update version in:

    • pyproject.toml (project.version)

    • src/rowguard/__init__.py (__version__)

    • docs/conf.py (release / version)

  3. Update CHANGELOG.md (Keep a Changelog; add Upgrade notes for breaking changes; add compare link).

  4. Update docs/project/supported.md if the shipped surface changed.

  5. Sync public docs contracts:

    • API.md / docs/reference/errors.md match src/rowguard/api.py and exports

    • Grep for stale version banners (0.4 as “current”, unshipped APIs in present tense)

  6. Commit on main (or merge the release PR).

  7. Tag and push:

git tag -a v0.6.0 -m "v0.6.0"
git push origin v0.6.0

  1. GitHub Actions (.github/workflows/release.yml) builds and publishes to PyPI when a v* tag is pushed (requires PYPI_API_TOKEN secret).

  2. Confirm the docs build on Read the Docs for the new tag/version.

  3. Spot-check PyPI: pip install rowguard==…

Versioning

RowGuard follows Semantic Versioning. Before 1.0, minor versions may include breaking changes; document them clearly in the changelog.