Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Phase One Release Checklist

  1. Branch Hygiene

    • Ensure main is green (CI pipeline complete).
    • Review outstanding ADRs and docs for freshness.

  2. Build & Test

    • just ci
    • just build-release
    • just api-export

  3. 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 the artifacthub.io metadata tag and helm verify against the published public key

  4. Runbook Execution

    • Run just runbook
    • Follow the remaining manual-only drills in docs/runbook.md
    • Archive CLI telemetry, /metrics, /health/full snapshots.

  5. Documentation Refresh

    • Verify ADRs 005–007 reflect current design.
    • Update user guides (docs/api/guides/*.md) with any behavioural changes.

  6. 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-release workflow, 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/signKey URL resolves.
    • Confirm the GHCR chart package is public so Artifact Hub can pull oci://ghcr.io/<owner>/charts/revaer anonymously.
    • In Artifact Hub, add or claim oci://ghcr.io/<owner>/charts/revaer, then verify that the published artifacthub.io metadata tag includes the expected repository ID and owner identity.
    • After Artifact Hub shows Verified publisher, file the official status request for the Revaer publisher or organization. Use revaer-logo.png for the Artifact Hub repository and organization logo during that setup.

  7. Post-Release Monitoring

    • Watch rate-limit and guard-rail metrics.
    • Confirm HealthChanged events return to empty degraded set.
    • Validate automation telemetry for CLI success rates.