generated from coulomb/repo-seed
docs + chore(workplan): complete T05 for CYA-WP-0004 — lightweight release process (checklist + Makefile targets)
This commit is contained in:
@@ -144,23 +144,24 @@ completed: "2026-05-27"
|
||||
|
||||
```task
|
||||
id: CYA-WP-0004-T05
|
||||
status: todo
|
||||
status: done
|
||||
priority: medium
|
||||
state_hub_task_id: "c97acc58-14d7-47b9-9ab3-936ab1eb92df"
|
||||
started: "2026-05-27 ralph iter 5"
|
||||
completed: "2026-05-27"
|
||||
```
|
||||
|
||||
- Document (and optionally script) the steps to cut a release:
|
||||
1. Decide on new version
|
||||
2. Update version metadata
|
||||
3. Run tests
|
||||
4. Build packages
|
||||
5. Create git tag
|
||||
- Consider a small helper script or Makefile targets (`make release-prep`, `make build-dist`).
|
||||
- Ensure the process is reproducible and documented in a `docs/release-process.md` or similar.
|
||||
**Done.**
|
||||
|
||||
**Acceptance criteria**:
|
||||
- A clear, written release checklist or script exists that a maintainer can follow with low risk of mistakes.
|
||||
- The process produces artifacts that could be uploaded to a package index.
|
||||
- Created `docs/release-process.md` — a clear, step-by-step, low-risk release checklist covering version decision → tests → build → tagging.
|
||||
- Enhanced the `Makefile` with two very useful release targets:
|
||||
- `make release-prep` (runs clean + test + dist in one go)
|
||||
- `make check-dist` (smoke-tests the built wheel in a fresh venv)
|
||||
- The process is fully reproducible and documented.
|
||||
|
||||
**Acceptance criteria met**:
|
||||
- A maintainer now has a written checklist + Makefile helpers that make cutting a release feel safe and boring.
|
||||
- The process produces ready-to-upload artifacts.
|
||||
|
||||
### T06 — Update documentation for both installation methods
|
||||
|
||||
|
||||
Reference in New Issue
Block a user