Release Checklist
This checklist covers publication of a selected revision. Transcoding merged in PR #31; that merge alone does not claim a published release. Use the existing workflow gates and release artifacts; do not add separate proof packages or routine completion records.
-
Branch Hygiene
- Ensure
mainis green (CI pipeline complete). - Review outstanding ADRs and docs for freshness.
- Ensure
-
Build & Test
just cijust ciincludes the release build; do not repeat it unless a separate target is required.just api-export
-
Artefact Verification
- Binary:
target/release/revaer-app - Checksum:
sha256sum target/release/revaer-app - OpenAPI:
docs/api/openapi.json - Helm chart:
dist/helm/revaer-<version>.tgz - Helm provenance:
dist/helm/revaer-<version>.tgz.prov - Helm public key:
dist/helm/revaer-helm-public.asc - Helm public keyring:
dist/helm/revaer-helm-public.gpg - Docker image:
just docker-build && just docker-scan - Published GHCR image: verify Trivy scan, SBOM/provenance attestations, and Cosign signatures from the image workflow
- Published OCI chart: verify
oci://ghcr.io/<owner>/charts/revaer:<version>plus theartifacthub.iometadata tag andhelm verifyagainst the published public key
- Binary:
-
Runbook Execution
- Use the existing required API/UI workflow (
just ui-e2e). - Consult
docs/runbook.mdfor deployment-specific drills when applicable. - Keep ordinary output temporary; report failures without an extra archive.
- Use the existing required API/UI workflow (
-
Documentation Refresh
- Reconcile existing operator guides and product contracts with the selected revision.
- Preserve historical ADR decisions; create an ADR only for a new architectural decision requiring approval.
- Update user guides (
docs/platform/*.mdanddocs/ui/*.md) with any behavioural changes.
-
Tag & Publish
- Create annotated tag:
git tag -a vX.Y.Z -m "Phase One release" - Push tag:
git push origin vX.Y.Z - Attach artefacts generated by the
build-releaseworkflow, including the Helm chart archive, provenance file, and Helm public key. - Confirm the OCI chart publish completed after the GitHub release so the
artifacthub.io/signKeyURL resolves. - Confirm the GHCR chart package is public so Artifact Hub can pull
oci://ghcr.io/<owner>/charts/revaeranonymously. - In Artifact Hub, add or claim
oci://ghcr.io/<owner>/charts/revaer, then verify that the publishedartifacthub.iometadata tag includes the expected repository ID and owner identity. - After Artifact Hub shows
Verified publisher, file theofficialstatus request for the Revaer publisher or organization. Use the committed purple stylized-Rrevaer-logo.svgfor the Artifact Hub repository and organization logo during that setup, and visually confirm the rendered mark before publishing.
- Create annotated tag:
-
Post-Release Monitoring
- Watch rate-limit and guard-rail metrics.
- Confirm
HealthChangedevents return to empty degraded set. - Validate automation telemetry for CLI success rates.