Skip to content

docs: correct AGENTS.md CI-validation claim (ruleset injects validate-go-project)#99

Merged
devantler merged 1 commit into
mainfrom
claude/docs-agents-ci-validation-accuracy
Jun 9, 2026
Merged

docs: correct AGENTS.md CI-validation claim (ruleset injects validate-go-project)#99
devantler merged 1 commit into
mainfrom
claude/docs-agents-ci-validation-accuracy

Conversation

@devantler

Copy link
Copy Markdown
Contributor

🤖 Generated by the Daily AI Assistant

Problem

AGENTS.md twice claimed CI does not verify the scaffold:

  • Validation section: "…CI runs only a required-checks aggregator and the release pipeline runs GoReleaser, so neither executes these commands — run them locally"
  • Maintenance section: "…CI itself only runs a required-checks aggregator, so run these yourself before opening a PR."

Both are inaccurate. CI genuinely builds/tests/lints the scaffold — and this exact wrong premise is what lured a prior run into filing #76 ("wire the shared validate-go-project workflow so CI actually verifies the scaffold"), which was closed as invalid: wiring it into ci.yaml would double-run every job because the workflow already runs via a repository ruleset.

Ground truth (verified live, 2026-06-09)

A repository ruleset "Require workflows to pass before merging for Go" (active) injects devantler-tech/reusable-workflows/.github/workflows/validate-go-project.yaml@main on every PR + merge queue. On PR #98 the ✅ Validate Go Project workflow ran (🔍 Detect Changes, 🧹 Lint - mega-linter = SUCCESS; 🏗️ Build/🧪 Test/golangci-lint/Dead Code/Coverage SKIPPED only because #98 was an actions-only bump — change-detection correctly gates the Go jobs to Go-touching PRs). The repo's own ci.yaml CI - Required Checks aggregator (empty job-results) is a separate, trivially-passing status check — not the Go gate.

So the README (which advertises golangci-lint/MegaLinter/coverage "in CI") was right all along; only AGENTS.md contradicted reality.

Fix (docs-only, AGENTS.md only)

  • Validation: drop the false "CI runs only an aggregator" parenthetical; add a paragraph stating CI does verify the scaffold via the ruleset-injected validate-go-project (build/test/golangci-lint/dead-code/MegaLinter/coverage), that ci.yaml is a separate trivially-passing aggregator, and an explicit don't wire validate-go-project into ci.yaml (double-run; see ci: wire the shared validate-go-project workflow so CI actually verifies the scaffold #76 closed-invalid) note.
  • Maintenance → Validate before any PR: reframe the local commands as fast-feedback (not "because CI skips them") and cross-reference the Validation note.

No ci.yaml/workflow change — this PR only makes the agent file match live CI, so a future agent reading it won't re-derive the #76 misstep.

Why it matters

Agent/instruction files are a maintained product: a wrong one silently misleads every future agent and reviewer. This is a recurring trap (the #76 re-proposal premise) closed at the source.

Size: XS (docs-only).

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown

MegaLinter analysis: Success

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ ACTION actionlint 6 0 0 0.27s
✅ ACTION zizmor 6 0 0 0 1.05s
✅ BASH bash-exec 1 0 0 0.01s
✅ BASH shellcheck 1 0 0 0.02s
✅ BASH shfmt 1 0 0 0 0.03s
✅ COPYPASTE jscpd yes no no 0.93s
✅ EDITORCONFIG editorconfig-checker 29 0 0 0.06s
✅ GO golangci-lint yes yes no no 19.51s
✅ JSON jsonlint 1 0 0 0.44s
✅ JSON prettier 1 0 0 0 0.59s
✅ JSON v8r 1 0 0 2.26s
✅ MARKDOWN markdownlint 5 0 0 0 0.93s
✅ MARKDOWN markdown-table-formatter 5 0 0 0 0.26s
✅ REPOSITORY checkov yes no no 26.92s
✅ REPOSITORY gitleaks yes no no 0.2s
✅ REPOSITORY git_diff yes no no 0.02s
✅ REPOSITORY grype yes no no 57.29s
✅ REPOSITORY osv-scanner yes no no 1.72s
✅ REPOSITORY secretlint yes no no 0.93s
✅ REPOSITORY syft yes no no 2.2s
✅ REPOSITORY trivy yes no no 11.07s
✅ REPOSITORY trivy-sbom yes no no 0.21s
✅ REPOSITORY trufflehog yes no no 2.85s
✅ SPELL lychee 16 0 0 0.87s
✅ YAML prettier 10 0 0 0 0.81s
✅ YAML v8r 10 0 0 12.23s
✅ YAML yamllint 10 0 0 0.7s

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@devantler devantler marked this pull request as ready for review June 9, 2026 00:35
@devantler devantler merged commit 86953d8 into main Jun 9, 2026
17 checks passed
@devantler devantler deleted the claude/docs-agents-ci-validation-accuracy branch June 9, 2026 01:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant