thaloco/aman
1
Fork 0
Code Pull requests Releases Packages Activity Actions
aman/docs/release-checklist.md
Thales Maciel ed1b59240b
Harden runtime diagnostics for milestone 3 
Make the milestone 3 runtime story predictable instead of treating doctor, self-check, and startup failures as loosely related surfaces.

Split doctor and self-check into distinct read-only flows, add tri-state diagnostic status with stable IDs and next steps, and reuse that wording in CLI output, service logs, and tray-triggered diagnostics. Add non-mutating config/model probes, a make runtime-check gate, and public recovery/validation docs for the X11 GA roadmap.

Validation: make runtime-check; PYTHONPATH=src python3 -m unittest discover -s tests -p 'test_*.py'; python3 -m py_compile src/*.py tests/*.py; PYTHONPATH=src python3 -m aman doctor --help; PYTHONPATH=src python3 -m aman self-check --help. Leave milestone 3 open in the roadmap until the manual X11 validation rows are filled.
2026-03-12 17:41:23 -03:00

2.6 KiB
Raw Blame History

Release Checklist

This checklist covers the current portable X11 release flow and the remaining GA signoff 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 runtime-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/aman-x11-linux-<version>.tar.gz
    • dist/aman-x11-linux-<version>.tar.gz.sha256
    • 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. Portable bundle release signoff:
    • README.md points end users to the portable bundle first.
    • docs/portable-install.md matches the shipped install, upgrade, uninstall, and purge behavior.
    • make package-portable produces the portable tarball and checksum.
    • docs/x11-ga/portable-validation-matrix.md contains current automated evidence and release-specific manual validation entries.
  10. 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.
  1. GA runtime reliability signoff (v1.0.0 and later):
  1. 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.