base-layer/commandkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Align release note policy with independent modules

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-11 13:07:45 +00:00
parent 7ce2fc0bf2
commit 4ba5a56e21
2 changed files with 25 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/policy/release.md
View File

@@ -2,7 +2,7 @@
**Base Policy Version:** 1.6 **Base Policy Version:** 1.6
**Last Updated**: 2026-10-08 **Last Updated**: 2026-10-11
**Upstream Source:** [release.md](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348/docs/policy/release.md) **Upstream Source:** [release.md](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348/docs/policy/release.md)
@@ -16,8 +16,9 @@ Adopt stronger verification or reproducibility requirements through an explicit
project-specific decision justified by the intended audience and support needs. project-specific decision justified by the intended audience and support needs.
The repository-specific commands belong in `docs/release.md`. Historical release The repository-specific commands belong in `docs/release.md`. Historical release
summaries belong in `docs/releases/`. The procedure must agree with the adopted summaries belong in each released module's `docs/releases/` directory. The
policy and link to it rather than introduce additional release requirements. procedure must agree with the adopted policy and link to it rather than introduce
additional release requirements.
## CommandKit Release Scope ## CommandKit Release Scope
@@ -125,9 +126,18 @@ rules above.
## Release Documentation And Preparation ## Release Documentation And Preparation
Every new release must include `docs/releases/<version>.md` in the tagged Every new module release must include `docs/releases/<version>.md` relative to
source tree. Use the complete version tag as the filename and begin with a the selected module directory in the tagged source tree. Here `<version>` is
title containing the product name and that exact version. that module's stable semantic version, `vMAJOR.MINOR.PATCH`; use it as the
filename and begin with a title containing the selected release profile's
product name and that exact semantic version.
The semantic version and full Git tag are distinct. The root module's tag is
its semantic version; an integration's full tag includes its module prefix,
as recorded in the [release procedure](../release.md#modules-versions-notes-and-shared-files).
Use the full tag for Git refs and immutable source URLs, with repository-relative
paths identifying the selected module's note, grant, license, and attribution.
The module prefix is not part of the note filename or title's version.
Include a short summary and any relevant compatibility impact or upgrade Include a short summary and any relevant compatibility impact or upgrade
instructions. Choose sections suited to the release and keep the note instructions. Choose sections suited to the release and keep the note

10
docs/roadmap/remediation.md
View File

@@ -180,7 +180,15 @@ names. This is documentation work, not a request for additional runtime rules.
## R4: Complete the module-specific release-note policy adaptation ## R4: Complete the module-specific release-note policy adaptation
**Status:** Open. **Priority:** P2. **Status:** Completed (2026-10-11). **Priority:** P2.
**Completed work:** release policy now places notes relative to the selected
module and distinguishes semantic-version filenames/titles from full Git tags
and immutable source URLs. Checked all three prepared notes against their profile
products, versions, full-tag footers, and existing module-local destinations;
they agree with the runbook and ReleaseKit v0.4.0's public module-release ADR.
The added local link/fragment and whitespace checks pass. Independent versioning,
immutability, and source-push completion rules remain intact; no tags were created.
**Evidence:** [release policy](../policy/release.md#release-documentation-and-preparation) **Evidence:** [release policy](../policy/release.md#release-documentation-and-preparation)
still requires `docs/releases/<version>.md` in the tagged source tree and says still requires `docs/releases/<version>.md` in the tagged source tree and says