fix(workflows): let docs auditors open PRs for README and AGENTS.md#1188
Merged
Conversation
doc-freshness-check and bash-lint-auditor edit AGENTS.md/README.md, but those files are in gh-aw's default protected-files set, so every patch fell back to filing an issue instead of opening a PR (regardless of allowed-files, which is an orthogonal check). Switch protected-files to the object form with an exclude list for AGENTS.md (and README.md for doc-freshness-check). The fallback-to-issue policy is preserved for all genuinely protected files (package manifests, CODEOWNERS, CHANGELOG.md, dot-folders, etc.). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Problem
The
doc-freshness-check(docs rewriter) andbash-lint-auditorworkflows are designed to editAGENTS.mdandREADME.md, but every run that touched those files filed an issue instead of opening a PR — producing a steady stream ofdocs: fix documentation driftissues (#1180, #1177, #1175, #1143, #1129, #1126, #1123, #1121, #1114, #1106, ...).Root cause
gh-aw maintains a default protected-files set that includes
README.md,AGENTS.md,CHANGELOG.md,CONTRIBUTING.md, etc.protected-filesandallowed-filesare orthogonal checks — listing a file inallowed-filesdoes not remove it from the protected set. So any patch touching README/AGENTS.md hit thefallback-to-issuepolicy.Fix
Switch
protected-filesfrom the string form to the object form with anexcludelist in the two workflows that intentionally maintain these docs:doc-freshness-check— excludesAGENTS.mdandREADME.mdbash-lint-auditor— excludesAGENTS.mdThe
fallback-to-issuepolicy is fully preserved for all genuinely protected files (package manifests,CODEOWNERS,CHANGELOG.md, dot-folders, etc.) — the issue fallback safety net is intact; it just no longer trips on the docs these workflows are explicitly designed to update.Validation
.lock.ymlfiles withgh aw compile(0 errors).protected_filesarray now omitsAGENTS.md/README.mdwhileprotected_files_policystaysfallback-to-issue.