Remove the remaining product roadmap and repair references

This commit is contained in:
2026-10-08 12:45:16 +00:00
parent 10964bebd4
commit e030794969
8 changed files with 13 additions and 83 deletions

View File

@@ -6,9 +6,7 @@ local candidate check, source-tag publication API, selected-target build API,
tagged-source delivery API, and the `version`, `check`, `publish`, `build`, tagged-source delivery API, and the `version`, `check`, `publish`, `build`,
`deliver`, and `ci-deliver` commands are implemented. ReleaseKit's source-only `deliver`, and `ci-deliver` commands are implemented. ReleaseKit's source-only
maintainer procedure and prepared Woodpecker workflow for hosted note-page maintainer procedure and prepared Woodpecker workflow for hosted note-page
delivery are documented. ReleaseKit does not declare binary deliverables. The delivery are documented. ReleaseKit does not declare binary deliverables.
[product roadmap](docs/roadmap/releasekit.md) records remaining adoption and
deployment work.
See the [v0.1.0 release note](docs/releases/v0.1.0.md) for the initial baseline See the [v0.1.0 release note](docs/releases/v0.1.0.md) for the initial baseline
and installation commands. and installation commands.
@@ -44,8 +42,6 @@ failure recovery.
## Documentation ## Documentation
- [Product roadmap](docs/roadmap/releasekit.md): consumer adoption goals and
remaining release and deployment work.
- [Contributor guide](docs/development.md): orientation, validation, and selective - [Contributor guide](docs/development.md): orientation, validation, and selective
policy reading. policy reading.
- [CLI contract](docs/cli.md): the `version`, `check`, `publish`, `build`, - [CLI contract](docs/cli.md): the `version`, `check`, `publish`, `build`,

View File

@@ -2,8 +2,7 @@
ReleaseKit contains a Go module with the documented root `releasekit` facade, ReleaseKit contains a Go module with the documented root `releasekit` facade,
adopted policies, and design documents. See the [README](../README.md) for adopted policies, and design documents. See the [README](../README.md) for
orientation and the [product roadmap](roadmap/releasekit.md) for proposed orientation.
capabilities and implementation sequencing.
Read the [agent policy](policy/agents.md) and inspect the worktree before editing. Read the [agent policy](policy/agents.md) and inspect the worktree before editing.
Preserve unrelated changes and follow explicit instructions about commits. Preserve unrelated changes and follow explicit instructions about commits.
@@ -55,8 +54,7 @@ go run ./internal/apicheck
See the [candidate check guide](consumers/check.md), [source publication guide](consumers/publish.md), See the [candidate check guide](consumers/check.md), [source publication guide](consumers/publish.md),
[build consumer guide](consumers/build.md), [build consumer guide](consumers/build.md),
and [internal package inventory](internal/overview.md) for implemented behavior and [internal package inventory](internal/overview.md) for implemented behavior
and capability ownership. The [product roadmap](roadmap/releasekit.md) records and capability ownership.
remaining adoption and deployment work.
For prose changes, review the diff and check local links, fragment destinations, For prose changes, review the diff and check local links, fragment destinations,
provenance, template residue, and consistency with current repository contents. provenance, template residue, and consistency with current repository contents.

View File

@@ -100,7 +100,3 @@ The [Gitea integration guide](../integrations/gitea.md) owns the HTTP contract
and hosted response handling. The [Woodpecker examples](../../examples/woodpecker/) and hosted response handling. The [Woodpecker examples](../../examples/woodpecker/)
are prepared integrations; their YAML is not active in this repository, and no are prepared integrations; their YAML is not active in this repository, and no
live Woodpecker runner, configured secret, or hosted delivery has been used. live Woodpecker runner, configured secret, or hosted delivery has been used.
A read-only PromptKit and Narratio migration review and projected deletion
estimates are recorded in the [product roadmap](../roadmap/releasekit.md);
broader migrations beyond Audita and measurement of realized savings remain
future adoption work.

View File

@@ -107,8 +107,8 @@ When an optional check is accepted for implementation:
existing local Git and CLI fixtures. existing local Git and CLI fixtures.
7. Update only the canonical owners for behavior that has landed: GoDoc for the 7. Update only the canonical owners for behavior that has landed: GoDoc for the
API, configuration and CLI references for profile behavior, and this API, configuration and CLI references for profile behavior, and this
inventory for internal ownership. Keep later feature contracts in the inventory for internal ownership. Record proposed checks under
product roadmap. `docs/roadmap/`.
Do not add a public validator registration interface. The public specification Do not add a public validator registration interface. The public specification
selects ReleaseKit-owned checks; `AdditionalChecks` remains the extension point selects ReleaseKit-owned checks; `AdditionalChecks` remains the extension point

View File

@@ -11,8 +11,8 @@
ReleaseKit is an opinionated Go library and release executable for common ReleaseKit is an opinionated Go library and release executable for common
publication, builds, version injection, and delivery. This policy owns publication, builds, version injection, and delivery. This policy owns
responsibility boundaries, dependency direction, and adopted constraints for responsibility boundaries, dependency direction, and adopted constraints for
development. The [product roadmap](../roadmap/releasekit.md) owns proposed development. Roadmaps own proposed capabilities, implementation status, and
capabilities, implementation status, and sequencing. sequencing.
The [internal documentation](../internal/overview.md) owns concrete package The [internal documentation](../internal/overview.md) owns concrete package
inventory and implementation mechanics. Canonical public contracts own exact inventory and implementation mechanics. Canonical public contracts own exact
@@ -106,7 +106,7 @@ Source publication and asynchronous delivery have distinct outcomes. The
declarations and GoDoc define supported consumer API contracts; declarations and GoDoc define supported consumer API contracts;
[consumer guides](../consumers/) explain their use, and [consumer guides](../consumers/) explain their use, and
[integration guides](../integrations/) define external formats and protocols. [integration guides](../integrations/) define external formats and protocols.
The product roadmap records planned capabilities and implementation status. Roadmaps record planned capabilities and implementation status.
## Trust Boundaries And Threat Scope ## Trust Boundaries And Threat Scope

View File

@@ -17,8 +17,7 @@ summaries belong in `docs/releases/`. The procedure must agree with the adopted
policy and link to it rather than introduce additional release requirements. policy and link to it rather than introduce additional release requirements.
This policy governs releases of ReleaseKit itself. Go declarations and GoDoc This policy governs releases of ReleaseKit itself. Go declarations and GoDoc
own supported consumer API contracts; the [product roadmap](../roadmap/releasekit.md) own supported consumer API contracts. The maintainer runbook describes
records planned adoption and deployment work. The maintainer runbook describes
ReleaseKit's implemented source publication and hosted-page delivery procedure. ReleaseKit's implemented source publication and hosted-page delivery procedure.
## Release Model And Completion ## Release Model And Completion

View File

@@ -1,61 +0,0 @@
# ReleaseKit adoption and deployment roadmap
Status: Pending consumer adoption and live deployment. The v0.2.0 implementation
and its remediation are complete.
The [v0.2.0 release note](../releases/v0.2.0.md) summarizes the implemented
capabilities. The [internal inventory](../internal/overview.md) records their
owners and local verification. Completed plans and review findings remain in
Git history. The [architecture policy](../policy/architecture.md) and accepted
ADRs own the selected architectural constraints.
## Remaining work
- Choose the broader consumer integration test plan and migration sequence for
PromptKit, ConfigKit, Notarius, Narratio, and Scriptorium. Evaluate API clarity,
product-specific checks, and the infrastructure removed from each repository.
- Adopt the common publication, validation, runtime-version, build, and delivery
conventions where they apply. Keep product identity, compatibility decisions,
and substantive application checks with each consumer.
- Provision delivery credentials and activate ReleaseKit and consumer Woodpecker
workflows as part of deployment. The maintained consumer template selects
tooling from the released application's module configuration.
- Verify live Gitea delivery and Woodpecker execution. Current verification uses
local Git and HTTP fixtures; live deployment remains unverified.
- Measure realized reductions in consumer release infrastructure after migration.
Audita's module-selected local and CI integration is committed at `17421bc`.
## Proposals and deferred work
- Optional recognizable-credential checks remain an unevaluated suggestion from
PromptKit's feature request. Evaluate their detection scope, synthetic-fixture
handling, false-positive costs, and maintenance benefit before selecting shared
support. The proposal establishes no mandatory credential gate.
- ReleaseKit executable binary distribution remains deferred until deliverables
are deliberately selected. Selecting binaries would require delivery
declarations, target checks, automation responsibilities, and corresponding
release policy and procedure updates.
- Evaluate a maintained ReleaseKit CI image or specialized validation/build
settings when a demonstrated consumer need justifies their maintenance cost
under [ADR 0002](../adr/0002-routine-releases.md).
## Representative migration review
Read-only reviews of the available PromptKit and Narratio checkouts were
verified on 2026-10-06 at `4b8169d` and `8afb49c`; both worktrees were clean.
These are migration assessments, not changes to either consumer.
| Consumer | Retain in its profile and product checks | Adaptation and procedure changes |
| --- | --- | --- |
| PromptKit, source-only | Product identity; its `Summary`, `Compatibility`, `Upgrade`, and `Changes` release-note sections; checks that exercise the three maintained Go examples and their product outputs. No runtime `buildinfo` import or binary targets are needed. | Its current release scripts total 209 lines. The projected deletion is about 120–160 lines of shared publication and generic validation machinery; retain the note-content rule and product-example checks as a configured additional check plus a small wiring test. PromptKit already pushes `main` before publication and creates annotated tags. Its release policy and procedure still need to add the hosted note page, delivery credentials, module-selected CI invocation, and separate delivery status and recovery. |
| Narratio, binary | Product/module identity, the `./cmd/narratio` main package, `narratio` executable name, Linux amd64, Linux arm64, and macOS arm64 targets, and the `narratio <version>` command. Keep the module-graph check (`go mod tidy -diff`) if it remains useful as a product-specific candidate check. | Its release, check, asset-builder, and helper scripts total 304 lines; two dedicated release test files total 741 lines. Projected deletions are about 220–280 shell lines and 450–650 repeated test lines, leaving a small consumer wiring test and any retained module/note checks. Replace the private linker-version variable with `buildinfo.Version()` while preserving the current command output. Its policy and procedure need to change lightweight tags to annotated tags, state that a successful tag push completes source publication, and move plugin-based page/assets delivery to the shared versioned CI command with content-aware retries and separately provisioned delivery credentials. |
The deletion figures are estimates from the reviewed files, not measured
migration results or a promise that each line will disappear. Product checks,
version output, target choices, and at least one ReleaseKit integration check
remain with each consumer. The existing cross-project estimate of 1,000–1,250
potentially removable lines remains directional until migrations are completed.
The self-contained ReleaseKit fixtures exercise a meaningful source-only
compatibility check through local Git publication, and a `buildinfo` binary
consumer with selected targets through local HTTP delivery. These are separate
publication and delivery operations.

View File

@@ -1,4 +1,6 @@
# ReleaseKit ideas # ReleaseKit ideas
The [product roadmap](docs/roadmap/releasekit.md) records shared release-process The [architecture policy](docs/policy/architecture.md) and
adoption goals and remaining release and deployment work. [ADRs](docs/adr/) record the adopted design decisions. The
[v0.2.0 release note](docs/releases/v0.2.0.md) summarizes the implemented
capabilities.