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

Update ReleaseKit documentation and attribution

Browse Source
This commit is contained in:
Eric Rakestraw
2026-11-04 03:02:16 +00:00
parent eb974b6d29
commit bdc3fd8fa3
6 changed files with 23 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/consumers/guide.md
View File

@@ -24,7 +24,7 @@ core-only, ConfigKit-only, and composed applications.
## Go compatibility ## Go compatibility
All three modules declare a consumer minimum of Go 1.26.0. The root module also All three modules declare a consumer minimum of Go 1.26.0. The root module also
selects ReleaseKit v0.8.0 (`go.maximumdirect.net/releasekit`) as a Go tool, which selects ReleaseKit v0.9.0 (`go.maximumdirect.net/releasekit`) as a Go tool, which
makes that tool's module graph part of the root consumer module requirements makes that tool's module graph part of the root consumer module requirements
even though production packages do not import ReleaseKit. The even though production packages do not import ReleaseKit. The
[release policy](../policy/release.md#consumer-minimum-and-release-toolchain) [release policy](../policy/release.md#consumer-minimum-and-release-toolchain)

6
docs/oss/attribution.md
View File

@@ -139,16 +139,16 @@ License and notices: [CC BY-SA 4.0](licenses/CC-BY-SA-4.0.txt) |
## ReleaseKit ## ReleaseKit
Selected module: `go.maximumdirect.net/releasekit` at `v0.8.0` (selected Go tool; not a runtime import). Selected module: `go.maximumdirect.net/releasekit` at `v0.9.0` (selected Go tool; not a runtime import).
Copyright (C) 2026 Eric Rakestraw Copyright (C) 2026 Eric Rakestraw
SPDX-License-Identifier: LGPL-3.0-or-later SPDX-License-Identifier: LGPL-3.0-or-later
License and notices: [LGPL v3.0](../../LICENSE) | License and notices: [LGPL v3.0](../../LICENSE) |
[LICENSE](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/23203f235cc414c4ffe0fd3941030eb0c9f9943f/LICENSE). [LICENSE](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/2180aa868ec2caa95fc8279fd59d5f0ebac41bd4/LICENSE).
[Source](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/23203f235cc414c4ffe0fd3941030eb0c9f9943f). [Source](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/2180aa868ec2caa95fc8279fd59d5f0ebac41bd4).
## Goldmark ## Goldmark

2
docs/policy/release.md
View File

@@ -25,7 +25,7 @@ additional release requirements.
CommandKit independently versions three source-only Go modules: the root core, CommandKit independently versions three source-only Go modules: the root core,
`integrations/ckconfig`, and `integrations/ckprompt`. Standard CLI behavior is `integrations/ckconfig`, and `integrations/ckprompt`. Standard CLI behavior is
exposed by consuming applications; CommandKit does not declare binary exposed by consuming applications; CommandKit does not declare binary
deliverables or a cross-platform build matrix. ReleaseKit v0.8.0 is selected as deliverables or a cross-platform build matrix. ReleaseKit v0.9.0 is selected as
the maintainer publication tool. Maintainers may separately deliver page-only the maintainer publication tool. Maintainers may separately deliver page-only
Gitea releases from tagged source; delivery has its own outcome and URL. The Gitea releases from tagged source; delivery has its own outcome and URL. The
[release procedure](../release.md) owns the selected-module workflow, release [release procedure](../release.md) owns the selected-module workflow, release

18
docs/release.md
View File

@@ -22,13 +22,13 @@ module profile enforces the endpoint. The maintainer needs the selected
This procedure follows the [release policy](policy/release.md); release-note This procedure follows the [release policy](policy/release.md); release-note
footers follow the [OSS discoverability policy](policy/oss.md#discoverability). footers follow the [OSS discoverability policy](policy/oss.md#discoverability).
ReleaseKit v0.8.0 (`go.maximumdirect.net/releasekit`) owns candidate validation, ReleaseKit v0.9.0 (`go.maximumdirect.net/releasekit`) owns candidate validation,
publication guards, tag creation, tag publication, and outcome reporting. publication guards, tag creation, tag publication, and outcome reporting.
Its pinned public contracts are the Its pinned public contracts are the
[CLI reference](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/23203f235cc414c4ffe0fd3941030eb0c9f9943f/docs/cli.md), [CLI reference](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/2180aa868ec2caa95fc8279fd59d5f0ebac41bd4/docs/cli.md),
[profile reference](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/23203f235cc414c4ffe0fd3941030eb0c9f9943f/docs/config.md), [profile reference](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/2180aa868ec2caa95fc8279fd59d5f0ebac41bd4/docs/config.md),
the [publication guide](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/23203f235cc414c4ffe0fd3941030eb0c9f9943f/docs/consumers/publish.md), the [publication guide](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/2180aa868ec2caa95fc8279fd59d5f0ebac41bd4/docs/consumers/publish.md),
and the [delivery guide](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/23203f235cc414c4ffe0fd3941030eb0c9f9943f/docs/consumers/delivery.md). and the [delivery guide](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/2180aa868ec2caa95fc8279fd59d5f0ebac41bd4/docs/consumers/delivery.md).
The repository selects one default module suite per invocation. The launcher The repository selects one default module suite per invocation. The launcher
uses the root module’s registered tool with native host settings and read-only uses the root module’s registered tool with native host settings and read-only
module metadata. module metadata.
@@ -78,7 +78,7 @@ integration directory. Future tag URLs need not resolve before publication.
All three release profiles explicitly select the repository-root `COPYRIGHT`, All three release profiles explicitly select the repository-root `COPYRIGHT`,
`LICENSE`, and `docs/oss/attribution.md` through `validation.shared_files`. `LICENSE`, and `docs/oss/attribution.md` through `validation.shared_files`.
ReleaseKit requires these committed files to exist in the candidate. The list ReleaseKit requires these committed files to exist in the candidate. The list
does not expand Go validation scope; see the pinned [profile reference](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/23203f235cc414c4ffe0fd3941030eb0c9f9943f/docs/config.md). does not expand Go validation scope; see the pinned [profile reference](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/2180aa868ec2caa95fc8279fd59d5f0ebac41bd4/docs/config.md).
Each integration also distributes its own `COPYRIGHT`, `LICENSE`, and Each integration also distributes its own `COPYRIGHT`, `LICENSE`, and
`docs/oss/attribution.md`. These module-local materials are separate from the `docs/oss/attribution.md`. These module-local materials are separate from the
@@ -156,9 +156,9 @@ Reconciliation observes the recorded endpoint, full tag, and tag object without
rerunning candidate validation or changing tags. It distinguishes confirmed rerunning candidate validation or changing tags. It distinguishes confirmed
publication, current absence, conflict, and an unresolved observation. Current publication, current absence, conflict, and an unresolved observation. Current
absence does not prove that a version was never published. The pinned absence does not prove that a version was never published. The pinned
[CLI reference](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/23203f235cc414c4ffe0fd3941030eb0c9f9943f/docs/cli.md#recover-a-saved-publication-attempt-or-discover-local-attempts) [CLI reference](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/2180aa868ec2caa95fc8279fd59d5f0ebac41bd4/docs/cli.md#recover-a-saved-publication-attempt-or-discover-local-attempts)
owns recovery statuses and structured output; the owns recovery statuses and structured output; the
[publication guide](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/23203f235cc414c4ffe0fd3941030eb0c9f9943f/docs/consumers/publish.md#retain-and-reconcile-publication-evidence) [publication guide](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/2180aa868ec2caa95fc8279fd59d5f0ebac41bd4/docs/consumers/publish.md#retain-and-reconcile-publication-evidence)
describes record storage and recovery entry points. describes record storage and recovery entry points.
If no usable record was saved, use the exact endpoint, full tag, and annotated If no usable record was saved, use the exact endpoint, full tag, and annotated
@@ -188,7 +188,7 @@ worktree and index, then deliver the selected module's page:
The profile derives the full module-specific tag from the version. Delivery The profile derives the full module-specific tag from the version. Delivery
uses the checked-in release note as a page-only body and reports its own outcome uses the checked-in release note as a page-only body and reports its own outcome
and URL separately from source publication. Retry later from the same original and URL separately from source publication. Retry later from the same original
tagged source. The pinned [delivery guide](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/23203f235cc414c4ffe0fd3941030eb0c9f9943f/docs/consumers/delivery.md) tagged source. The pinned [delivery guide](https://forge.maximumdirect.net/base-layer/releasekit/src/commit/2180aa868ec2caa95fc8279fd59d5f0ebac41bd4/docs/consumers/delivery.md)
owns delivery and retry behavior. owns delivery and retry behavior.
A nonblank `RELEASEKIT_GITEA_TOKEN` takes precedence over the repository-relative A nonblank `RELEASEKIT_GITEA_TOKEN` takes precedence over the repository-relative

6
docs/roadmap/implementation.md
View File

@@ -1,6 +1,6 @@
# ReleaseKit v0.9.0 implementation plan # ReleaseKit v0.9.0 implementation plan
Status: Stages 1–2 complete; Stages 3–6 are not started. Status: Stages 1–3 complete; Stages 4–6 are not started.
Implement these stages in integer order during one end-to-end sprint. The target Implement these stages in integer order during one end-to-end sprint. The target
audience is the Luna coding agent. Intermediate stages may temporarily leave audience is the Luna coding agent. Intermediate stages may temporarily leave
@@ -139,7 +139,9 @@ and complete the source checks in Stages 4 and 5 before committing that unit.
## Stage 3: Align current documentation and attribution ## Stage 3: Align current documentation and attribution
**Status:** not started. **Completed.** Current tool references and attribution now identify v0.9.0 and
its pinned source. Upstream COPYRIGHT and LICENSE are unchanged; affected local
links and pinned upstream paths and recovery fragments were checked.
Update these owners together with the tool adoption: Update these owners together with the tool adoption:

9
docs/roadmap/release-simplification.md
View File

@@ -3,8 +3,9 @@
Status: the selected release-tooling design has been implemented. All four Status: the selected release-tooling design has been implemented. All four
generic file checks, registered-tool execution, page-only hosted delivery, and generic file checks, registered-tool execution, page-only hosted delivery, and
protection of the supplied token path are selected. protection of the supplied token path are selected.
The [implementation plan](implementation.md) owns stage order, tasks, validation, The [completed implementation record](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/87eb84ccb462bf54e6250c8b287ac217efe90883/docs/roadmap/implementation.md)
and completion evidence. Current release behavior stays with its canonical owners. contains stage order, tasks, validation, and completion evidence. Current release
behavior stays with its canonical owners.
## Purpose and authority ## Purpose and authority
@@ -93,8 +94,8 @@ identity from a current profile. Keep the existing publication interface and
provide an explicit delivery invocation without automatically chaining the two provide an explicit delivery invocation without automatically chaining the two
operations. Keep one selector mapping and shared invocation plumbing. operations. Keep one selector mapping and shared invocation plumbing.
A pending upstream request concerns host-safe consumer launcher examples and ReleaseKit v0.9.0 shipped host-safe consumer launcher examples and regression
regression coverage. It is not a dependency of this work: v0.8.0 already supports coverage. The earlier simplification used v0.8.0, which already supported
registered tools. Keep host normalization locally because the reviewed registered tools. Keep host normalization locally because the reviewed
`go tool` invocation inherited foreign `GOOS`/`GOARCH` values and failed to run. `go tool` invocation inherited foreign `GOOS`/`GOARCH` values and failed to run.
Do not switch tool-version selection from the root module to each integration Do not switch tool-version selection from the root module to each integration