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

Record completion and verification of the module migration

Browse Source
This commit is contained in:
Eric Rakestraw
2026-11-01 14:41:36 +00:00
parent 3b803d558b
commit a1cac0898e
1 changed files with 48 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
docs/roadmap/migration.md
View File

@@ -1,6 +1,6 @@
# Roadmap: migrate to the ReleaseKit vanity module path # Roadmap: migrate to the ReleaseKit vanity module path
Status: implementation in place; final verification and completion review underway. Status: implementation complete; offline verification and completion review passed.
## Objective ## Objective
@@ -158,3 +158,50 @@ Publication follows the existing [release procedure](../release.md). Reuse
successful validation where it applies to the exact candidate, as allowed by successful validation where it applies to the exact candidate, as allowed by
the release policy. Track source publication and hosted-page delivery the release policy. Track source publication and hosted-page delivery
separately under that procedure. separately under that procedure.
## Completion review
Implementation is committed in `3b803d5`. Verification used Go 1.26.10 on
linux/amd64 with local toolchain selection. The following work is complete:
| Work | Completion evidence |
| --- | --- |
| Source and embedded identities | Module declaration, imports, version-injection symbol, and API checker use the vanity path; compiled API/dependency checks passed. |
| Fixtures and examples | Generated consumer modules, synthetic proxies, launchers, and workflows use the vanity identity; the full offline suite passed, including executable-workflow and tagged-retry coverage. |
| Adoption and release guidance | Current guides and examples describe the new paths; `docs/releases/v0.5.0.md` records compatibility impact, migration steps, and the immutable-tag licensing footer. |
| Gitea hosting references | Delivery profile, runbook, current source links, and fixture expectations use `forge.maximumdirect.net/base-layer/releasekit`; a one-time repository API read returned that repository identity. |
The complete offline suite passed against the committed implementation:
```sh
GOTOOLCHAIN=local GOWORK=off GOPROXY=off GOSUMDB=off \
go test -mod=readonly -count=1 ./...
```
The compiled facade/dependency checks and dependency-metadata review passed:
```sh
GOTOOLCHAIN=local GOWORK=off GOPROXY=off GOSUMDB=off \
go run ./internal/apicheck
GOTOOLCHAIN=local GOWORK=off GOPROXY=off GOSUMDB=off \
go mod tidy -diff
```
Build/version-injection integration tests passed. An additional disposable
consumer removed the original CLI tool declaration, registered the vanity-path
CLI through a local source replacement, and ran `go tool releasekit version`
successfully. Its executable imported the root facade and `buildinfo` and
reported the injected `v9.8.7` version. These were offline checks using temporary
consumer metadata.
The completion review found no original-path references in Go source. Current
documentation retains the old path only to explain migration and older
releases. A source comparison confirmed that Go changes consist of module-path
substitutions and the separately reviewed hosting-fixture updates. Existing
release records, ADRs, upstream attribution and policy provenance, dependency
checksums, and the Go 1.26.0 minimum are preserved. Documentation links, heading
fragments, example shell syntax, formatting, and whitespace checks passed.
The implementation is ready for release preparation. Source publication and
fresh consumption of a published vanity-path version remain release follow-up
under the procedure above.