From de6443f3aef4a66169e323e9f9a5f41594fbface Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Thu, 8 Oct 2026 21:21:37 +0000 Subject: [PATCH] Align completed ReleaseKit documentation --- docs/policy/release.md | 3 +- docs/roadmap/releasekit.md | 58 ++++++++++++++++++------------------- docs/roadmap/remediation.md | 8 +++++ 3 files changed, 37 insertions(+), 32 deletions(-) diff --git a/docs/policy/release.md b/docs/policy/release.md index 70c77b5..a64154e 100644 --- a/docs/policy/release.md +++ b/docs/policy/release.md @@ -78,8 +78,7 @@ source tree. Use the complete version tag as the filename and begin with a title containing the product name and that exact version. Include a short summary and any relevant compatibility impact or upgrade -instructions. Use the Promptkit section structure below and keep the note -proportionate to the change. +instructions. Keep the note proportionate to the change. Keep exact current contracts in their canonical documents and update affected documentation with the behavior change. Link to those documents from the note diff --git a/docs/roadmap/releasekit.md b/docs/roadmap/releasekit.md index 8acaecb..5939aa8 100644 --- a/docs/roadmap/releasekit.md +++ b/docs/roadmap/releasekit.md @@ -1,6 +1,9 @@ # ReleaseKit Adoption Roadmap -Status: Tool dependency selected; remaining adoption work is pending. +Status: Implemented and integration-verified (2026-10-08). This completed +roadmap is retained for review until release preparation retires it; current +commands and requirements belong in the [release procedure](../release.md) +and [release policy](../policy/release.md). The completed [implementation plan](https://gitea.maximumdirect.net/eric/promptkit/src/commit/d5f34642d74a220d3ae61eaeb9f0fb4b0b71a173/docs/roadmap/implementation.md) is retained in Git history; the current implementation plan covers another feature. @@ -19,26 +22,28 @@ over preserving incidental local behavior. The [agent policy](../policy/agents.md) govern the migration; policy changes belong in the implementation alongside the new workflow. -## Baseline And Available Upstream Support +## Original Baseline And Adopted Upstream Support -The current PromptKit baseline is commit -`7310ef34a44dae7288db7b281e2a6b7f2c56c4e9`. Its implemented -[release procedure](../release.md) uses `scripts/release.sh` for publication -and `scripts/release-check.sh` for validation. The scripts contain 209 lines -and own publication guards, testing, vet, example assertions, formatting, -Markdown links, module checks, whitespace checks, and a credential regex. -There is no ReleaseKit dependency or hosted delivery workflow. +The original PromptKit baseline was commit +`7310ef34a44dae7288db7b281e2a6b7f2c56c4e9`. At that baseline, publication used +`scripts/release.sh` and validation used `scripts/release-check.sh`. Those +scripts contained 209 lines and owned publication guards, testing, vet, example +assertions, formatting, Markdown links, module checks, whitespace checks, and +a credential regex. There was no ReleaseKit dependency or hosted delivery +workflow. The current [release procedure](../release.md) describes the adopted +workflow rather than these retired mechanics. The earlier [adoption assessment](https://gitea.maximumdirect.net/eric/promptkit/src/commit/7310ef34a44dae7288db7b281e2a6b7f2c56c4e9/docs/roadmap/releasekit.md) is preserved in Git history. This roadmap supersedes its recommendations where the released upstream capabilities change the available choices. -Adopt the published ReleaseKit `v0.2.0` baseline, commit +The adoption selected the published ReleaseKit `v0.2.0` baseline, commit `e030794969fb7787e647a90bbc4eb81bd0610f07`. Its public API and profile provide all four primary requested capabilities and module-distribution checks. -The reviewed release's full offline test suite passed. PromptKit's actual -integration still needs validation during implementation. +The reviewed release's full offline test suite passed. PromptKit's integration +was subsequently validated through the completed implementation plan and the +adoption review recorded in [remediation.md](remediation.md#earlier-releasekit-adoption-review). The upstream owners of the adopted behavior are: @@ -162,7 +167,7 @@ for a separately selected expansion; PromptKit currently has no hosted CI, and delivery would add workflow and credential provisioning beyond the immediate standardization scope. -## Changes Needed From The Current Baseline +## Adoption Scope From The Original Baseline ### Replace Local Release Mechanics @@ -223,24 +228,17 @@ that version or retrofit past release records. ## Verification And Completion -The implementation should demonstrate that PromptKit's profile and entry point -select the released tool and expected checks, that the maintained examples -still verify meaningful consumer behavior, and that the resulting procedure -can validate and publish to a temporary Git remote. +Adoption is complete. The module-selected tool and profile replaced the local +shared validators and publication mechanics, while the three example assertions +remain one PromptKit-specific check. The policy and runbook describe the adopted +workflow; no hosted delivery integration was added. -Verification of tool bootstrap should also establish that the release tool -uses the same Go version selected for PromptKit's candidate validation. - -Use a small representative integration fixture for local wiring and failure -propagation. ReleaseKit owns the shared validators' and publication machinery's -detailed behavioral tests. Avoid duplicating its matrix or recursively running -PromptKit's complete suite from an integration test. - -Adoption is complete when the implemented release path uses ReleaseKit, -the selected shared validators replace local equivalents, the retained -example check is integrated, and policies and runbooks describe the actual -workflow. Source-publication testing requires no provider credentials or -live inference. +The completed plan and adoption review recorded successful offline candidate +validation and a disposable publication fixture covering annotated publication, +validation failure propagation, native usage-error classification, same-Go +tool bootstrap, and unchanged module metadata. No real publication or provider +access was used for that verification. ReleaseKit owns detailed shared-validator +and publication tests; PromptKit's fixture protects its local wiring. The desired reduction is in owned machinery and routine decisions, not a fixed deletion count. diff --git a/docs/roadmap/remediation.md b/docs/roadmap/remediation.md index f21d9d0..37a6d59 100644 --- a/docs/roadmap/remediation.md +++ b/docs/roadmap/remediation.md @@ -1,5 +1,7 @@ # Implementation Review Remediation +Status: All recorded findings have been resolved in separate remediation units. + ## Effective Requirement Inspection Review Review baseline: `a051edd82d9d20cdc82dfebf25adb689dc58b01f`. @@ -144,6 +146,12 @@ architecture; no runtime defect or additional release gate was identified. ### Finding 1 — Complete Documentation Alignment (P3) +**Status: Resolved.** The obsolete heading instruction was removed without +changing note title, summary, compatibility, or licensing-footer requirements. +The adoption roadmap records completion and past integration verification, +links to current canonical owners, and identifies its original baseline as +historical. No release checks or publication gates changed. + Two descriptions were left behind during the cutover: - `docs/policy/release.md`, under Release Documentation, still says to use the