Auto Review Configuration

This guide explains how to enable or disable automatic code reviews in Codity at both repository and organization levels, and how these settings interact.

Overview

Codity provides flexible control over automatic code reviews through a hierarchical configuration system:

• Organization-level settings: Control auto-reviews for all repositories in an organization
• Repository-level settings: Control auto-reviews for individual repositories
• Precedence rules: Repository settings override organization settings

When Reviews Run

Under Settings → Review → When reviews run you choose the point at which Codity reviews a pull request automatically, and which pull requests it reviews. Set an organization default, then override it for individual repositories where needed.

Automatic Review Trigger

Target Branches

• All branches: every pull request is eligible for automatic review.
• Only these: list the target branches as glob patterns, such as main or release/*. Pull requests that target any other branch are not auto-reviewed.

Patterns follow these rules:

• * matches across /, so release/* also matches release/2.4/hotfix. release/** behaves the same as release/*.
• Matching is case-sensitive: main does not match Main.

Comment on Skipped Pull Requests

Comment on pull requests that are skipped is optional. When it is on, Codity posts one comment when the pull request opens, saying that auto-review was skipped for that target branch and that @codity review will review it anyway.

@codity review always overrides both the trigger and the target branches, so any pull request can still be reviewed on request.

Organization-Level Configuration

Organization-level settings allow you to control auto-reviews for all repositories within your organization at once.

Enabling Auto Reviews at Organization Level

1. Navigate to Settings → Organization Settings
2. Select the organization from the dropdown
3. Find the Auto Review section
4. Toggle "Enable Auto Reviews" to ON

When enabled at the organization level:

• All repositories in the organization will have auto-reviews enabled by default
• New repositories added to the organization will automatically have reviews enabled
• Individual repositories can still override this setting

Disabling Auto Reviews at Organization Level

1. Navigate to Settings → Organization Settings
2. Select the organization from the dropdown
3. Find the Auto Review section
4. Toggle "Enable Auto Reviews" to OFF

When disabled at the organization level:

• All repositories in the organization will have auto-reviews disabled by default
• New repositories added to the organization will have reviews disabled
• Individual repositories can still override this setting to enable reviews

Repository-Level Configuration

Repository-level settings provide granular control for individual repositories, overriding organization defaults.

Enabling Auto Reviews for a Specific Repository

1. Navigate to Repositories in the Codity dashboard
2. Find the repository you want to configure
3. Click the Settings icon next to the repository name
4. Find the Auto Review section
5. Toggle "Enable Auto Reviews" to ON

Disabling Auto Reviews for a Specific Repository

1. Navigate to Repositories in the Codity dashboard
2. Find the repository you want to configure
3. Click the Settings icon next to the repository name
4. Find the Auto Review section
5. Toggle "Enable Auto Reviews" to OFF

Repository-Level Configuration Options

Repository settings can include:

• Auto-review status: Enable or disable reviews for this specific repository
• Custom review instructions: Override organization defaults with repo-specific guidelines
• File/folder exclusions: Exclude certain paths from automatic review
• Custom triggers: Override organization trigger settings
• Reviewer assignment: Configure specific reviewers for this repository

VCS-Level Controls (PR Titles and Topics)

In addition to dashboard settings, Codity provides lightweight controls directly within your version control system using PR/MR titles, descriptions, labels and repository topics.

PR/MR Title Tags

You can disable auto-review for individual pull requests or merge requests by adding a special tag to the PR/MR title.

Using the [codity:disabled] Tag

Add [codity:disabled] anywhere in your PR/MR title to skip automatic review for that specific PR/MR.

Examples:

• [codity:disabled] WIP: Refactoring authentication
• Fix login bug [codity:disabled]
• [CODITY:DISABLED] Experimental feature (case-insensitive)

When you use this tag:

• Codity will skip automatic review for this PR/MR
• A comment will be posted explaining that auto-review was skipped
• You can still trigger a manual review using @codity review command
• The tag is detected automatically when the PR/MR is opened or updated

Supported Platforms:

• ✅ GitHub
• ✅ GitLab
• ✅ Azure DevOps
• ✅ Bitbucket

Example Comment Posted by Codity:

⚠️ Auto-review skipped: PR title contains [codity:disabled]: '[codity:disabled] WIP feature'

This repository is configured for manual reviews only for this PR.
To enable automatic reviews, remove the [codity:disabled] tag from the PR title.

You can trigger a manual review by commenting @codity review.

PR/MR Description Tag

You can skip automatic review for an individual pull request or merge request by adding [skip-codity-review] to its description.

PR/MR Labels

You can disable auto-review for individual pull requests or merge requests by adding the codity-disabled label.

How to use:

1. Open the PR/MR where you want to skip auto-review
2. Add the label: codity-disabled
3. Codity will skip automatic review for this PR/MR

Supported Platforms:

• GitHub
• GitLab

When you use this label:

• Codity will skip automatic review for this PR/MR
• A comment will be posted explaining that auto-review was skipped
• You can still trigger a manual review using @codity review command
• Removing the label and pushing a new commit will re-enable auto-review

Repository Topics

You can disable auto-review for all PRs/MRs in a repository by adding a special topic to the repository.

Using the codity-disabled Topic

Add codity-disabled as a repository topic to disable auto-review for the entire repository.

GitHub:

1. Go to your repository on GitHub
2. Click Settings → Topics (or the gear icon next to "About")
3. Add topic: codity-disabled
4. Save changes

GitLab:

1. Go to your project on GitLab
2. Click Settings → General
3. Under "Project description", add topic: codity-disabled
4. Save changes

When you use this topic:

• All PRs/MRs in the repository will skip automatic review
• A comment will be posted on each PR/MR explaining the skip reason
• You can still trigger manual reviews using @codity review command
• New PRs/MRs will automatically skip until the topic is removed

Using the @codity review Command

Comment @codity review on any PR/MR to force a manual review, regardless of settings.

How to use:

1. Open the PR/MR where you want a review
2. Add a comment: @codity review
3. Codity will trigger a review immediately

This works when:

• Auto-review is disabled via dashboard settings
• PR title contains [codity:disabled] tag
• Repository has codity-disabled topic
• Any combination of the above

Example:

# In a PR with auto-review disabled
User: @codity review
Codity: ✓ Manual review triggered. Analysis in progress...

Settings Precedence

Codity uses a hierarchical precedence system to determine whether to run automatic reviews. The system evaluates multiple configuration sources in a specific order.

Complete Precedence Order (Highest to Lowest)

1. @codity review command (highest priority - always triggers review)
2. PR/MR title tag [codity:disabled] (skips auto-review for this PR/MR only)
3. PR/MR label codity-disabled (skips auto-review for this PR/MR only: GitHub and GitLab)
4. Repository topic codity-disabled (skips auto-review for all PRs/MRs in repo)
5. Repository-level dashboard settings (enable/disable via dashboard)
6. Organization-level dashboard settings (default for all repos in org)
7. System defaults (lowest priority - enabled by default)