Skip to content

docs: fix pr_reviewer.repos semantics — empty means allow-all, not allow-none #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mabry1985 merged 1 commit into from
Sep 11, 2026
Merged

docs: fix pr_reviewer.repos semantics — empty means allow-all, not allow-none #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,13 @@ finders with a Gap noted; it never fails the review.

### 4. Config

Set `pr_reviewer.repos` (the managed allowlist — the gate runs *before* any GitHub call,
so an unlisted repo never triggers a lookup on your credentials) and `github.write: true`.
Set `github.write: true`. `pr_reviewer.repos` is optional: **empty means review any repo
the GitHub App installation covers** — installing the App on a repo is already an
explicit, revocable, audited grant, so an empty list isn't "review nothing," it's
"GitHub's installation picker is the only gate" (pr-reviewer-plugin#115). Set `repos`
only when you want to review a *subset* of the installed repos; when set, it's checked
*before* any GitHub call, so an unlisted repo never triggers a lookup on your
credentials.

Everything operator-tunable reads **config first, env as fallback**, and resolves **live**
— editing `repos` or flipping a kill switch takes effect without a restart. See the
Expand Down
9 changes: 6 additions & 3 deletions protoagent.bundle.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,12 @@ config:
default_repo: ""
repos: []
# The reviewer machinery (ADR 0078 Phase C). SHADOW by default: every verdict is a
# COMMENT review. repos = the managed allowlist (webhook + sweep scope) — empty
# until the operator names them. webhook_secret is a SECRET (set via Settings; it
# lands in the untracked secrets.yaml overlay).
# COMMENT review. repos = an OPTIONAL narrowing allowlist (webhook + sweep scope) —
# EMPTY means "whatever the GitHub App installation covers", not "review nothing".
# GitHub's own installation repo-picker is the real gate; set `repos` only to
# restrict review to a subset of the installed repos (pr-reviewer-plugin#115).
# webhook_secret is a SECRET (set via Settings; it lands in the untracked
# secrets.yaml overlay).
pr_reviewer:
repos: []
shadow_mode: true
Expand Down
Loading