Skip to content

Release Process

Releases are automated with release-please and GitHub Actions.

How Releases Work

  1. release-please runs on pushes to main and opens/updates a release PR.
  2. The release PR updates:
  3. docs/changelog.md
  4. pyproject.toml (version bump)
  5. Merging the release PR creates a Git tag and GitHub Release.
  6. Docker images are built, signed, and published via the docker-build workflow.

Manual Trigger

You can also run the Release Please workflow manually from GitHub Actions (workflow_dispatch) to open or refresh the release PR.

Notes

  • The changelog used by release-please lives at docs/changelog.md.
  • Avoid manual version edits; use the release-please flow to keep tags and changelog consistent.