Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
74 lines (52 loc) · 2.46 KB

RELEASE_CHECKLIST.md

File metadata and controls

74 lines (52 loc) · 2.46 KB
Raw

Release Checklist

Use this checklist before tagging and publishing a release artifact.

Audit / sign-off: after shipping, record parity verification and complete the maintainer table in docs/audit/FINAL_ENTERPRISE_HARDENING_SIGNOFF.md. Step-by-step publish order: docs/audit/PYPI_PUBLISH_AND_VERIFY.md.

Required Order

  1. Confirm branch and release scope are correct.
  2. Validate version consistency from canonical source.
  3. Run quality and coverage gates.
  4. Validate benchmark profile health.
  5. Build and verify distribution artifacts.
  6. Confirm security scan status.
  7. Capture release evidence in PR/release notes.

Commands

Preferred single-command preflight:

.hydra_env/bin/python scripts/release/preflight.py

Optional fast mode (skip heavy benchmark/build checks):

.hydra_env/bin/python scripts/release/preflight.py --skip-benchmark --skip-build

If you need persisted benchmark evidence for release notes, run a saved benchmark explicitly:

.hydra_env/bin/python benchmark/performance_benchmark.py --profile pr_gate

PyPI publication parity (post-upload)

After twine upload (or CI publish) completes, confirm the public index reflects the tag you intended:

.hydra_env/bin/python scripts/release/check_pypi_parity.py --require-match

Optional: include the same check in an integrated preflight run (requires network):

.hydra_env/bin/python scripts/release/preflight.py --pypi-parity

Expect this step to fail until the new version is visible on PyPI (and classifiers match setup.py).

Gate Details

  • Version consistency: scripts/dev/check_version_consistency.py must pass.
  • Tests: full unit suite and hydra_logger coverage gate (>=95%) must pass.
  • Header policy: slim metadata header validation must pass.
  • Benchmark sanity: benchmark/performance_benchmark.py --profile pr_gate should complete with valid guard evidence.
  • Package quality: python -m build, twine check, and dist-content verification must pass.
  • Security posture: lint/security workflow outputs must be reviewed before publish.

Release Evidence

Capture at minimum:

  • commit SHA and tag candidate
  • full preflight output
  • CI run URL for green release candidate build
  • benchmark JSON artifact used for release decision (from an explicit saved benchmark run)
  • any accepted residual risks with owner + follow-up date