From 960a7c963e3bf488aff8745afe5f3556ca54d580 Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Sun, 11 Oct 2026 13:08:31 +0000 Subject: [PATCH] Describe release file inputs and checks accurately --- docs/release.md | 31 ++++++++++++++++++++++--------- docs/roadmap/remediation.md | 10 +++++++++- 2 files changed, 31 insertions(+), 10 deletions(-) diff --git a/docs/release.md b/docs/release.md index 63fc1c9..fe5ac56 100644 --- a/docs/release.md +++ b/docs/release.md @@ -54,11 +54,11 @@ GOWORK=off GOTOOLCHAIN=local go version Select exactly one module with the launcher: -| Selector | Physical module directory | Release note | Full tag | Shared project files | -| --- | --- | --- | --- | --- | -| `core` | repository root | `docs/releases/.md` | `` | root `COPYRIGHT`, `LICENSE`, `docs/oss/attribution.md` | -| `ckconfig` | `integrations/ckconfig` | `integrations/ckconfig/docs/releases/.md` | `integrations/ckconfig/` | that module's `COPYRIGHT`, `LICENSE`, `docs/oss/attribution.md` | -| `ckprompt` | `integrations/ckprompt` | `integrations/ckprompt/docs/releases/.md` | `integrations/ckprompt/` | that module's `COPYRIGHT`, `LICENSE`, `docs/oss/attribution.md` | +| Selector | Physical module directory | Release note | Full tag | +| --- | --- | --- | --- | +| `core` | repository root | `docs/releases/.md` | `` | +| `ckconfig` | `integrations/ckconfig` | `integrations/ckconfig/docs/releases/.md` | `integrations/ckconfig/` | +| `ckprompt` | `integrations/ckprompt` | `integrations/ckprompt/docs/releases/.md` | `integrations/ckprompt/` | Use a fresh stable semantic version (`vMAJOR.MINOR.PATCH`) for the selected module. Before `v1.0.0`, a minor release may change a documented contract when @@ -69,10 +69,23 @@ links to that module's local grant, license, and attribution paths. The full tag in each URL includes the integration directory where applicable. Future tag URLs need not resolve before publication. -Root publication validates root shared files. Integration publication validates -the matching module-local files; it does not substitute root-only notices. The -module release profiles select their physical module directory while using the -same repository and publication endpoint. +All three release profiles explicitly select the repository-root `COPYRIGHT`, +`LICENSE`, and `docs/oss/attribution.md` through `validation.shared_files`. +ReleaseKit requires these committed files to exist in the candidate even when +no optional file checks are enabled. The list does not enable content checks +or expand Go validation scope; see the pinned [profile reference](https://gitea.maximumdirect.net/eric/ReleaseKit/src/commit/b96262eb0ce9c8f2eb3e948a5841db2b799bc91b/docs/config.md). + +Each integration also distributes its own `COPYRIGHT`, `LICENSE`, and +`docs/oss/attribution.md`. These module-local materials are separate from the +explicit root shared-file list and remain subject to the [OSS policy](policy/oss.md). +Automatic module file inputs include applicable module-local files and stop at +independent nested-module boundaries. Their inclusion does not itself enable +license or content validation. + +The current profiles enable no optional file checks or additional product +checks. Publication runs the selected module's standard offline suite and +ReleaseKit's candidate/note and publication guards. The profiles select their +physical module directory while using the same repository and endpoint. ## Prepare and publish one candidate diff --git a/docs/roadmap/remediation.md b/docs/roadmap/remediation.md index 20cb4b6..ff4e268 100644 --- a/docs/roadmap/remediation.md +++ b/docs/roadmap/remediation.md @@ -216,7 +216,15 @@ review, not real tag creation or publication. ## R5: Describe actual release file inputs and enabled checks -**Status:** Open. **Priority:** P2. +**Status:** Completed (2026-10-11). **Priority:** P2. + +**Completed work:** the runbook names the common explicit repository-root +shared-file list, separates module-local distribution notices, and distinguishes +existence requirements from optional content checks. It describes the enabled +suite/candidate/publication checks without promising automated licensing checks. +Compared all three unchanged profiles with ReleaseKit v0.4.0's public field +semantics and confirmed the listed files and local links/fragments exist. +Whitespace checks pass. No additional release gates were enabled. **Evidence:** [release.md](../release.md#modules-versions-notes-and-shared-files) lists module-local files as the integrations' shared project files and says