docs(pr-review-agent): document read:org requirement for team review requests#205
Merged
Conversation
…requests The `reviewRequests.requestedReviewer` GraphQL field returns 'Resource not accessible by personal access token' when a PR has a team (not just a user) as a requested reviewer and the PAT lacks `read:org`. Previously documented only as silencing a log warning and enabling CODEOWNERS escalation — the hard prefetch failure on team-reviewer PRs was undocumented. Discovered in run #25974874120 / job #76353169023 against petry-projects/.github#302 (first PR with a team reviewer encountered since be66351 tightened prefetch error handling from silent `{}` to hard exit). Changes: - bot-setup.md: strengthen read:org description; add troubleshooting entry for the prefetch error - machine-user-setup.md: strengthen read:org description; expand Missing-token-scopes troubleshooting entry to cover both failure modes - setup.md: tighten existing scope note; add dedicated troubleshooting entry for the prefetch/reviewRequests error Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Collaborator
Author
|
No description provided. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation across several setup guides (bot-setup.md, machine-user-setup.md, and setup.md) to clarify that the read:org scope is mandatory for Personal Access Tokens when handling team-based review requests. It also adds troubleshooting sections for the specific GraphQL error encountered when this scope is missing. Feedback was provided to improve the specificity of error paths in headers and to ensure consistent casing for internal documentation links.
Collaborator
Author
|
No description provided. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates PR Review Agent setup docs to clarify that the read:org scope is a hard requirement when a PR has a team requested reviewer (to avoid GraphQL prefetch failures), and adds targeted troubleshooting guidance for the associated reviewRequests.requestedReviewer permission error.
Changes:
- Expanded
read:orgscope explanations to cover team-based review request visibility (not just CODEOWNERS escalation). - Added troubleshooting sections for
gh pr view failed during metadata prefetch/ GraphQLreviewRequestspermission errors. - Refined existing missing-scope troubleshooting to cover both warning-only and hard-failure modes.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/pr-review-agent/setup.md | Adds explicit read:org requirement language and a new troubleshooting entry for metadata prefetch failures. |
| docs/pr-review-agent/machine-user-setup.md | Strengthens read:org scope description and expands troubleshooting to explain both failure modes. |
| docs/pr-review-agent/bot-setup.md | Updates scope guidance and adds a troubleshooting entry for the reviewRequests prefetch permission error. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
Author
|
No description provided. |
Use full GraphQL error path for metadata prefetch troubleshooting and fix BOT_SETUP link target to the actual lowercase filename. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Collaborator
Author
|
No description provided. |
|
This was referenced May 16, 2026
4 tasks
don-petry
added a commit
that referenced
this pull request
Jun 7, 2026
…requests (#205) The `reviewRequests.requestedReviewer` GraphQL field returns 'Resource not accessible by personal access token' when a PR has a team (not just a user) as a requested reviewer and the PAT lacks `read:org`. Previously documented only as silencing a log warning and enabling CODEOWNERS escalation — the hard prefetch failure on team-reviewer PRs was undocumented. Discovered in run #25974874120 / job #76353169023 against petry-projects/.github#302 (first PR with a team reviewer encountered since be66351 tightened prefetch error handling from silent `{}` to hard exit). Changes: - bot-setup.md: strengthen read:org description; add troubleshooting entry for the prefetch error - machine-user-setup.md: strengthen read:org description; expand Missing-token-scopes troubleshooting entry to cover both failure modes - setup.md: tighten existing scope note; add dedicated troubleshooting entry for the prefetch/reviewRequests error Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
don-petry
added a commit
that referenced
this pull request
Jun 7, 2026
…requests (#205) The `reviewRequests.requestedReviewer` GraphQL field returns 'Resource not accessible by personal access token' when a PR has a team (not just a user) as a requested reviewer and the PAT lacks `read:org`. Previously documented only as silencing a log warning and enabling CODEOWNERS escalation — the hard prefetch failure on team-reviewer PRs was undocumented. Discovered in run #25974874120 / job #76353169023 against petry-projects/.github#302 (first PR with a team reviewer encountered since be66351 tightened prefetch error handling from silent `{}` to hard exit). Changes: - bot-setup.md: strengthen read:org description; add troubleshooting entry for the prefetch error - machine-user-setup.md: strengthen read:org description; expand Missing-token-scopes troubleshooting entry to cover both failure modes - setup.md: tighten existing scope note; add dedicated troubleshooting entry for the prefetch/reviewRequests error Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
don-petry
added a commit
that referenced
this pull request
Jun 8, 2026
…requests (#205) The `reviewRequests.requestedReviewer` GraphQL field returns 'Resource not accessible by personal access token' when a PR has a team (not just a user) as a requested reviewer and the PAT lacks `read:org`. Previously documented only as silencing a log warning and enabling CODEOWNERS escalation — the hard prefetch failure on team-reviewer PRs was undocumented. Discovered in run #25974874120 / job #76353169023 against petry-projects/.github#302 (first PR with a team reviewer encountered since be66351 tightened prefetch error handling from silent `{}` to hard exit). Changes: - bot-setup.md: strengthen read:org description; add troubleshooting entry for the prefetch error - machine-user-setup.md: strengthen read:org description; expand Missing-token-scopes troubleshooting entry to cover both failure modes - setup.md: tighten existing scope note; add dedicated troubleshooting entry for the prefetch/reviewRequests error Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
don-petry
added a commit
that referenced
this pull request
Jun 12, 2026
…requests (#205) The `reviewRequests.requestedReviewer` GraphQL field returns 'Resource not accessible by personal access token' when a PR has a team (not just a user) as a requested reviewer and the PAT lacks `read:org`. Previously documented only as silencing a log warning and enabling CODEOWNERS escalation — the hard prefetch failure on team-reviewer PRs was undocumented. Discovered in run #25974874120 / job #76353169023 against petry-projects/.github#302 (first PR with a team reviewer encountered since be66351 tightened prefetch error handling from silent `{}` to hard exit). Changes: - bot-setup.md: strengthen read:org description; add troubleshooting entry for the prefetch error - machine-user-setup.md: strengthen read:org description; expand Missing-token-scopes troubleshooting entry to cover both failure modes - setup.md: tighten existing scope note; add dedicated troubleshooting entry for the prefetch/reviewRequests error Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
don-petry
added a commit
that referenced
this pull request
Jun 14, 2026
…requests (#205) The `reviewRequests.requestedReviewer` GraphQL field returns 'Resource not accessible by personal access token' when a PR has a team (not just a user) as a requested reviewer and the PAT lacks `read:org`. Previously documented only as silencing a log warning and enabling CODEOWNERS escalation — the hard prefetch failure on team-reviewer PRs was undocumented. Discovered in run #25974874120 / job #76353169023 against petry-projects/.github#302 (first PR with a team reviewer encountered since be66351 tightened prefetch error handling from silent `{}` to hard exit). Changes: - bot-setup.md: strengthen read:org description; add troubleshooting entry for the prefetch error - machine-user-setup.md: strengthen read:org description; expand Missing-token-scopes troubleshooting entry to cover both failure modes - setup.md: tighten existing scope note; add dedicated troubleshooting entry for the prefetch/reviewRequests error Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
don-petry
added a commit
that referenced
this pull request
Jun 18, 2026
…requests (#205) The `reviewRequests.requestedReviewer` GraphQL field returns 'Resource not accessible by personal access token' when a PR has a team (not just a user) as a requested reviewer and the PAT lacks `read:org`. Previously documented only as silencing a log warning and enabling CODEOWNERS escalation — the hard prefetch failure on team-reviewer PRs was undocumented. Discovered in run #25974874120 / job #76353169023 against petry-projects/.github#302 (first PR with a team reviewer encountered since be66351 tightened prefetch error handling from silent `{}` to hard exit). Changes: - bot-setup.md: strengthen read:org description; add troubleshooting entry for the prefetch error - machine-user-setup.md: strengthen read:org description; expand Missing-token-scopes troubleshooting entry to cover both failure modes - setup.md: tighten existing scope note; add dedicated troubleshooting entry for the prefetch/reviewRequests error Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
don-petry
added a commit
that referenced
this pull request
Jun 25, 2026
…requests (#205) The `reviewRequests.requestedReviewer` GraphQL field returns 'Resource not accessible by personal access token' when a PR has a team (not just a user) as a requested reviewer and the PAT lacks `read:org`. Previously documented only as silencing a log warning and enabling CODEOWNERS escalation — the hard prefetch failure on team-reviewer PRs was undocumented. Discovered in run #25974874120 / job #76353169023 against petry-projects/.github#302 (first PR with a team reviewer encountered since be66351 tightened prefetch error handling from silent `{}` to hard exit). Changes: - bot-setup.md: strengthen read:org description; add troubleshooting entry for the prefetch error - machine-user-setup.md: strengthen read:org description; expand Missing-token-scopes troubleshooting entry to cover both failure modes - setup.md: tighten existing scope note; add dedicated troubleshooting entry for the prefetch/reviewRequests error Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
don-petry
added a commit
that referenced
this pull request
Jun 25, 2026
…requests (#205) The `reviewRequests.requestedReviewer` GraphQL field returns 'Resource not accessible by personal access token' when a PR has a team (not just a user) as a requested reviewer and the PAT lacks `read:org`. Previously documented only as silencing a log warning and enabling CODEOWNERS escalation — the hard prefetch failure on team-reviewer PRs was undocumented. Discovered in run #25974874120 / job #76353169023 against petry-projects/.github#302 (first PR with a team reviewer encountered since be66351 tightened prefetch error handling from silent `{}` to hard exit). Changes: - bot-setup.md: strengthen read:org description; add troubleshooting entry for the prefetch error - machine-user-setup.md: strengthen read:org description; expand Missing-token-scopes troubleshooting entry to cover both failure modes - setup.md: tighten existing scope note; add dedicated troubleshooting entry for the prefetch/reviewRequests error 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.
Summary
Closes the documentation gap exposed by run #25974874120 / job #76353169023.
The
reviewRequests.requestedReviewerGraphQL field returnsResource not accessible by personal access tokenwhen a PR has a team (not just a user) as a requested reviewer and the PAT lacksread:org. This was previously undocumented —read:orgwas described only as silencing a log warning and enabling CODEOWNERS escalation, not as a hard requirement for the metadata prefetch.The failure was latent since be66351c tightened prefetch error handling (silent
{}→ hard exit on May 15), and surfaced when petry-projects/.github#302 became the first team-reviewer PR encountered since then.Changes
bot-setup.mdread:orgscope description; add troubleshooting entry for the prefetch errormachine-user-setup.mdread:orgscope description; expand missing-scope troubleshooting to cover both failure modessetup.mdreviewRequestsprefetch error