Skip to main content

Publish a release

The root VERSION file is the public package version. Merging a version-only pull request into main starts Release - Publish automatically. It waits for CI - Main and CI - Security to finish on that merge commit, then releases the artifacts built from that exact commit. Later merges into main do not change the release source. The other workspace projects stay at 0.0.0.

Checklist

  1. Run Actions → Release - Prepare on main, then merge its pull request
  2. Watch the automatic Release - Publish run after the merge. It waits for CI - Main and CI - Security on the version commit
  3. Check the GitHub release and its Compose file, PyPI package, and GHCR version and latest tags
Release - Prepare creates a ready-for-review pull request that changes only VERSION. Its RELEASE_GITHUB_TOKEN must have permission to create branches and pull requests; using this token also starts pull request checks. Release - Publish starts on a main push whose final commit changes only VERSION. It checks that the version has not already been tagged and that CI - Main and CI - Security passed for the source SHA. It uses the validated Python and container artifacts from that exact commit’s successful CI - Main run. CI - Main builds and tests Linux AMD64 and ARM64 images on native runners and combines their digests into one manifest. Release installation and container verification run on both architectures, and the published Compose file pins the combined manifest digest. It checks installation and live providers before creating the tag, then publishes and verifies the package and image. The release environment supplies provider credentials and RELEASE_GITHUB_TOKEN; PyPI uses its trusted publisher for release.yml. Actions → Release - Publish also accepts a full source SHA on main for manual recovery. The source can be the version pull request’s merge commit or a later green fix with the same version. A manual run checks both workflows and artifacts for that exact SHA without waiting for them.

If a release fails