Align module release documentation with implemented behavior

This commit is contained in:
2026-10-10 14:36:56 +00:00
parent 8112a001d2
commit 6b0b8ce6de
11 changed files with 96 additions and 48 deletions

View File

@@ -2,6 +2,10 @@
Status: complete; all 15 stages implemented and locally verified.
The subsequent [remediation review](remediation.md) records post-implementation
findings, corrections, and their verification. The baseline and stage accounts
below retain the implementation sequence.
## Objective and authority
Implement the complete target in the [module-release roadmap](module-releases.md),

View File

@@ -1,6 +1,7 @@
# Roadmap: release individual Go modules
Status: planned feature; scope and ownership decisions resolved.
Status: implemented; post-implementation findings and corrections are recorded
in the [remediation review](remediation.md). Release version remains unselected.
## Purpose
@@ -10,14 +11,16 @@ ReleaseKit's API and CLI. CommandKit's core and optional integrations provide th
consumer case. Each invocation should require only module selection, product
settings, and a semantic version, with ReleaseKit owning the common mechanics.
This roadmap defines the target state and its scope and ownership decisions.
The [implementation plan](implementation.md) owns the ordered work from the
current baseline. This roadmap does not select a ReleaseKit release version.
This roadmap records the feature's target and resolved scope and ownership
decisions. The [implementation plan](implementation.md) records the completed
stages; [remediation](remediation.md) records review corrections. Current behavior
belongs in the [consumer guides](../consumers/), [CLI](../cli.md),
[configuration](../config.md), and facade GoDoc.
## Current baseline
## Historical starting baseline
The baseline is ReleaseKit v0.3.0 plus accepted ADR 0005; module selection is
not implemented.
Work started from ReleaseKit v0.3.0 plus accepted ADR 0005. At that starting
point, module selection was unimplemented and the following baseline applied.
- `ReleaseRequest` selects a repository, product, and version. `Candidate` and
`PublicationResult` expose the version without a distinct module or tag name.
@@ -33,9 +36,9 @@ not implemented.
consumer Woodpecker template selects `refs/tags/v*` and bootstraps ReleaseKit
from repository-root module files.
The existing candidate capture, declarative validation, exact-object publication,
and outcome reporting provide the foundation. Scope and identity need to be
carried through those paths together.
Candidate capture, declarative validation, exact-object publication, and outcome
reporting provided the foundation for carrying scope and identity through all
operations.
## Targeted end state

View File

@@ -1,7 +1,7 @@
# Remediation: module release implementation review
Status: open findings from review of `90559fe`, compared with planning baseline
`dbfae9e`.
Status: complete; all eleven findings addressed and verified. The review examined
`90559fe`, compared with planning baseline `dbfae9e`.
## Scope and evidence
@@ -20,7 +20,7 @@ bare repository. No ReleaseKit source or real release refs were changed.
Each issue describes required work and verification. Preserve the selected
scope, existing error causes, publication/delivery outcomes, facade boundaries,
and clean API cutover. These corrections add no release, live-service, or human
review gates. Add focused completion markers as issues are resolved.
review gates. Each completion record describes the correction and verification.
## Issue 1: Resolve the actual Git repository root before release identity (P1)
@@ -366,7 +366,18 @@ or new validation policies.
## Issue 11: Reconcile documentation with implemented scope and status (P3)
Status: open. Category: incomplete documentation adoption and misleading contracts.
Status: complete. Category: incomplete documentation adoption and misleading contracts.
**Completion:** Facade GoDoc and canonical API, CLI, configuration, Gitea, and
internal guidance describe selected inputs, full-tag uniqueness, module-local
notes, shared-file scope, committed references, and lazy Go reuse consistently.
The feature roadmap identifies its historical baseline and completed stages,
with this review recording the corrections. Consumer-owned license layouts and
note links are distinguished from optional validation defaults. ReleaseKit's
root release policy and procedure retain their existing requirements. Reviewed
root/nested examples, verified local links/fragments across 37 Markdown documents,
checked example JSON/shell syntax and whitespace, and passed the final complete
offline suite and compiled API/dependency checks.
**Evidence:**