thaloco/aman
1
Fork 0
Code Pull requests Releases Packages Activity Actions
aman/docs/release-checklist.md
Thales Maciel 9ccf73cff5 Define the X11 support contract for milestone 1 
Clarify the current release channels versus the X11 GA target so the project has an explicit support promise before milestone 2 delivery work begins.

Update the README, persona and distribution docs, and release checklist with a support matrix, the systemd --user daily-use path, the manual aman run support path, and the canonical recovery sequence. Mark milestone 1 complete in the roadmap once that contract is documented.

Align run, doctor, and self-check help text with the same service and diagnostics language without changing command behavior.

Validated with PYTHONPATH=src python3 -m aman --help, PYTHONPATH=src python3 -m aman doctor --help, and PYTHONPATH=src python3 -m aman self-check --help. Excludes generated src/aman.egg-info and prior user-readiness notes.
2026-03-12 14:14:24 -03:00

1.7 KiB
Raw Blame History

Release Checklist

This checklist covers both current releases and the future X11 GA bar. The GA signoff sections are required for v1.0.0 and later.

  1. Update CHANGELOG.md with final release notes.
  2. Bump project.version in pyproject.toml.
  3. Run quality and build gates:
    • make release-check
    • make check-default-model
  4. Ensure model promotion artifacts are current:
    • benchmarks/results/latest.json has the latest winner_recommendation.name
    • benchmarks/model_artifacts.json contains that winner with URL + SHA256
    • make sync-default-model (if constants drifted)
  5. Build packaging artifacts:
    • make package
  6. Verify artifacts:
    • dist/*.whl
    • dist/*.tar.gz
    • dist/*.deb
    • dist/arch/PKGBUILD
  7. Tag release:
    • git tag vX.Y.Z
    • git push origin vX.Y.Z
  8. Publish release and upload package artifacts from dist/.
  9. GA support-contract signoff (v1.0.0 and later):
    • README.md and docs/persona-and-distribution.md agree on supported environment assumptions.
    • The support matrix names X11, runtime dependency ownership, systemd --user, and the representative distro families.
    • Service mode is documented as the default daily-use path and aman run as the manual support/debug path.
    • The recovery sequence aman doctor -> aman self-check -> journalctl --user -u aman -> aman run --verbose is documented consistently.
  10. GA validation signoff (v1.0.0 and later):
  • Validation evidence exists for Debian/Ubuntu, Arch, Fedora, and openSUSE.
  • The portable installer, upgrade path, and uninstall path are validated.
  • End-user docs and release notes match the shipped artifact set.
  • Public metadata, checksums, and support/reporting surfaces are complete.