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

Use the source-built CLI in maintainer recovery instructions

Browse Source
This commit is contained in:
Eric Rakestraw
2026-11-02 22:34:19 +00:00
parent 6fc140d8dc
commit 109596bc3b
3 changed files with 15 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/release.md
View File

@@ -129,11 +129,11 @@ instructions below using the same immutable version.
Each publication invocation attempts to save its captured identity before the Each publication invocation attempts to save its captured identity before the
tag push. The CLI reports the saved record path separately from publication tag push. The CLI reports the saved record path separately from publication
success or failure and, after a push or immediate-reconciliation error, prints a success or failure and, after a push or immediate-reconciliation error, prints a
copyable command that selects that exact record. Run that command to make a copyable command that selects that exact record. Run that command, or use the
separate later observation: source-built executable prepared above, to make a separate later observation:
```sh ```sh
'/path/to/releasekit' reconcile --record '/absolute/path/to/attempt-record.json' ./.releasekit/bin/releasekit reconcile --record '/absolute/path/to/attempt-record.json'
``` ```
The saved evidence fixes the original endpoint and tag identity. Later recovery The saved evidence fixes the original endpoint and tag identity. Later recovery
@@ -150,15 +150,15 @@ If command output was lost, list local attempts and explicitly select the
matching record by its module, full tag, and saved identity: matching record by its module, full tag, and saved identity:
```sh ```sh
releasekit publication-attempts --repo "$PWD" ./.releasekit/bin/releasekit publication-attempts --repo "$PWD"
releasekit reconcile --record '/absolute/path/from-the-list/attempt-record.json' ./.releasekit/bin/releasekit reconcile --record '/absolute/path/from-the-list/attempt-record.json'
``` ```
Discovery only reads the local store. It neither queries remotes nor chooses an Discovery only reads the local store. It neither queries remotes nor chooses an
attempt automatically. Use a supported ReleaseKit CLI if the executable named attempt automatically. If the original recovery entry point is unavailable,
in the printed handoff command is no longer available. An older record may lack select another supported ReleaseKit CLI and pass the same record path explicitly.
the endpoint, tag-object ID, candidate commit, or another field required for a An older record may lack the endpoint, tag-object ID, candidate commit, or
conclusive result. another field required for a conclusive result.
A later observation that the tag is absent describes the remote at that time; A later observation that the tag is absent describes the remote at that time;
it does not prove the version was never published. Never reuse a version known it does not prove the version was never published. Never reuse a version known

2
docs/roadmap/publication-reconciliation.md
View File

@@ -18,7 +18,7 @@ release version or prescribing a staged implementation plan.
The current checkout contains the v0.7.0 release notes and publication workflow. The current checkout contains the v0.7.0 release notes and publication workflow.
The [publication guide](../consumers/publish.md) describes existing outcomes; The [publication guide](../consumers/publish.md) describes existing outcomes;
the [maintainer runbook](../release.md#resolve-failures) describes manual recovery. the [maintainer runbook](../release.md#resolve-publication-failures) describes manual recovery.
- `PublicationResult` supplies the repository and module identity, semantic - `PublicationResult` supplies the repository and module identity, semantic
version, full tag, candidate commit, captured endpoint, tag object when known, version, full tag, candidate commit, captured endpoint, tag object when known,

5
docs/roadmap/remediation.md
View File

@@ -347,6 +347,11 @@ linked-worktree behavior instead of introducing new pathname restrictions.
## R09: Align maintainer recovery instructions with the source bootstrap — P2 ## R09: Align maintainer recovery instructions with the source bootstrap — P2
**Completed:** Runbook discovery and reconciliation use the prepared source-built
CLI, and the roadmap recovery link targets the current heading. Disposable local
checks executed both snippets with no global `releasekit`, confirming discovery
and the expected incomplete-evidence reconciliation status.
**Relevant code/docs:** `scripts/release:9`; `docs/release.md:104` and **Relevant code/docs:** `scripts/release:9`; `docs/release.md:104` and
`release.md:149`; `docs/roadmap/publication-reconciliation.md:21`. `release.md:149`; `docs/roadmap/publication-reconciliation.md:21`.