Thales Maciel
acfc376845
Record the independent reviewer pass that closes the first-run UX/docs milestone and archive the raw readiness report under user-readiness. Clarify the README quickstart by naming the default Cmd+m/Super+m hotkey, and align the roadmap plus release checklist with the independent-review closeout wording while keeping milestones 2 and 3 open pending manual validation. Validation: PYTHONPATH=src python3 -m aman --help; PYTHONPATH=src python3 -m unittest tests.test_aman_cli tests.test_config_ui; user-confirmed milestone 4 validation.
51 lines
3.1 KiB
Markdown
51 lines
3.1 KiB
Markdown
# 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`](./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.
|
|
11. GA runtime reliability signoff (`v1.0.0` and later):
|
|
- `make runtime-check` passes.
|
|
- [`docs/runtime-recovery.md`](./runtime-recovery.md) matches the shipped diagnostic IDs and next-step wording.
|
|
- [`docs/x11-ga/runtime-validation-report.md`](./x11-ga/runtime-validation-report.md) contains current automated evidence and release-specific manual validation entries.
|
|
12. 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`](./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.
|
|
13. 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.
|