docs: Clarify GitHub status checks for AI Code Review #15679
+63
−4
Conversation
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
- Add GitHub Permissions section explaining required permissions (Pull Requests, Checks, Commit Statuses) - Add comprehensive GitHub Status Checks section covering: - Status check behavior (pass/neutral/fail states) - Visibility information for repository users - Instructions for integrating with branch protection rules - Add three new FAQ entries about status checks: - Why status checks fail - How to disable status checks - Update GitHub integration docs to reference AI Code Review in permissions table Fixes: https://linear.app/getsentry/issue/CW-11
|
Someone is attempting to deploy a commit to the Sentry Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
|
||
| - **Pull Requests (Read & Write)**: To read PR content and write code review comments | ||
| - **Checks (Read & Write)**: To create status checks that show the AI Code Review results on your PRs | ||
| - **Commit Statuses (Read & Write)**: To post status checks to commits and integrate with branch protection rules |
There was a problem hiding this comment.
I think we don't need this one. We use this endpoint and it lists "Checks" repository permissions (write)
Let's check other endpoints used:
- https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28#create-a-check-run
- https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28#list-check-runs-for-a-git-reference
Looks like they all are for the checks:write
| - **Why is the AI Code Review status check failing?** | ||
|
|
||
| The status check may fail if: | ||
| - The `Show Generative AI Features` or `Enable AI Code Review` settings are not enabled in your organization |
There was a problem hiding this comment.
Can we discuss this behavior? Sounds odd to me that you don't give permission for Code Review and we have the audacity to create a status check for it.
On requesting explicit review I'd really encourage is to only reply with the comment
|
|
||
| The status check may fail if: | ||
| - The `Show Generative AI Features` or `Enable AI Code Review` settings are not enabled in your organization | ||
| - The GitHub integration doesn't have the required permissions (Pull Requests, Checks, and Commit Statuses) |
There was a problem hiding this comment.
Well if it doesn't have Checks then you won't see a status check, right? per definition
- Change 'regular PR comments' to 'review comments' - Fix status check name to 'Seer Code Review' (not 'Sentry AI Code Review') - Update recommendation to NOT make status check required - Update status check behavior to include all states: success, neutral, error, cancelled, timed_out - Clarify that success indicates review completed, not code quality - Rewrite FAQ about failing status checks to be more accurate
giovanni-guidini
approved these changes
Dec 3, 2025
sfanahata
reviewed
Dec 3, 2025
| 5. Save your changes | ||
|
|
||
| <Alert level="warning"> | ||
| We recommend not making the AI Code Review status check a required check. Requiring it will block PR merges if the check fails due to service disruptions, and may conflict with future personal configuration options that allow users to opt out of code review. |
Contributor
There was a problem hiding this comment.
Suggested change
| We recommend not making the AI Code Review status check a required check. Requiring it will block PR merges if the check fails due to service disruptions, and may conflict with future personal configuration options that allow users to opt out of code review. | |
| We recommend making the AI Code Review status check an **optional** check. Requiring it will block PR merges if the check fails due to service disruptions, and may conflict with future personal configuration options that allow users to opt out of code review. |
sfanahata
approved these changes
Dec 3, 2025
Contributor
sfanahata
left a comment
sfanahata
left a comment
There was a problem hiding this comment.
Couple of nits, but looks good whenever you're ready.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Fixes: https://linear.app/getsentry/issue/CW-11
DESCRIBE YOUR PR
Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES