Document local release page delivery after publication
This commit is contained in:
@@ -1,10 +1,11 @@
|
|||||||
# ReleaseKit release procedure
|
# ReleaseKit release procedure
|
||||||
|
|
||||||
ReleaseKit's deliverables are its source tag and a hosted Gitea page containing
|
ReleaseKit's deliverables are its source tag and a hosted Gitea page containing
|
||||||
the complete checked-in release note. The page is delivered asynchronously by
|
the complete checked-in release note. Deliver the page locally after publication
|
||||||
the prepared [Woodpecker workflow](../examples/woodpecker/releasekit-source-delivery.yml);
|
or asynchronously through the prepared
|
||||||
it is not a source-release completion check and carries no binary assets. The
|
[Woodpecker workflow](../examples/woodpecker/releasekit-source-delivery.yml).
|
||||||
authoritative repository is `origin` at
|
Hosted-page delivery has a separate status from source-release completion and
|
||||||
|
carries no binary assets. The authoritative repository is `origin` at
|
||||||
`ssh://git@forge.maximumdirect.net:22222/base-layer/releasekit.git`, and the release
|
`ssh://git@forge.maximumdirect.net:22222/base-layer/releasekit.git`, and the release
|
||||||
branch is `main`. The hosted Gitea destination is
|
branch is `main`. The hosted Gitea destination is
|
||||||
`https://forge.maximumdirect.net/base-layer/releasekit`. A release completes
|
`https://forge.maximumdirect.net/base-layer/releasekit`. A release completes
|
||||||
@@ -107,6 +108,22 @@ for ReleaseKit's first release before any released ReleaseKit executable
|
|||||||
exists. It uses the local Go toolchain. Preparation must finish before the
|
exists. It uses the local Go toolchain. Preparation must finish before the
|
||||||
offline validation begins.
|
offline validation begins.
|
||||||
|
|
||||||
|
## Deliver the hosted release page
|
||||||
|
|
||||||
|
After source publication succeeds, deliver the hosted page locally when
|
||||||
|
Woodpecker automation is inactive. From the same repository root, keep the
|
||||||
|
worktree clean and `HEAD` at the published tag's commit. Reuse the executable
|
||||||
|
built by the publication command:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
.releasekit/bin/releasekit deliver vX.Y.Z
|
||||||
|
```
|
||||||
|
|
||||||
|
The command uses the configured Gitea destination and token source to deliver
|
||||||
|
the complete checked-in release note. Report its result separately from the
|
||||||
|
completed source release. For failed or uncertain delivery, follow the recovery
|
||||||
|
instructions below using the same immutable version.
|
||||||
|
|
||||||
## Resolve failures
|
## Resolve failures
|
||||||
|
|
||||||
A failed push triggers a URL-resolution check against the captured endpoint,
|
A failed push triggers a URL-resolution check against the captured endpoint,
|
||||||
|
|||||||
Reference in New Issue
Block a user