Coordinate separate full vet pass
This commit is contained in:
17
docs/cli.md
17
docs/cli.md
@@ -25,13 +25,16 @@ version. The repository defaults to the current directory, and the profile
|
||||
defaults to `<repository>/releasekit.json`. A successful command prints the
|
||||
captured local commit and version. It checks the committed release note and
|
||||
local Git state, runs the standard offline Go test suite (with `-race` when
|
||||
`validation.go.race` is true), and then runs any configured additional checks
|
||||
in profile order. It does not inspect remote availability or publish a tag.
|
||||
`validation.go.race` is true), and runs a separate `go vet -mod=readonly ./...`
|
||||
pass after successful tests when `validation.go.full_vet` is true. It then runs
|
||||
configured additional checks in profile order. It does not inspect remote
|
||||
availability or publish a tag.
|
||||
|
||||
`check` writes errors and diagnostics to standard error. It returns status 0
|
||||
after local validation, 1 after a candidate validation failure, and 2 for usage,
|
||||
profile, or invalid-version errors. Shared validation failures identify the
|
||||
failed check and retain useful findings and cause context in one diagnostic.
|
||||
failed check and retain useful findings and cause context in one diagnostic;
|
||||
separate full-vet failures use the `go-vet` identity.
|
||||
Unsupported argument sequences print usage to standard error.
|
||||
|
||||
Publish a source tag:
|
||||
@@ -43,9 +46,11 @@ go run ./cmd/releasekit publish [--repo DIR] [--config FILE] VERSION
|
||||
`publish` reads the same product, remote, validation, and additional-check
|
||||
settings as `check`. It checks the authoritative remote and validates the
|
||||
candidate: the single standard offline Go test suite runs first, with `-race`
|
||||
when `validation.go.race` is true, followed by configured checks in profile
|
||||
order. It then creates an annotated local tag and pushes only its exact
|
||||
tag object. It prints the confirmed version, candidate commit, and tag object
|
||||
when `validation.go.race` is true. When `validation.go.full_vet` is true,
|
||||
test-time vet is disabled and `go vet -mod=readonly ./...` runs after successful
|
||||
tests. Configured checks then run in profile order. It then creates an annotated
|
||||
local tag and pushes only its exact tag object. It prints the confirmed version,
|
||||
candidate commit, and tag object
|
||||
on success. Validation
|
||||
progress and failed publication state, including the captured publication
|
||||
endpoint for recovery, are written to standard error. A signal
|
||||
|
||||
Reference in New Issue
Block a user