eric/promptkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Align completed ReleaseKit documentation

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-08 21:21:37 +00:00
parent 5a63b649f9
commit de6443f3ae
3 changed files with 37 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/policy/release.md
View File

@@ -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. title containing the product name and that exact version.
Include a short summary and any relevant compatibility impact or upgrade Include a short summary and any relevant compatibility impact or upgrade
instructions. Use the Promptkit section structure below and keep the note instructions. Keep the note proportionate to the change.
proportionate to the change.
Keep exact current contracts in their canonical documents and update affected Keep exact current contracts in their canonical documents and update affected
documentation with the behavior change. Link to those documents from the note documentation with the behavior change. Link to those documents from the note

58
docs/roadmap/releasekit.md
View File

@@ -1,6 +1,9 @@
# ReleaseKit Adoption Roadmap # 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) 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. 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 [agent policy](../policy/agents.md) govern the migration; policy changes belong
in the implementation alongside the new workflow. in the implementation alongside the new workflow.
## Baseline And Available Upstream Support ## Original Baseline And Adopted Upstream Support
The current PromptKit baseline is commit The original PromptKit baseline was commit
`7310ef34a44dae7288db7b281e2a6b7f2c56c4e9`. Its implemented `7310ef34a44dae7288db7b281e2a6b7f2c56c4e9`. At that baseline, publication used
[release procedure](../release.md) uses `scripts/release.sh` for publication `scripts/release.sh` and validation used `scripts/release-check.sh`. Those
and `scripts/release-check.sh` for validation. The scripts contain 209 lines scripts contained 209 lines and owned publication guards, testing, vet, example
and own publication guards, testing, vet, example assertions, formatting, assertions, formatting, Markdown links, module checks, whitespace checks, and
Markdown links, module checks, whitespace checks, and a credential regex. a credential regex. There was no ReleaseKit dependency or hosted delivery
There is no ReleaseKit dependency or hosted delivery workflow. workflow. The current [release procedure](../release.md) describes the adopted
workflow rather than these retired mechanics.
The earlier The earlier
[adoption assessment](https://gitea.maximumdirect.net/eric/promptkit/src/commit/7310ef34a44dae7288db7b281e2a6b7f2c56c4e9/docs/roadmap/releasekit.md) [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 is preserved in Git history. This roadmap supersedes its recommendations
where the released upstream capabilities change the available choices. 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 `e030794969fb7787e647a90bbc4eb81bd0610f07`. Its public API and profile provide
all four primary requested capabilities and module-distribution checks. all four primary requested capabilities and module-distribution checks.
The reviewed release's full offline test suite passed. PromptKit's actual The reviewed release's full offline test suite passed. PromptKit's integration
integration still needs validation during implementation. 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: 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 and delivery would add workflow and credential provisioning beyond the
immediate standardization scope. immediate standardization scope.
## Changes Needed From The Current Baseline ## Adoption Scope From The Original Baseline
### Replace Local Release Mechanics ### Replace Local Release Mechanics
@@ -223,24 +228,17 @@ that version or retrofit past release records.
## Verification And Completion ## Verification And Completion
The implementation should demonstrate that PromptKit's profile and entry point Adoption is complete. The module-selected tool and profile replaced the local
select the released tool and expected checks, that the maintained examples shared validators and publication mechanics, while the three example assertions
still verify meaningful consumer behavior, and that the resulting procedure remain one PromptKit-specific check. The policy and runbook describe the adopted
can validate and publish to a temporary Git remote. workflow; no hosted delivery integration was added.
Verification of tool bootstrap should also establish that the release tool The completed plan and adoption review recorded successful offline candidate
uses the same Go version selected for PromptKit's candidate validation. validation and a disposable publication fixture covering annotated publication,
validation failure propagation, native usage-error classification, same-Go
Use a small representative integration fixture for local wiring and failure tool bootstrap, and unchanged module metadata. No real publication or provider
propagation. ReleaseKit owns the shared validators' and publication machinery's access was used for that verification. ReleaseKit owns detailed shared-validator
detailed behavioral tests. Avoid duplicating its matrix or recursively running and publication tests; PromptKit's fixture protects its local wiring.
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 desired reduction is in owned machinery and routine decisions, not a The desired reduction is in owned machinery and routine decisions, not a
fixed deletion count. fixed deletion count.

8
docs/roadmap/remediation.md
View File

@@ -1,5 +1,7 @@
# Implementation Review Remediation # Implementation Review Remediation
Status: All recorded findings have been resolved in separate remediation units.
## Effective Requirement Inspection Review ## Effective Requirement Inspection Review
Review baseline: `a051edd82d9d20cdc82dfebf25adb689dc58b01f`. Review baseline: `a051edd82d9d20cdc82dfebf25adb689dc58b01f`.
@@ -144,6 +146,12 @@ architecture; no runtime defect or additional release gate was identified.
### Finding 1 — Complete Documentation Alignment (P3) ### 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: Two descriptions were left behind during the cutover:
- `docs/policy/release.md`, under Release Documentation, still says to use the - `docs/policy/release.md`, under Release Documentation, still says to use the