Complete implementation handoff documentation
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# ReleaseKit staged implementation plan
|
||||
|
||||
Status: In progress. Stages 1–17 are complete; later stages remain pending.
|
||||
Status: Complete. Stages 1–18 are complete.
|
||||
|
||||
Date: 2026-10-05
|
||||
|
||||
@@ -170,8 +170,10 @@ directory. A profile supplies product identity, remote, candidate commands,
|
||||
optional build specification, and optional Gitea delivery declaration. The
|
||||
command supplies the version rather than persisting it in the profile.
|
||||
|
||||
Use this eventual profile shape; add each optional responsibility only when its
|
||||
stage implements it:
|
||||
This composite profile shows the implemented fields together; working
|
||||
[source-only](../../examples/releasekit.json) and
|
||||
[binary-producing](../../examples/releasekit-binary.json) profiles are maintained
|
||||
under `examples/`:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -192,8 +194,7 @@ stage implements it:
|
||||
}
|
||||
```
|
||||
|
||||
This is a planned example, not an existing file or working invocation. Command
|
||||
entries also accept an `env` map. Run argument vectors directly, without
|
||||
Command entries also accept an `env` map. Run argument vectors directly, without
|
||||
implicit shell parsing. A repository that needs shell syntax selects `sh` or
|
||||
`bash` explicitly. Run commands in the captured repository directory and supply
|
||||
`RELEASEKIT_VERSION` and `RELEASEKIT_CANDIDATE` for candidate-specific checks.
|
||||
@@ -920,7 +921,7 @@ was used.
|
||||
|
||||
## Stage 18: Complete the initial implementation and handoff documentation
|
||||
|
||||
Status: Pending. Depends on Stage 17.
|
||||
Status: Complete. Depends on Stage 17.
|
||||
|
||||
1. Map each initial capability in the feature roadmap to its implemented owner
|
||||
and existing behavioral evidence. Record the concrete package and dependency
|
||||
@@ -946,6 +947,26 @@ implemented boundary accurately. Completion depends on local implementation
|
||||
and development evidence; architectural review, a broader testing plan,
|
||||
consumer migrations, and release/deployment decisions follow this sequence.
|
||||
|
||||
Evidence and handoff: `docs/internal/overview.md` records both public Go
|
||||
facades, all 14 implemented Go packages, the absence of third-party module
|
||||
dependencies, capability ownership, and representative behavioral tests. The
|
||||
README and canonical CLI, configuration, consumer, integration, development,
|
||||
and release documents describe the implemented behavior; the policy and product
|
||||
roadmaps no longer present completed facade, delivery, or workflow work as
|
||||
pending. `go test ./...`, `go run ./internal/apicheck`, local Markdown link and
|
||||
fragment checks, and prose whitespace checks pass. All three maintained
|
||||
Woodpecker examples parse with local PyYAML 6.0.3, with the token mapped only in
|
||||
each delivery step. Local Git and HTTP fixtures exercise source-only delivery,
|
||||
binary delivery, publication recovery, and the ReleaseKit tagged-source workflow.
|
||||
|
||||
The Woodpecker workflows remain prepared, not activated. No live runner,
|
||||
configured deployment secret, immutable deployment pin, hosted Gitea delivery,
|
||||
or ReleaseKit source release was used or verified. Consumer migrations and
|
||||
measurement of removed consumer infrastructure remain future adoption work.
|
||||
The implementation is ready for the maintainer's subsequent architecture
|
||||
review; broader testing and release or deployment decisions remain outside this
|
||||
completed implementation sequence.
|
||||
|
||||
## Coverage of the feature roadmap
|
||||
|
||||
| Initial target responsibility | Implementing stages |
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# Adopt the policy framework
|
||||
|
||||
Status: Policy adoption complete. Source publication and its maintainer runbook
|
||||
are implemented; no ReleaseKit release has been published. Executable delivery
|
||||
remains pending.
|
||||
Status: Policy adoption complete. Source publication, its maintainer runbook,
|
||||
and prepared hosted note-page delivery are implemented; no ReleaseKit release
|
||||
has been published. Binary distribution remains deferred.
|
||||
|
||||
Date: 2026-10-05
|
||||
|
||||
@@ -130,8 +130,9 @@ policy has separate defaults for applications and libraries.
|
||||
|
||||
- [x] Adopt the general versioning, compatibility, integrity, immutability, and
|
||||
successful-tag-push completion rules.
|
||||
- [x] Select source only as ReleaseKit's initial deliverable in the release
|
||||
policy. Supporting downstream cross-builds does not declare ReleaseKit binaries.
|
||||
- [x] Select the immutable source tag as the source-completion point and the
|
||||
hosted note page as a separate asynchronous deliverable. Supporting downstream
|
||||
cross-builds does not declare ReleaseKit binaries.
|
||||
- [x] Add `docs/release.md` alongside the first working publication command,
|
||||
documenting real prerequisites, authoritative remote, branch, validation,
|
||||
publication, and failure recovery.
|
||||
@@ -145,8 +146,8 @@ policy has separate defaults for applications and libraries.
|
||||
separate. This task is deferred unless executable deliverables are selected.
|
||||
|
||||
The publication command, its automated guards, offline candidate validation,
|
||||
and executable maintainer runbook are implemented. This adoption does not claim
|
||||
that a ReleaseKit version has been published.
|
||||
executable maintainer runbook, and prepared hosted-page workflow are implemented.
|
||||
This adoption does not claim that a ReleaseKit version has been published.
|
||||
|
||||
## Validation and completion
|
||||
|
||||
@@ -157,8 +158,8 @@ examples added later require appropriate execution checks.
|
||||
|
||||
Adoption is complete when the tailored policy set, contributor navigation,
|
||||
documentation ownership, and licensing notices are coherent and verified. The
|
||||
release-path stage may remain pending until publication is implemented; record
|
||||
that status without documenting an unavailable command as usable.
|
||||
source-publication command and hosted-page delivery are implemented; actual
|
||||
publication and binary distribution remain outside policy adoption.
|
||||
|
||||
Do not inherit PromptKit's or ConfigKit's extra release gates automatically.
|
||||
Select additional checks only for identified ReleaseKit risks, recording their
|
||||
@@ -169,13 +170,14 @@ approval, and CI polling are not additional adoption or release gates.
|
||||
|
||||
The seven policies, root agent orientation, developer reading guide, documentation
|
||||
ownership, project grant, attribution, license texts, source publication command,
|
||||
and maintainer runbook are in place. The product proposal lives at
|
||||
`docs/roadmap/releasekit.md`; `ideas.md` remains a navigation pointer. Executable
|
||||
delivery remains pending, and no ReleaseKit release has been published.
|
||||
maintainer runbook, and prepared hosted-page delivery are in place. The product
|
||||
proposal lives at `docs/roadmap/releasekit.md`; `ideas.md` remains a navigation
|
||||
pointer. Binary distribution is deferred, and no ReleaseKit release has been
|
||||
published.
|
||||
|
||||
Verification covers local file and fragment links, per-policy source revision and
|
||||
base version, removed template adoption sections, attribution scope and pinned
|
||||
notice destinations, verbatim license bytes, and prose whitespace. The preserved
|
||||
ADR decision and relocated proposal are checked against their pre-adoption source.
|
||||
ReleaseKit's source publication command and runbook are implemented; executable
|
||||
delivery declarations remain pending under stage 4.
|
||||
ReleaseKit's source publication command, runbook, and hosted-page deliverable are
|
||||
implemented; binary delivery declarations remain deferred under stage 4.
|
||||
|
||||
@@ -1,14 +1,16 @@
|
||||
# ReleaseKit: shared release process
|
||||
|
||||
This is a proposal based on a review of PromptKit, ConfigKit, Audita, Notarius,
|
||||
Narratio, and Scriptorium on 2026-09-29. The implementation plan records the
|
||||
current implemented boundary; the internal Gitea page and asset-delivery
|
||||
client is implemented, while facade/CLI integration and broader integrations
|
||||
remain planned. The public facade architecture is
|
||||
accepted in [ADR 0001](../adr/0001-public-facade.md) and is implemented for
|
||||
runtime version, candidate validation, and source publication.
|
||||
This proposal records a review of PromptKit, ConfigKit, Audita, Notarius,
|
||||
Narratio, and Scriptorium on 2026-09-29. The initial library, CLI, build and
|
||||
delivery paths, and prepared Woodpecker examples are implemented; the
|
||||
[implementation plan](implementation.md) records the completed boundary and
|
||||
evidence. The public facade architecture is accepted in
|
||||
[ADR 0001](../adr/0001-public-facade.md) and implemented for runtime version,
|
||||
candidate validation, source publication, selected-target builds, and tagged-
|
||||
source delivery.
|
||||
The [implementation plan](implementation.md) owns ordered stages, execution
|
||||
instructions, acceptance checks, and progress toward this target state.
|
||||
instructions, acceptance checks, and implementation status. Consumer migration
|
||||
and measurement of local infrastructure reduction remain future adoption work.
|
||||
|
||||
## Opportunity
|
||||
|
||||
@@ -29,7 +31,7 @@ of publication scripts, 150–250 lines of checks and builders, and 400–500 li
|
||||
of repeated publication tests. ReleaseKit would gain its own implementation and
|
||||
tests, so this is a reduction in local code, not a net line-count saving.
|
||||
|
||||
## Proposed publication standard
|
||||
## Selected publication standard
|
||||
|
||||
1. Prepare and commit a version-matched note at `docs/releases/<version>.md`.
|
||||
2. Publish the candidate commit to authoritative `main` before invoking the
|
||||
|
||||
Reference in New Issue
Block a user