@coderabbitai review or @coderabbitai full review, whatever you set here.
If a pull request didnât get a review and you want to know why, see Find out why a pull request wasnât reviewed.
What you can control
The keys sit under
reviews.auto_review. The ignore keyword is text in the pull request description, not a setting.
How CodeRabbit decides
CodeRabbit checks the rules below in this order for each event. The defaults review every pull request that targets the default branch, except drafts.
A positive entry in
labels starts a review even when enabled is false. Use this for label-driven opt-in: turn automatic reviews off, then add a label such as review-ready when a pull request is ready. A list with only ! labels filters pull requests but never opts one in.
What to enter in ignore_usernames
Each platform identifies the author by a different name. An entry that doesnât match it exactly does nothing, so this filter doesnât skip the pull request.
Skip one pull request
To skip one pull request without changing the configuration, add the ignore keyword anywhere in its description, in any letter case:@coderabbitai review or @coderabbitai full review still starts a review. On GitHub.com, re-requesting a review from CodeRabbit starts a full review too. Remove the keyword to let automatic reviews run again, unless another rule, such as ignore_usernames, still skips the pull request.
Posted as a comment instead, @coderabbitai ignore pauses reviews. See pause.
Review new pushes
By default, CodeRabbit reviews each push to a reviewed pull request, looking at the commits added since the last review. After a set number of reviewed commits it pauses automatic reviews. Comment@coderabbitai resume to continue, or @coderabbitai review for a single review.
A pull request that a positive label opted in follows
auto_incremental_review too. With enabled: false and auto_incremental_review: false, later pushes arenât reviewed while the label stays.
Spend fewer reviews
To spend reviews only when a pull request is ready for feedback, combine these controls. See Review rate limits for how reviews are counted.Configure
- In the app
- YAML V2
- YAML V3
Open Review settings, choose Organization defaults or a repository, and set View mode to All Settings. Go to Reviews > Auto review, set the fields, then select Apply changes and confirm.
Limits and availability
- Automatic review controls work on every Git platform.
- Automatic incremental reviews count toward the same per-developer rate limit as manual reviews. With
auto_pause_after_reviewed_commits: 0, an active branch can use its allowance quickly. See Review rate limits. ignore_usernamesskips reviews only. A listed author can still receive a seat. See Seat assignment.- To skip files inside a pull request instead of the whole pull request, see Choose which files are reviewed.
- Schema V3 is a limited preview.
Troubleshoot
- The pull request wasnât reviewed: follow Find out why a pull request wasnât reviewed.
- A setting seems ignored: print the resolved configuration with Check which configuration a review used.
reviews.auto_review in the configuration reference. V3 keys are in the V3 reference.
Whatâs next
Find out why a pull request wasn't reviewed
Work through every reason a review is skipped.
Choose which files are reviewed
Exclude lock files, generated code and build output.
Change settings for one pull request
Override settings without changing the repository configuration.