Document the source release workflow

This commit is contained in:
2026-10-08 16:49:01 +00:00
parent d3f0891225
commit 8c5fea0aae
12 changed files with 197 additions and 34 deletions

View File

@@ -9,8 +9,8 @@ Original review: 2026-10-06. Reconciled: 2026-10-07.
This document preserves the initial command-suite review and identifies remaining
future work. Its completed implementation tasks and obsolete contract drafts
have been retired. The [initial feature target](initial.md) and
[completed implementation plan](implementation.md) record delivery scope and
execution history.
[completed initial implementation record](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/3871d837489b9955998b362587a52b47282dc021/docs/roadmap/implementation.md)
record delivery scope and execution history.
The [CLI reference](../cli.md) owns implemented commands, syntax, formats, and
outcomes. Go declarations and GoDoc own exact exported APIs; the

View File

@@ -10,7 +10,8 @@ Original planning: 2026-10-06. Reconciled: 2026-10-07.
registry, and typed-input decisions and rationale. The
[architecture policy](../policy/architecture.md) owns responsibility boundaries.
This document records completion of the initial dispatcher design; the
[implementation plan](implementation.md) preserves its execution history.
[completed initial implementation record](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/3871d837489b9955998b362587a52b47282dc021/docs/roadmap/implementation.md)
preserves its execution history.
The registry, typed inputs, command/group APIs, invocation coordination, and
outcomes are implemented. Their exact contracts are owned by Go declarations

View File

@@ -27,7 +27,8 @@ The [CLI reference](../cli.md) owns observable syntax and presentation.
The initial implementation translated registered metadata through a neutral
bridge, rebuilt backend state for each invocation, and adapted backend routing,
local flags, operands, presence, help, and syntax failures to selected semantics.
The [completed plan](implementation.md) records these stages and their checks.
The [completed initial implementation record](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/3871d837489b9955998b362587a52b47282dc021/docs/roadmap/implementation.md)
records these stages and their checks.
The earlier discussion of rejecting repeated singletons was superseded by the
accepted last-occurrence rule in [ADR 0006](../adr/0006-command-grammar.md).

View File

@@ -16,7 +16,7 @@ the [consumer guide](../consumers/guide.md) explains their use. The
[internal overview](../internal/overview.md) owns the actual package inventory,
and [go.mod](../../go.mod) owns dependency versions.
The [initial target](initial.md) and [completed implementation plan](implementation.md)
The [initial target](initial.md) and [completed initial implementation record](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/3871d837489b9955998b362587a52b47282dc021/docs/roadmap/implementation.md)
record the chosen layout and delivered API work. The initial implementation
requires no further facade package construction.

View File

@@ -369,7 +369,7 @@ the stage.
## Stage 5: document operation and reconcile release navigation
**Status:** pending. **Prerequisite:** Stage 4.
**Status:** complete. **Prerequisite:** Stage 4.
**Files:** new `docs/release.md`; `docs/policy/release.md`, README,
`docs/development.md`; historical roadmap references listed below; and stage
@@ -444,6 +444,18 @@ licensing footer navigation, intended release URL paths, changed historical
references, provenance, and Markdown whitespace. No publisher invocation on
CommandKit or another full test suite is needed for these prose edits.
Observed 2026-10-08: added `docs/release.md` with source-only preparation,
publication, status, and exact-object recovery instructions. The runbook was
reviewed against the profile, launcher, release policy, OSS policy, and ReleaseKit
v0.2.0 references. The policy retains its base version and upstream provenance
with an updated local date. README and developer navigation link to the runbook;
the developer guide records the optional local exercise. Historical references
now use the immutable initial-plan snapshot, while current ReleaseKit work links
to its roadmap and this plan. A link check found 228 valid local destinations and
fragments across 11 affected documents; Markdown whitespace checks passed. The
README's licensing and attribution footer remains intact. No real publication
or full test suite was run for this prose stage.
**Completion:** implemented tooling has one canonical runbook, policy status is
accurate, and old library history is distinguishable from current ReleaseKit
work. Commit the stage.

View File

@@ -5,9 +5,10 @@ Status: roadmap preparation and implementation-plan handoff complete.
Date: 2026-10-07.
The [feature roadmap](initial.md) records the selected initial target and its
completion. The [implementation plan](implementation.md) was prepared from that
review and has been executed. Checked entries below record the completed
preparation process; they are not assignments to restart planning.
completion. The [completed initial implementation record](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/3871d837489b9955998b362587a52b47282dc021/docs/roadmap/implementation.md)
was prepared from that review and has been executed. Checked entries below
record the completed preparation process; they are not assignments to restart
planning.
## Historical preparation process

View File

@@ -9,7 +9,7 @@ Date: 2026-10-07.
This document defines the selected initial target for the library: packages,
features, integration contracts, dependencies, and completion evidence. It was
prepared using [the agreed checklist](initial-plan.md). Implementation steps and
stage evidence belong in [the completed implementation plan](implementation.md).
stage evidence belong in the [completed initial implementation record](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/3871d837489b9955998b362587a52b47282dc021/docs/roadmap/implementation.md).
Detailed specifications below preserve the selected design baseline; they are
planning history, not a parallel current API or operator reference. The included
target is implemented; the table below records feature status.
@@ -592,11 +592,11 @@ framework, general dependency injection, concurrent-dispatch guarantees, and
implementation of additional library families. None is needed to prove the
initial selected feature target. Application-owned commands remain extensible.
Consumer migrations, release publication, and ReleaseKit integration are separate
work. Initial implementation should be a usable module with maintained examples;
source-release tooling is planned under the release policy when preparing a
releasable candidate. Do not create placeholder publisher commands or a binary
build matrix.
Consumer migrations and source publication were kept outside the initial
library target. Current ReleaseKit adoption is tracked in the
[adoption roadmap](releasekit.md) and its [implementation plan](implementation.md).
The initial implementation targeted a usable module with maintained examples;
it did not create placeholder publisher commands or a binary build matrix.
## Completion criteria

View File

@@ -138,7 +138,8 @@ labeled the retained process and outline as historical.
## D-06: clarify completed feature and implementation records
Owners: [initial.md](initial.md) and [implementation.md](implementation.md).
Owners: [initial.md](initial.md) and the
[completed initial implementation record](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/3871d837489b9955998b362587a52b47282dc021/docs/roadmap/implementation.md).
- [x] Replace ownership statements written in future tense in the feature roadmap with
links to the existing GoDoc and CLI reference. Clearly identify detailed