Release Guide

March 25, 2026 ยท View on GitHub

Purpose

Define repeatable steps to cut and publish a release.

Versioning

Use SemVer:

  • Major: breaking changes
  • Minor: new features
  • Patch: fixes and docs

Pre-Release Checklist

  1. Update CHANGELOG.md with version and date.
  2. Move release-ready notes out of Unreleased and leave Unreleased ready for the next cycle.
  3. Run ./scripts/run-tests.sh locally.
  4. Confirm CI is green.
  5. Verify docs match released behavior.
  6. Create version tag (for example v0.6.0).

Publish

  1. Push release tag.
  2. Create GitHub release from changelog entry.
  3. Post release note announcement if needed.

Post-Release

  • Monitor issues for regressions.
  • Triage and label follow-up reports.