tegwick
5ce3d0766e
Update correlation contract status and close T16 in the adoption-parity workplan after agentic-resources DESIGN-session-memory.md §11 landed.
189 lines
6.2 KiB
Markdown
189 lines
6.2 KiB
Markdown
---
|
||
id: KAIZEN-WP-0005
|
||
type: workplan
|
||
title: "Adoption Polish and Fleet Parity (v1.2.0)"
|
||
domain: custodian
|
||
repo: kaizen-agentic
|
||
status: active
|
||
owner: kaizen-agentic
|
||
topic_slug: custodian
|
||
state_hub_workstream_id: 88c7b3e6-be98-480c-b47b-936e74a1a31b
|
||
created: "2026-06-16"
|
||
updated: "2026-06-16"
|
||
---
|
||
|
||
# KAIZEN-WP-0005 — Adoption Polish and Fleet Parity
|
||
|
||
**Status:** active
|
||
**Owner:** kaizen-agentic
|
||
**Repo:** kaizen-agentic
|
||
**Target version:** 1.2.0
|
||
**Depends on:** WP-0001 (v1.1.0 ship), WP-0004 (ecosystem integration docs)
|
||
|
||
## Goal
|
||
|
||
Close adoption gaps after the v1.1.0 release: verify the Gitea publish pipeline,
|
||
align all install documentation with the Coulomb registry, enforce packaged-agent
|
||
parity with `agents/`, and harden CI so v1.2.0 ships with confidence.
|
||
|
||
WP-0001 through WP-0004 delivered features; WP-0005 makes them **discoverable,
|
||
installable, and maintainable** for ecosystem consumers.
|
||
|
||
---
|
||
|
||
## Part 1 — Publish Pipeline Verification
|
||
|
||
Confirm tag-triggered publication works end-to-end before the v1.2.0 cut.
|
||
|
||
### Tasks
|
||
|
||
- [x] T01 — Configure `PACKAGE_USER` and `PACKAGE_TOKEN` secrets in Gitea (Gitea rejects `GITEA_*` secret names)
|
||
- [ ] T02 — Smoke-test `.gitea/workflows/publish-python-package.yml` via `workflow_dispatch`
|
||
- [x] T03 — Add pre-tag release checklist to `docs/PACKAGE_RELEASE.md` (secrets, `make package-check`, tag format)
|
||
|
||
### Definition of done
|
||
|
||
- Publish workflow succeeds without manual `twine upload`
|
||
- `docs/PACKAGE_RELEASE.md` documents the full operator path
|
||
|
||
---
|
||
|
||
## Part 2 — Install Documentation Sync
|
||
|
||
Several docs still show bare `pip install kaizen-agentic` (pre-Gitea registry).
|
||
|
||
### Tasks
|
||
|
||
- [x] T04 — Update `docs/HELLO_WORLD_TUTORIAL.md` install sections (Gitea extra index + pipx)
|
||
- [x] T05 — Update `docs/CLI_CHEAT_SHEET.md` install sections
|
||
- [x] T06 — Update `docs/AGENT_DISTRIBUTION.md` install and distribution sections
|
||
- [x] T07 — Update Makefile `agents-*` fallback messages to point at dev install or `PACKAGE_RELEASE.md`
|
||
- [x] T08 — Cross-link `CONTRIBUTING.md` post-pull reinstall with `docs/PACKAGE_RELEASE.md`
|
||
|
||
### Definition of done
|
||
|
||
- No consumer-facing doc implies public pypi.org is the primary install path
|
||
- All install examples use env-var credentials (no committed tokens)
|
||
|
||
---
|
||
|
||
## Part 3 — Packaged Fleet Parity
|
||
|
||
Ensure `pip install` ships the same agent fleet as `agents/`.
|
||
|
||
### Tasks
|
||
|
||
- [x] T09 — Add `make agents-sync-package` (copy `agents/agent-*.md` → `data/agents/`) with dry-run mode
|
||
- [x] T10 — Add pytest or `release-check` step verifying `agents/` and `data/agents/` file sets match
|
||
- [x] T11 — Refresh `SCOPE.md` notes and agent-count references (currently stale at 16 vs 20)
|
||
|
||
### Definition of done
|
||
|
||
- `make release-check` fails when packaged agents drift from source
|
||
- Wheel contents match canonical `agents/` directory
|
||
|
||
---
|
||
|
||
## Part 4 — Release Hygiene and CI
|
||
|
||
Prepare v1.2.0 versioning and strengthen automated gates.
|
||
|
||
### Tasks
|
||
|
||
- [x] T12 — Refresh `TODO.md`: archive 1.1.0 items, point `[Unreleased]` at this workplan
|
||
- [x] T13 — Open `CHANGELOG.md` `[Unreleased]` section for v1.2.0 tracking
|
||
- [x] T14 — Extend `.gitea/workflows/ci.yml` with flake8 (`release-check` lint subset on `src/`)
|
||
|
||
### Definition of done
|
||
|
||
- `TODO.md` reflects current vibe-coding state only
|
||
- CI catches lint regressions before merge
|
||
|
||
---
|
||
|
||
## Part 5 — Ecosystem Handoff (coordination)
|
||
|
||
Cross-repo follow-through from WP-0004; no foreign code in this repo.
|
||
|
||
### Tasks
|
||
|
||
- [x] T15 — Document activity-core ActivityDefinition registration steps in `docs/INTEGRATION_PATTERNS.md` (handoff checklist for activity-core owners)
|
||
- [x] T16 — Verify bidirectional Helix correlation doc link with agentic-resources (reciprocal link added in `DESIGN-session-memory.md` §11)
|
||
|
||
### Definition of done
|
||
|
||
- Operators know how to activate the three ActivityDefinitions committed under `docs/integrations/activity-definitions/`
|
||
- Helix correlation is linked from both repos
|
||
|
||
---
|
||
|
||
## Sequencing
|
||
|
||
```
|
||
Part 1 (T01–T03) ──→ can run in parallel with Part 2
|
||
│
|
||
Part 2 (T04–T08) ──→ Part 4 (T12–T13) doc hygiene
|
||
│
|
||
Part 3 (T09–T11) ──→ gates v1.2.0 tag
|
||
│
|
||
Part 4 (T14) ──→ before v1.2.0 merge freeze
|
||
│
|
||
Part 5 (T15–T16) ──→ non-blocking; parallel with Parts 2–4
|
||
```
|
||
|
||
Estimated effort: 2–4 sessions.
|
||
|
||
---
|
||
|
||
## Out of Scope
|
||
|
||
- Public pypi.org publication (optional; Gitea registry remains primary)
|
||
- Interactive agent selection wizard (defer to WP-0006)
|
||
- Full `KaizenAgentTemplate.md` schema enforcement in `validate` (defer to WP-0006)
|
||
- Automated documentation generation from agent metadata
|
||
- Owning activity-core, agentic-resources, or artifact-store code
|
||
|
||
---
|
||
|
||
## Success Criteria
|
||
|
||
1. Tag `v1.2.0` triggers Gitea PyPI publish without manual intervention.
|
||
2. A new consumer can install from docs alone (no tribal knowledge about extra index).
|
||
3. Packaged wheel agent fleet cannot drift silently from `agents/`.
|
||
4. WP-0004 ecosystem artifacts have clear operator handoff paths.
|
||
|
||
---
|
||
|
||
## State Hub Task IDs
|
||
|
||
| Code | UUID |
|
||
|------|------|
|
||
| T01 | 1fb6b04e-0854-4cc9-83c7-5abf85fe5bff |
|
||
| T02 | bdb9e463-bdfb-405c-afc4-e93a7d58a18b |
|
||
| T03 | 6a2132e7-8b3f-4960-a5e8-85bad81e8b13 |
|
||
| T04 | 553cba3a-dafa-483a-9200-70ac3f5eb2d7 |
|
||
| T05 | 7e6663a5-fedf-4b1c-acd9-6df6b43d8a12 |
|
||
| T06 | fe553788-357f-45c4-8400-f764f68c1cde |
|
||
| T07 | b131ff67-fe21-4d95-904b-6a0b916c5502 |
|
||
| T08 | 07dd4d25-250c-455c-8363-49269d2ee59f |
|
||
| T09 | 7437cedd-5f7e-4c4d-9142-4f67470c9e52 |
|
||
| T10 | ddbe2114-7a47-48fd-a145-b22dca2b581a |
|
||
| T11 | 5417524f-03c0-40ed-a48b-a7906e6daf8f |
|
||
| T12 | 5cfad56c-2664-4b2d-b5f9-4792c958c9a2 |
|
||
| T13 | fbca9be4-3d2b-4989-baaf-97e6926bdc66 |
|
||
| T14 | a6966cfa-ca59-4087-8989-2870dc69b13f |
|
||
| T15 | fbf3f1a8-4818-473e-ae0d-cd80118e5319 |
|
||
| T16 | 37679ce7-dcb6-42a4-820d-cf8b32c2a248 |
|
||
|
||
**Hub workstream:** `kaizen-wp-0005-adoption-parity` (`88c7b3e6-be98-480c-b47b-936e74a1a31b`)
|
||
|
||
---
|
||
|
||
## Notes
|
||
|
||
- Deferred from TODO.md [1.1.0]: agent selection wizard, template schema validation,
|
||
doc generation automation → candidate **WP-0006** (v1.3.0)
|
||
- `make agents-update` updates project-installed agents via CLI; it does **not**
|
||
sync `agents/` → `data/agents/` — T09 addresses that gap explicitly
|
||
- Part 1 T01 requires Gitea UI access (human step); automation cannot set secrets
|