Auto Review Configuration

Choose when connected repositories receive automatic reviews. These settings do not install an integration or enable a disconnected repository.

Overview

Open Settings → Review → When reviews run. Set the active account's default, then use Repository Overrides for exceptions. Account and team selection affect which repositories are offered.

When Reviews Run

Automatic Review Trigger

Use Automatic Review Trigger:

Option Behavior
Off Eligible changes are not automatically reviewed.
On PR open Review on opening; later events can update merge status without an every-commit full review.
On every commit Review opening and new commits, subject to incremental-review handling and applicable skips.

Target Branches

Choose All branches or Only these and supply target-branch patterns. These are the branches a PR/MR targets, not the source branch. Matching is case-sensitive; * can span /, so release/* also matches nested release paths.

For example, with Only these set to main and release/*:

Source branch Target branch Matches branch scope?
feature/login main Yes
fix/payment release/2.4 Yes
fix/payment release/2.4/hotfix Yes
main develop No
feature/login Main No

A branch match makes a change eligible for the selected automatic trigger; it does not bypass opt-out markers, usage checks or other review eligibility rules.

Comment on Skipped Pull Requests

The optional skipped-branch comment explains why automatic review did not run. Use @codity review on the PR/MR to request a review explicitly; repository access, service availability and usage restrictions still apply.

Organization-Level Configuration

On Settings → Review, change the account default in Automatic Review Trigger, branch scope and skipped-comment controls. Check each save/error state. There is no separate “Organization Settings” page required for this flow.

Repository-Level Configuration

Expand Repository Overrides, find an accessible repository and set its trigger/branch overrides. An inherited value follows the account default; an explicit repository value overrides it. Check the active account and team if the repository is missing.

Example: Review Releases More Often

Suppose most repositories need one review when a PR opens, while a payment service needs review on subsequent pushes:

  1. Select the intended account and open Settings → Review → When reviews run.
  2. Set the account's Automatic Review Trigger to On PR open.
  3. Set the account branch scope to Only these and include main and release/*.
  4. Expand Repository Overrides and find the payment-service repository.
  5. Give it an explicit On every commit trigger. Leave its branch setting inherited if the account's branch scope is appropriate.
  6. Check the save result, then test an eligible PR and a subsequent code push.

Other repositories following the account default still use On PR open. The payment service uses its explicit trigger and the inherited target-branch scope. Incremental re-review handling can narrow or skip work on a later push.

Example: Keep One Repository Manual

Set that repository's trigger override to Off. This stops its automatic reviews while allowing other repositories to follow the account default. Comment @codity review on a permitted PR/MR when you need an explicit review. Restore inheritance when the repository should follow future account-default changes again.

VCS-Level Controls (PR Titles and Topics)

The review pipeline also recognizes opt-out markers, including [codity:disabled] in a PR/MR title, [skip-codity-review] in a description and supported codity-disabled labels/topics. Provider support varies by marker. An explicit @codity review request can override automatic-review skips, while authorization and usage checks remain in force.

Opt-Out Examples

  • For a GitHub or GitLab PR/MR, a title such as [codity:disabled] WIP: authentication migration can suppress automatic review. The ingress also recognizes the [codity-disabled] spelling. Check the provider's reported skip reason when diagnosing a marker.
  • Put [skip-codity-review] in the PR/MR description when the provider workflow supports that description marker.
  • GitHub and GitLab support the codity-disabled PR/MR label. Repository-topic handling is provider-specific; do not assume a PR label and a repository topic have the same scope.

For an explicit review, post this as its own PR/MR comment:

@codity review

Removing an opt-out marker does not prove a new review started. Check the next eligible event or request a manual review and inspect the result. Avoid using a skip marker as an access-control mechanism.

Settings Precedence

An explicit manual review request overrides automatic trigger/branch skips. Otherwise repository overrides apply before account defaults; provider opt-out markers can suppress automatic review. Incremental logic may skip or narrow work when there is no new reviewable code. See Incremental Re-reviews.

To verify a change, open an eligible test PR/MR and inspect actual review activity. A webhook delivery alone does not establish that the change passed trigger or usage checks.

Precedence Examples

Account trigger Repository trigger Expected automatic behavior
On PR open Inherited Review on opening, subject to branch scope and eligibility.
On PR open On every commit Opening and new-code pushes are eligible, subject to incremental handling.
On every commit Off No automatic review for that repository.
Off On PR open That repository can review on opening despite the account default.

Branch overrides are resolved separately from the trigger. A trigger override does not automatically clear an inherited branch restriction.

Troubleshooting

Symptom What to check
No review when a PR opens Confirm the repository is enabled, resolve account/repository trigger settings, check the target branch and opt-out markers, then inspect provider delivery and usage errors.
A push does not receive a full review Check whether the effective trigger is On PR open. For On every commit, inspect incremental handling and whether there is new reviewable code.
One repository behaves differently Inspect explicit trigger and branch overrides before changing the account default.
A repository is missing from overrides Check the active provider account, selected team and repository connection.
A manual request fails Verify the exact command, repository authorization, usage availability and returned status. Manual review does not grant missing access.