docs: ci/release tooling doc-accuracy batch#99
Merged
Conversation
2a3d1a8 to
a0c47ff
Compare
Four bundled fixes from issue #69: - CONTRIBUTING.md dropped a bogus CoGitto status check from the CI matrix and corrected the count to 9. - CONTRIBUTING.md corrected make ci description: tidy fmt vet lint test in that order, with a warning that fmt rewrites the tree. - .goreleaser.yaml, .github/workflows/release.yml, and docs/release-checklist.md all claimed 6 binaries; actual is 5 (linux/windows/darwin × amd64/arm64 minus windows/arm64) + checksums.txt. - .github/workflows/ci.yml renamed coverage.txt to coverage.out to match the documented make test output. Closes #69
a0c47ff to
ebedf63
Compare
|
✔️ ebedf63 - Conventional commits check succeeded. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Four small CI/release tooling doc-accuracy fixes surfaced by issue
#69. Each is a one-line-to-small edit; the value is consistency
between the docs and the actual repo state.
CONTRIBUTING.mdremoved a bogus "CoGitto status check" andcorrected the CI matrix count. The previous text said
"10-check matrix" including "1 CoGitto status check" — no
such workflow exists in
.github/workflows/(onlyci.yml+release.yml). Worse, this contradicted CONTRIBUTING.md's own"Sign-off (future)" section (lines 141-146) which correctly
notes CoGitto-style enforcement is "not required today; will
be enabled by a
.github/workflows/dco.ymlcheck beforev1.0.0." If branch protection were ever configured to require
a check literally named "CoGitto," it would hang forever.
Updated the matrix to 9 checks (5 builds + 1 lint + 3 OS
tests).
make cidescription in CONTRIBUTING.md was wrong. Itsaid
make cirunstidy,vet,test, andgolangci-lint run— omitting thefmtstep and misstatingthe order. The Makefile target (line 126) is
tidy fmt vet lint test. Sincefmtrewrites files in place, the newdescription explicitly warns contributors to run it on a
clean tree or be ready to commit the rewrites. CLAUDE.md's
description was already correct and is unchanged.
"6 binaries" was wrong in three places. The actual platform
matrix (linux/windows/darwin × amd64/arm64, minus the
documented
windows/arm64exclusion in.goreleaser.yaml)produces 5 archives; checksums.txt is a 6th file but isn't a
binary. Corrected in:
.goreleaser.yamlheader comment — lists 5 archive namesexplicitly and notes windows/arm64 is intentionally excluded.
.github/workflows/release.ymlstep-3 comment — "all 5platform binaries" with a pointer at the windows/arm64
exclusion in
.goreleaser.yaml.docs/release-checklist.mdpost-tag checklist — "All 5binaries attached + checksums.txt."
CI coverage filename reconciled with documented
make test..github/workflows/ci.ymlwas producing and uploadingcoverage.txt;make test(the documented local command)produces
coverage.out. Renamed CI tocoverage.outso acontributor running the documented
make testsees thesame filename CI consumes. Both filenames are gitignored so
this is just naming consistency.
Linked issues
Closes #69
Type of change
docs— documentation onlyfeat— new feature (MINOR bump)fix— bug fix (PATCH bump)refactor— no behavior changeperf— performance improvementtest— tests onlychore— maintenance / dependency bumpci— CI/CD onlybuild— build system onlyChecklist
docs(scope): subject)make cilocally and it passesdocs-only / CI-config-only change)
CHANGELOG.mdgets a### Fixedentry under[Unreleased])make lintgreen)body and updated CHANGELOG.md
Files touched
CONTRIBUTING.md— drops the bogus "CoGitto status check,"corrects matrix count to 9, corrects
make cidescription(adds
fmt, fixes order, warns about in-place rewrites)..goreleaser.yaml— header comment lists 5 archive nameswith a note about the windows/arm64 exclusion.
.github/workflows/release.yml— step-3 comment says "all 5platform binaries."
docs/release-checklist.md— "All 5 binaries attached +checksums.txt."
.github/workflows/ci.yml— renamescoverage.txt→coverage.outso CI matches the documentedmake testoutput.
CHANGELOG.md—### Fixedentry under[Unreleased]documenting the doc refresh with docs: CI/release tooling doc-accuracy batch (CoGitto check doesn't exist, 6 vs 5 binaries, make ci description, coverage filename) #69 reference.