thaloco/aman
1
Fork 0
Code Pull requests Releases Packages Activity Actions
aman/docs/release-checklist.md
Thales Maciel 31a1e069b3
Prepare the 1.0.0 GA release surface 
Add the repo-side pieces for milestone 5: MIT licensing, real maintainer and forge metadata, a public support doc, 1.0.0 release notes, release-prep tooling, and CI uploads for the full candidate artifact set.

Keep source-tree version surfaces honest by reading the local project version in the CLI and About dialog, and cover the new release-prep plus version-fallback behavior with focused tests.

Document where raw validation evidence belongs, add the GA validation rollup, and archive the latest readiness review. Milestone 5 remains open until the forge release page is published and the milestone 2 and 3 matrices are filled with linked manual evidence.

Validation: PYTHONPATH=src python3 -m unittest discover -s tests -p 'test_*.py'; PYTHONPATH=src python3 -m unittest tests.test_release_prep tests.test_portable_bundle tests.test_aman_cli tests.test_config_ui; python3 -m py_compile src/*.py tests/*.py; PYTHONPATH=src python3 -m aman version
2026-03-12 19:36:52 -03:00

3.4 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. 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)
  4. Prepare the release candidate:
    • make release-prep
  5. Verify artifacts:
    • dist/*.whl
    • dist/aman-x11-linux-<version>.tar.gz
    • dist/aman-x11-linux-<version>.tar.gz.sha256
    • dist/SHA256SUMS
    • dist/*.deb
    • dist/arch/PKGBUILD
  6. Verify checksums:
    • sha256sum -c dist/SHA256SUMS
  7. Tag release:
    • git tag vX.Y.Z
    • git push origin vX.Y.Z
  8. Publish vX.Y.Z on https://git.thaloco.com/thaloco/aman/releases and upload package artifacts from dist/.
    • Use docs/releases/1.0.0.md as the release-notes source for the GA release.
    • Include dist/SHA256SUMS with the uploaded artifacts.
  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 first-run UX signoff (v1.0.0 and later):
  • README.md leads with the supported first-run path and expected visible result.
  • docs/media/settings-window.png, docs/media/tray-menu.png, and docs/media/first-run-demo.webm are current and linked from the README.
  • docs/x11-ga/first-run-review-notes.md contains an independent reviewer pass and the questions it surfaced.
  • aman --help exposes the main command surface directly.
  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.
  • docs/x11-ga/ga-validation-report.md links the release page, matrices, and raw evidence files.