Expose tagged-source delivery through facade and CLI
This commit is contained in:
31
docs/cli.md
31
docs/cli.md
@@ -1,6 +1,6 @@
|
||||
# Command line
|
||||
|
||||
ReleaseKit currently provides four commands.
|
||||
ReleaseKit currently provides five commands.
|
||||
|
||||
Print the executable version:
|
||||
|
||||
@@ -72,3 +72,32 @@ The command returns status 0 on completion, 1 for build or output failure, and
|
||||
tree and does not perform candidate validation or remote publication. `check`
|
||||
and `publish` run the same configured build after their one candidate
|
||||
validation, using temporary output outside the worktree.
|
||||
|
||||
Deliver a tagged source release to Gitea:
|
||||
|
||||
```sh
|
||||
go run ./cmd/releasekit deliver [--repo DIR] [--config FILE] [--assets DIR] VERSION
|
||||
```
|
||||
|
||||
`deliver` requires a `delivery` profile object and its configured token
|
||||
environment variable, which defaults to `RELEASEKIT_GITEA_TOKEN`. It verifies
|
||||
the local tag, clean tagged checkout, hosted tag, and committed release note,
|
||||
then creates or finds the release page and reports delivery state separately
|
||||
from source publication. Historical lightweight tags and detached checkouts
|
||||
are supported when `HEAD` is the selected tag commit; delivery does not require
|
||||
the former remote `main` to match.
|
||||
|
||||
When the profile has build targets and `--assets` is omitted, `deliver` builds
|
||||
the tagged source into temporary storage and uploads its binaries and complete
|
||||
`SHA256SUMS`. When `--assets DIR` is supplied, that directory must contain the
|
||||
private `.releasekit-build.json` receipt and matching unchanged artifacts.
|
||||
Profiles without targets use page-only delivery and need no receipt, binary
|
||||
build, or manifest. `deliver` never runs candidate checks or publishes a tag.
|
||||
|
||||
The command returns 0 for complete delivery, 1 for a known failure, conflict,
|
||||
or partial delivery, 2 for usage, profile, or missing-credential errors, and 3
|
||||
when a remote write remains uncertain. The result lists matching, uploaded,
|
||||
pending, conflicting, and uncertain assets as available. Retry the same version
|
||||
with the same tagged source and destination; matching content is kept and only
|
||||
missing assets are added. See the [delivery consumer guide](consumers/delivery.md)
|
||||
and [Gitea integration guide](integrations/gitea.md).
|
||||
|
||||
Reference in New Issue
Block a user