Files
kaizen-agentic/workplans/kaizen-agentic-WP-0005-adoption-parity.md
tegwick 1d0999eabb
Some checks failed
ci / test (push) Failing after 36s
docs: close WP-0005 workplan and bind State Hub tasks
Add frontmatter tasks list with state_hub_task_id links, completion
section for v1.2.0 ship, and custodian brief from hub sync.
2026-06-17 01:02:08 +02:00

271 lines
9.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
id: KAIZEN-WP-0005
type: workplan
title: "Adoption Polish and Fleet Parity (v1.2.0)"
domain: custodian
repo: kaizen-agentic
status: completed
owner: kaizen-agentic
topic_slug: custodian
state_hub_workstream_id: 88c7b3e6-be98-480c-b47b-936e74a1a31b
created: "2026-06-16"
updated: "2026-06-17"
tasks:
- id: T01
title: Configure PACKAGE_USER and PACKAGE_TOKEN in Gitea
status: done
state_hub_task_id: 1fb6b04e-0854-4cc9-83c7-5abf85fe5bff
- id: T02
title: Smoke-test publish-python-package workflow
status: done
state_hub_task_id: bdb9e463-bdfb-405c-afc4-e93a7d58a18b
- id: T03
title: Add pre-tag release checklist to PACKAGE_RELEASE.md
status: done
state_hub_task_id: 6a2132e7-8b3f-4960-a5e8-85bad81e8b13
- id: T04
title: Update HELLO_WORLD_TUTORIAL.md Gitea install paths
status: done
state_hub_task_id: 553cba3a-dafa-483a-9200-70ac3f5eb2d7
- id: T05
title: Update CLI_CHEAT_SHEET.md Gitea install paths
status: done
state_hub_task_id: 7e6663a5-fedf-4b1c-acd9-6df6b43d8a12
- id: T06
title: Update AGENT_DISTRIBUTION.md Gitea install paths
status: done
state_hub_task_id: fe553788-357f-45c4-8400-f764f68c1cde
- id: T07
title: Update Makefile agents-* install fallback messages
status: done
state_hub_task_id: b131ff67-fe21-4d95-904b-6a0b916c5502
- id: T08
title: Cross-link CONTRIBUTING.md with PACKAGE_RELEASE.md
status: done
state_hub_task_id: 07dd4d25-250c-455c-8363-49269d2ee59f
- id: T09
title: Add make agents-sync-package target
status: done
state_hub_task_id: 7437cedd-5f7e-4c4d-9142-4f67470c9e52
- id: T10
title: Add release-check parity test agents vs data/agents
status: done
state_hub_task_id: ddbe2114-7a47-48fd-a145-b22dca2b581a
- id: T11
title: Refresh SCOPE.md agent-count notes
status: done
state_hub_task_id: 5417524f-03c0-40ed-a48b-a7906e6daf8f
- id: T12
title: Refresh TODO.md for v1.2.0
status: done
state_hub_task_id: 5cfad56c-2664-4b2d-b5f9-4792c958c9a2
- id: T13
title: Open CHANGELOG Unreleased for v1.2.0
status: done
state_hub_task_id: fbca9be4-3d2b-4989-baaf-97e6926bdc66
- id: T14
title: Add flake8 to Gitea CI workflow
status: done
state_hub_task_id: a6966cfa-ca59-4087-8989-2870dc69b13f
- id: T15
title: Document activity-core ActivityDefinition registration handoff
status: done
state_hub_task_id: fbf3f1a8-4818-473e-ae0d-cd80118e5319
- id: T16
title: Verify bidirectional Helix correlation doc link
status: done
state_hub_task_id: 37679ce7-dcb6-42a4-820d-cf8b32c2a248
---
# KAIZEN-WP-0005 — Adoption Polish and Fleet Parity
**Status:** completed
**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` (`tegwick`) and `PACKAGE_TOKEN` (OpenBao `inter-hub-pkg-rep` token) in Gitea
- [x] T02 — Smoke-test `.gitea/workflows/publish-python-package.yml` via `workflow_dispatch` (auth OK; 409 on re-upload of 1.1.0)
- [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 (T01T03) ──→ can run in parallel with Part 2
Part 2 (T04T08) ──→ Part 4 (T12T13) doc hygiene
Part 3 (T09T11) ──→ gates v1.2.0 tag
Part 4 (T14) ──→ before v1.2.0 merge freeze
Part 5 (T15T16) ──→ non-blocking; parallel with Parts 24
```
Estimated effort: 24 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.
---
## Completion
**Shipped:** v1.2.0 on 2026-06-16
| Milestone | Detail |
|-----------|--------|
| Release commit | `297afed` — adoption polish and publish pipeline |
| Tag | `v1.2.0` pushed to Gitea |
| Publish | Gitea Actions run **3044**`kaizen_agentic-1.2.0` wheel + sdist uploaded |
| Publish auth | `PACKAGE_USER=tegwick`, token from OpenBao `inter-hub-pkg-rep` |
| Helix handoff | Reciprocal link in `agentic-resources/docs/DESIGN-session-memory.md` §11 |
All 16 tasks complete. Deferred items (agent wizard, template validation, doc generation)
tracked for **WP-0006** (v1.3.0).
---
## 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