Record the release validation link issue
This commit is contained in:
33
docs/roadmap/remediation.md
Normal file
33
docs/roadmap/remediation.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Review Findings
|
||||
|
||||
Reviewed the Go example-testing migration from `7bbdb55` through `c7d4318`,
|
||||
including its integration with the existing release profile. No implementation
|
||||
regressions, missing migration work, or strengthened consumer contracts were
|
||||
identified. The existing release validation exposed the following preexisting
|
||||
documentation issue.
|
||||
|
||||
## 1. Repair The Historical Profile-Inheritance Link (P2)
|
||||
|
||||
Status: open.
|
||||
|
||||
Location: `docs/releases/v0.7.0.md:129`.
|
||||
|
||||
The link to `../formats.md#profile-inheritance` has no matching heading in the
|
||||
current format reference. That reference now documents inheritance under
|
||||
`Resource Inheritance`. ReleaseKit's configured Markdown validator rejects the
|
||||
candidate at this link, preventing the release check from succeeding even
|
||||
though the race-enabled package suite, including all three examples, passes.
|
||||
|
||||
This issue predates the example-testing sprint: both the stale link and the
|
||||
replacement heading are present in `7bbdb55`. Neither file changed during the
|
||||
migration. It is not caused by removing the Python example hook.
|
||||
|
||||
Remediation: point the historical note's link to
|
||||
`../formats.md#resource-inheritance`, preserving the historical release summary.
|
||||
Verify the repaired link with the existing Markdown validator and complete the
|
||||
normal candidate checks when preparing the release. No new gate is needed.
|
||||
|
||||
Evidence: a disposable clone of `c7d4318`, with only a synthetic release note
|
||||
added, failed `./scripts/releasekit.sh check v0.999.0` with
|
||||
`docs/releases/v0.7.0.md:129:9: heading anchor does not exist`.
|
||||
Python commands were replaced by failing shims for that check; none was invoked.
|
||||
Reference in New Issue
Block a user