Clarify optional release diagnostics

This commit is contained in:
2026-10-08 17:14:15 +00:00
parent cd58b2bcfc
commit 54cfbd8eb8
2 changed files with 21 additions and 8 deletions

View File

@@ -73,9 +73,11 @@ The launcher builds the ReleaseKit version selected by the module in readonly
mode. After preflight, `publish` runs the offline default Go suite once, checks
the candidate and remote guards, creates an annotated tag from the committed
note, and pushes only that tag object. The launcher does not push `main`; push
the candidate first. Do not require a separate `check` before `publish` or repeat
the same suite. Successful source publication does not wait for CI, module
availability, or consumer installation.
the candidate first. `check` is available for optional diagnosis and is not a
required step before `publish`. The automated publication workflow runs the
final-candidate suite once; configured additional checks should avoid duplicating
that suite. Maintainers may rerun diagnostics when useful. Successful source
publication does not wait for CI, module availability, or consumer installation.
## Completion and statuses

View File

@@ -1,6 +1,6 @@
# ReleaseKit adoption review findings
Status: R-01 complete; R-02 pending.
Status: R-01 and R-02 complete.
Date: 2026-10-08.
@@ -90,7 +90,7 @@ The production launcher, profile, and module selection were not changed.
**Priority:** low. **Category:** potentially strengthened prohibition.
**Location:** [docs/release.md](../release.md), lines 76–77.
**Location:** [docs/release.md](../release.md), lines 76–77 at the reviewed revision.
The instruction “Do not require a separate `check` before `publish` or repeat
the same suite” combines the intended rule against mandatory duplicate
@@ -106,18 +106,29 @@ description, not its executable behavior.
Required work:
- [ ] Say explicitly that `check` is optional for diagnosis and is not a
- [x] Say explicitly that `check` is optional for diagnosis and is not a
required step before `publish`.
- [ ] Scope the duplicate-validation instruction to the automated publication
- [x] Scope the duplicate-validation instruction to the automated publication
workflow and configured additional checks. Preserve operator discretion to
investigate or rerun a check.
- [ ] Retain the single publication command and its own final-candidate suite;
- [x] Retain the single publication command and its own final-candidate suite;
do not add a required preliminary check or an extra confirmation.
Completion evidence: document review confirms the runbook distinguishes an
optional diagnostic action from a release requirement and agrees with the
existing policy. No implementation change is needed for this item.
**Completed 2026-10-08:** the runbook explicitly makes `check` an optional
diagnostic action and preserves maintainer discretion to rerun diagnostics.
Duplicate-validation guidance now concerns the automated publication workflow
and configured additional checks. The single publisher and its own
final-candidate suite remain the release procedure.
Validation: reviewed the changed wording against the release policy and
implemented launcher; local documentation links and fragments and Markdown
whitespace checks passed. This documentation-only unit did not change code or
rerun the suite already passed for R-01.
## Review evidence and limits
- Read the adoption diffs, launcher/profile, new test functions and fixtures,