docs: refresh README + integration.md to v0.13.0 + add Phase-2-deprecation caveat (Sprint 5 docs-drift findings) #182

New issue

Closed

opened 2026-06-27 12:11:30 +02:00 by quartermaster · 0 comments

quartermaster commented

2026-06-27 12:11:30 +02:00

Owner

Audit findings

Sprint 5 docs-drift audit (#158) surfaced 5 substantive drifts. The first 4 are mechanical refreshes; the 5th needs a small framing addition for Phase 2 (#172).

Mechanical refreshes (this PR)

README.md line 14: "Latest: v0.7.0 (2026-06-26)" → "Latest: v0.13.0 (2026-06-27)"
README.md lines 85-103: example pins @v0.7.0/toolkit_ref: v0.7.0 → v0.13.0; add publish_mode: 'immediate' input; add brief "See ADR-0007 for token setup (path-α recommended)" note
README.md lines 26-48: add feature entries for auto-prune superseded RC tags on cut (v0.12.0+) and self-pin exclusion + build-bake construction-enforcement (v0.13.0+)
integration.md line 238: consumer example toolkit_ref: v0.10.1-rc.1 → v0.13.0
integration.md line 314: _manifest-check.yml example toolkit_ref: v0.5.0 → v0.13.0

Phase-2 deprecation caveat (this PR — small framing addition)

integration.md lines 507-528 "The toolkit_ref input — important gotcha" section: add a note that this gotcha is fixed by the build-bake mechanism (v0.13.0+) and the section's documented "explicit input pin" pattern is planned for retirement in #172 (Phase 2). Adopters reading this section should know the duplication concern is addressed structurally.

Suggested caveat text:

Note (v0.13.0+): The build-bake mechanism (AGENTS.md section 2 "Build-bake") construction-enforces consistency between the consumer wrapper's uses: @<ref> and the toolkit checkout step's ref. Phase 2 (#172) will retire the toolkit_ref input entirely; the duplication described below is the transitional Phase-1 state. New adopters should follow this pattern for now; future adopters (post-Phase-2) won't need the toolkit_ref: line.

What this PR does NOT do

Does NOT touch ADRs (Sprint 5 audit found them mostly clean — ADR-0006 length is justified by its design-space scope; ADR-0003 amendment is correct; ADR-0004 is orthogonal to build-bake; ADR-0007 fully aligned)
Does NOT refactor README structure — surgical drift fixes only
Does NOT remove the deprecated toolkit_ref content — Phase 2 (#172) handles that
Does NOT fix non-substantive nits (typos, slightly-stale examples that still work)

Implementation surface

Pure docs PR: README.md + docs/integration.md edits. Roughly 30 lines added/changed across 2 files.

No bats needed (docs-only). No re-pin needed (no compose-script touches per AGENTS.md section 2).

Refs

Sprint 5 #158 docs-drift audit findings #1-5
v0.13.0 cut (the current substrate being aligned to)
#172 Phase 2 (the Phase-2-deprecation framing this PR adds caveat for)
AGENTS.md section 2 "Build-bake" (the mechanism being referenced)

## Audit findings Sprint 5 docs-drift audit (#158) surfaced 5 substantive drifts. The first 4 are mechanical refreshes; the 5th needs a small framing addition for Phase 2 (#172). ### Mechanical refreshes (this PR) 1. **README.md line 14**: "Latest: v0.7.0 (2026-06-26)" → "Latest: v0.13.0 (2026-06-27)" 2. **README.md lines 85-103**: example pins `@v0.7.0`/`toolkit_ref: v0.7.0` → v0.13.0; add `publish_mode: 'immediate'` input; add brief "See ADR-0007 for token setup (path-α recommended)" note 3. **README.md lines 26-48**: add feature entries for **auto-prune superseded RC tags on cut (v0.12.0+)** and **self-pin exclusion** + **build-bake construction-enforcement (v0.13.0+)** 4. **integration.md line 238**: consumer example `toolkit_ref: v0.10.1-rc.1` → `v0.13.0` 5. **integration.md line 314**: `_manifest-check.yml` example `toolkit_ref: v0.5.0` → `v0.13.0` ### Phase-2 deprecation caveat (this PR — small framing addition) 6. **integration.md lines 507-528** "The `toolkit_ref` input — important gotcha" section: add a note that this gotcha is fixed by the build-bake mechanism (v0.13.0+) and the section's documented "explicit input pin" pattern is planned for retirement in #172 (Phase 2). Adopters reading this section should know the duplication concern is addressed structurally. Suggested caveat text: > **Note (v0.13.0+)**: The build-bake mechanism (AGENTS.md section 2 "Build-bake") construction-enforces consistency between the consumer wrapper's `uses: @<ref>` and the toolkit checkout step's ref. Phase 2 (#172) will retire the `toolkit_ref` input entirely; the duplication described below is the transitional Phase-1 state. New adopters should follow this pattern for now; future adopters (post-Phase-2) won't need the `toolkit_ref:` line. ## What this PR does NOT do - Does NOT touch ADRs (Sprint 5 audit found them mostly clean — ADR-0006 length is justified by its design-space scope; ADR-0003 amendment is correct; ADR-0004 is orthogonal to build-bake; ADR-0007 fully aligned) - Does NOT refactor README structure — surgical drift fixes only - Does NOT remove the deprecated `toolkit_ref` content — Phase 2 (#172) handles that - Does NOT fix non-substantive nits (typos, slightly-stale examples that still work) ## Implementation surface Pure docs PR: README.md + docs/integration.md edits. Roughly 30 lines added/changed across 2 files. No bats needed (docs-only). No re-pin needed (no compose-script touches per AGENTS.md section 2). ## Refs - Sprint 5 #158 docs-drift audit findings #1-5 - v0.13.0 cut (the current substrate being aligned to) - #172 Phase 2 (the Phase-2-deprecation framing this PR adds caveat for) - AGENTS.md section 2 "Build-bake" (the mechanism being referenced)

quartermaster referenced this issue from a commit

2026-06-27 12:13:19 +02:00

docs: refresh README + integration.md to v0.13.0 (closes #182)

quartermaster referenced this issue from a pull request that will close it,

2026-06-27 12:13:37 +02:00

docs: refresh README + integration.md to v0.13.0 (closes #182) #183

quartermaster referenced this issue from a commit

2026-06-27 12:18:00 +02:00

docs: refresh README + integration.md to v0.13.0 (closes #182)

quartermaster closed this issue

2026-06-27 12:19:16 +02:00