44 lines
2.4 KiB
Markdown
44 lines
2.4 KiB
Markdown
# ReleaseKit Adoption Review Remediation
|
|
|
|
Review baseline: `d5f3464`. The release implementation matches the selected
|
|
architecture; no runtime defect or additional release gate was identified.
|
|
|
|
## Finding 1 — Complete Documentation Alignment (P3)
|
|
|
|
Two descriptions were left behind during the cutover:
|
|
|
|
- `docs/policy/release.md`, under Release Documentation, still says to use the
|
|
“Promptkit section structure below.” The former fixed-heading structure was
|
|
removed, and the adopted policy and runbook expressly require no fixed
|
|
section headings. This reference leaves the note-writing instruction unclear.
|
|
- `docs/roadmap/releasekit.md` still describes remaining adoption work as
|
|
pending and integration validation as future work. The implementation plan
|
|
records completion, and the review verified the assembled workflow.
|
|
|
|
Remove the obsolete section-structure instruction while preserving the title,
|
|
summary, applicable compatibility guidance, and licensing-footer requirements.
|
|
Update the feature roadmap's implementation status, or retire it together with
|
|
the completed implementation plan during release preparation and repair links.
|
|
Do not reintroduce a heading validator or add a publication gate.
|
|
|
|
Verification: review the affected descriptions for agreement with the actual
|
|
profile and runbook, and check changed local links. The disposable fixture
|
|
already demonstrates acceptance of a note without fixed section headings;
|
|
these prose corrections do not require repeating the complete Go suite.
|
|
|
|
## Review Evidence
|
|
|
|
- `python3 scripts/test-release.py` passed: successful annotated publication,
|
|
one race-enabled suite and additional check, same-Go tool build, unchanged
|
|
module metadata, failed additional validation preventing publication, and
|
|
native usage-error classification.
|
|
- A disposable clone of the review baseline, with only a synthetic release
|
|
note added, passed `scripts/releasekit.sh check v0.0.0` offline with the real
|
|
profile: race-enabled tests, full vet, Go formatting, Markdown navigation,
|
|
module-distribution checks, and the three real consumer examples.
|
|
- Shell syntax checks passed; the runtime root package's dependency list has
|
|
no ReleaseKit import. No runtime Go code or module metadata changed during
|
|
the implementation commits after `1889915`.
|
|
- No real Promptkit publication was performed. The adopted checks and retired
|
|
gates match the agreed scope; no substantive contract strengthening was found.
|