Release Readiness

Use before cutting a release or enabling production deployment. Ensure versioning, changelog, migration notes, and rollback are clear. GitHub releases friendly.

askaret Updated

File contents

Checklist:

  • Versioning
    • Determine version bump policy (SemVer or repo standard)
    • Update version in all required places (backend + frontend packages)
  • Changelog / release notes
    • Summarize user-facing changes
    • Call out breaking changes and deprecations
    • Include migration steps if schema/data changes exist
  • Database & infra
    • Ensure migrations are safe to run and documented
    • Ensure feature flags are defined and defaulted safely
  • Deployment readiness
    • Health checks present and meaningful
    • Observability in place for new paths (logs/metrics/traces)
    • Rollback plan documented (what happens on rollback? schema compatibility?)
  • GitHub release process
    • Tagging strategy and release artifact list
    • Validate build output matches what is published (no local-only steps)
    • Attach SBOM/provenance if used in repo

Finish with:

  • Release checklist result (pass/fail + gaps)
  • Release notes draft
  • Migration/runbook notes
  • Rollback notes

askaret/codex-skills/tree/main/.agents/skills/release-readiness commit 3726f37386

Frequently asked questions

npx skillmds@latest add askaret/release-readiness