> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Control when reviews run

> Choose which pull requests CodeRabbit reviews automatically, and when it reviews new pushes or pauses.

CodeRabbit reviews a pull request automatically when it opens against the default branch. Automatic review controls decide which pull requests qualify, which ones to skip, and how CodeRabbit handles later pushes. You can always start a review by hand with `@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](https://docs.coderabbit.ai/pr-reviews/missing-reviews.md).

## What you can control

| Goal | Setting |
| - | - |
| Turn automatic reviews on or off | `enabled` |
| Review pull requests to branches other than the default branch | `base_branches` |
| Review draft pull requests | `drafts` |
| Review only pull requests with, or without, a label | `labels` |
| Review a pull request when its description has a keyword | `description_keyword` |
| Skip pull requests by title | `ignore_title_keywords` |
| Skip pull requests by author | `ignore_usernames` |
| Skip one pull request | `@coderabbitai ignore` in its description |
| Review each push, or only the first | `auto_incremental_review` (V3: `incremental_review`) |
| Pause after a number of reviewed commits | `auto_pause_after_reviewed_commits` (V3: `pause_after_reviewed_commits`) |

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.

| Rule | How it matches |
| - | - |
| `ignore_usernames` | Exact and case-sensitive after trimming spaces. No wildcards or regex. The skip is silent. |
| `labels` | Exact and case-sensitive. A positive label means at least one must be present. A `!` label means none may be present. |
| `ignore_title_keywords` | Case-insensitive. A keyword edge that is a letter, digit or underscore must sit on a word boundary, so `WIP` matches `wip: add login` but not `wiped cache`. A punctuation edge matches anywhere, so `docs(` matches `docs(api): fix links`. A title containing `[Snyk]` is always skipped. |
| `enabled` and `description_keyword` | With `enabled: false`, a description that contains the keyword starts a review. The keyword match is a case-sensitive substring. |
| Incremental review | Decides whether a push to an already reviewed pull request gets another review. |
| `drafts` | Draft pull requests are skipped unless this is `true`. The default is `false`. |
| `base_branches` | Each entry is a regular expression that isn't anchored, so `release` also matches `release-2`. Use `^` and `$` for an exact match, or `.*` to review pull requests to every branch. CodeRabbit adds the entries to the default branch. |

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.

| Platform | Enter | Example |
| - | - | - |
| GitHub | The account login, with its exact letter case | `dependabot[bot]` |
| GitLab | The username, not the display name | `release-bot` |
| Bitbucket Cloud | The display name exactly as shown, not the nickname, username or account ID | `Build Bot` |
| Bitbucket Data Center | The username, not the slug or display name | `build-bot` |
| Azure DevOps | The unique name, usually the sign-in email, in lowercase | `build-service@example.com` |

> [!WARNING]
>
> On Azure DevOps, CodeRabbit converts the author's unique name to lowercase but not your `ignore_usernames` entries. An entry with an uppercase letter never matches.

## 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:

```text theme={null}
@coderabbitai ignore
```

While the keyword is in the description, CodeRabbit doesn't review the pull request automatically. Commenting `@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`](https://docs.coderabbit.ai/reference/review-commands#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.

| Setting | Default | Effect |
| - | - | - |
| `auto_incremental_review` | `true` | When `false`, CodeRabbit reviews only the first open and ignores later pushes until you ask. |
| `auto_pause_after_reviewed_commits` | `5` | Pauses after that many reviewed commits since the last pause. The counter resets when the pause lifts. `0` never pauses. |

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](https://docs.coderabbit.ai/management/rate-limits.md) for how reviews are counted.

| Goal | Control |
| - | - |
| Active pull requests with many small commits | Set `auto_pause_after_reviewed_commits` to `1` or `2`, then comment `@coderabbitai review` when the pull request is ready for another pass |
| Review only pull requests that are ready | Set `enabled: false` and add a label from `labels`, such as `review-ready`, when the pull request should be reviewed |
| Skip work-in-progress, generated or automation pull requests | Add `ignore_title_keywords` or `ignore_usernames` entries |
| Stop automatic reviews entirely | Set `enabled: false`, remove positive entries from `labels`, leave `description_keyword` empty, and use manual review commands |

## Configure

> [tab] In the app
>
> 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.

> [tab] YAML V2
>
> ```yaml .coderabbit.yaml theme={null}
> reviews:
>   auto_review:
>     enabled: true
>     drafts: false
>     base_branches:
>       - "^release/.*$"
>     labels:
>       - "!wip"
>     ignore_title_keywords:
>       - "WIP"
>     ignore_usernames:
>       - "dependabot[bot]"
>     auto_incremental_review: true
>     auto_pause_after_reviewed_commits: 5
> ```

> [tab] YAML V3
>
> Early Access (This feature is in early access. Enable it by setting `early_access: true` in your `.coderabbit.yaml`, or by toggling Early Access on the web interface.)
>
> V3 is a limited preview. Adding `version: 3` doesn't give your organization access.
>
> ```yaml .coderabbit.yaml theme={null}
> version: 3
> reviews:
>   auto_review:
>     enabled: true
>     drafts: false
>     base_branches:
>       - "^release/.*$"
>     labels:
>       - "!wip"
>     incremental_review: true
>     pause_after_reviewed_commits: 5
> ```
>
> V3 has no `ignore_title_keywords` or `ignore_usernames` keys. They are owner settings that you set in the app, not in the file.

## 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](https://docs.coderabbit.ai/management/rate-limits.md).
* `ignore_usernames` skips reviews only. A listed author can still receive a seat. See [Seat assignment](https://docs.coderabbit.ai/management/seat-assignment.md).
* To skip files inside a pull request instead of the whole pull request, see [Choose which files are reviewed](https://docs.coderabbit.ai/pr-reviews/which-files.md).
* Schema V3 is a limited preview.

## Troubleshoot

* The pull request wasn't reviewed: follow [Find out why a pull request wasn't reviewed](https://docs.coderabbit.ai/pr-reviews/missing-reviews.md).
* A setting seems ignored: print the resolved configuration with [Check which configuration a review used](https://docs.coderabbit.ai/configuration/guides/check-effective-configuration.md).

**All settings:** [`reviews.auto_review` in the configuration reference](https://docs.coderabbit.ai/reference/configuration#param-reviews-auto-review). V3 keys are in the [V3 reference](https://docs.coderabbit.ai/reference/configuration-v3.md).

## What's next

> [card] [Find out why a pull request wasn't reviewed](https://docs.coderabbit.ai/pr-reviews/missing-reviews.md)
>
> Work through every reason a review is skipped.

> [card] [Choose which files are reviewed](https://docs.coderabbit.ai/pr-reviews/which-files.md)
>
> Exclude lock files, generated code and build output.

> [card] [Change settings for one pull request](https://docs.coderabbit.ai/configuration/guides/one-pull-request.md)
>
> Override settings without changing the repository configuration.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.