Check committed Go formatting
This commit is contained in:
17
docs/cli.md
17
docs/cli.md
@@ -27,6 +27,7 @@ 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 runs a separate `go vet -mod=readonly ./...`
|
||||
pass after successful tests when `validation.go.full_vet` is true. It then runs
|
||||
selected package compilation and committed Go formatting, followed by
|
||||
configured additional checks in profile order. It does not inspect remote
|
||||
availability or publish a tag.
|
||||
|
||||
@@ -34,7 +35,11 @@ When `validation.go.compile_targets` is selected, `check` compiles all packages
|
||||
for each configured `GOOS/GOARCH` pair after tests and full vet, using static
|
||||
mode with cgo disabled. This check produces no artifacts and does not execute
|
||||
target binaries. Compilation failures use the `package-compile` identity and
|
||||
show the selected target. Any artifact build selected by the separate `build`
|
||||
show the selected target. When `validation.go_format` is true, `check` examines
|
||||
regular committed Go files with the Go formatter after tests, vet, and package
|
||||
compilation. It includes vendor and nested-module source, ignores the worktree
|
||||
and symlink blobs, and reports unformatted paths as `go-format` without
|
||||
modifying files. Any artifact build selected by the separate `build`
|
||||
setting runs after shared validation and configured checks.
|
||||
|
||||
`check` writes errors and diagnostics to standard error. It returns status 0
|
||||
@@ -55,8 +60,9 @@ 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. 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,
|
||||
tests. Selected package compilation and committed Go formatting follow, then
|
||||
configured checks 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
|
||||
@@ -69,7 +75,10 @@ Shared validation failures use the same check and finding presentation as
|
||||
When `validation.go.compile_targets` is selected, package compilation runs
|
||||
after tests and full vet and before configured checks. Each failure is reported
|
||||
as `package-compile` with its selected target; this does not create build
|
||||
artifacts or execute target binaries.
|
||||
artifacts or execute target binaries. When `validation.go_format` is true,
|
||||
committed Go formatting runs after package compilation and before configured
|
||||
checks. A failure is reported as `go-format` with affected repository paths;
|
||||
parser and source-inspection causes are retained.
|
||||
|
||||
The optional profile field `expected_push_url` applies only to `publish`. A
|
||||
nonempty value must exactly match the effective push URL resolved by Git;
|
||||
|
||||
Reference in New Issue
Block a user