Configure CodeRabbit

CodeRabbit offers various configuration options to tailor the reviews to your requirements. Configuration can be made using one of the below options, in order of precedence:

1. Configure using CodeRabbit YAML file
2. Configure using CodeRabbit UI for each repository
3. Configure using CodeRabbit UI for the organization

In this guide, we will cover the configuration using a YAML file.

Configure CodeRabbit using a YAML File

You can add a .coderabbit.yaml configuration file to the root of your repositories. Below is a sample YAML file that can be used as a starting point and changed as needed:

version 2: Current

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
early_access: false
reviews:
  profile: "chill"
  request_changes_workflow: false
  high_level_summary: true
  poem: true
  review_status: true
  collapse_walkthrough: false
  auto_review:
    enabled: true
    drafts: false
chat:
  auto_reply: true

YAML settings:

1. language: Set the language for reviews using the ISO language code. For example, "ja" configures reviews in Japanese.

2. tone_instructions: Set the tone for the reviews and the chat. Example: 'You must use talk like Mr. T. I pity the fool who doesn't!'

3. early_access: Enroll in the early access program to take advantage of forthcoming features before their general release (default:false).

4. enable_free_tier: Enable the free tier features for users who are not subscribed to a paid plan (default:true).

5. reviews: Configures review settings.

   • profile: Select the reviewer profile between assertive and chill. The assertive profile posts more comments and nitpicks the code more aggressively, while the chill profile is more relaxed and posts fewer comments (default: chill).

   • request_changes_workflow: Enable request changes review workflow for CodeRabbit reviews (default: false).

   • high_level_summary: CodeRabbit generates a high-level summary of the changes in the PR/MR description (default:true).

   • high_level_summary_placeholder: Placeholder in the PR/MR description that gets replaced with the high-level summary (default:@coderabbitai summary).

   • auto_title_placeholder: Placeholder in the PR/MR title that gets replaced with an auto-generated title (default:@coderabbitai title).

   • poem: Indicates whether a creative poem should be included in the review (default:true).

   • review_status: Include a review status when a review is skipped in certain cases (default:true).

   • collapse_walkthrough: Collapses the walkthrough comment (default:false).

   • path_filters: Specifies file patterns to exclude or include for a review, such as !dist/** and src/**.tsx, using glob notation. Example:

     reviews:
       path_filters:
         - "!**/*.xml"
         - "!**/generated/**"

   • path_instructions: Provides specific additional guidelines for code review based on file paths. In the given example, JavaScript files are singled out for checks against the Google JavaScript style guide. File path accepts glob pattern. Example:

     reviews:
       path_instructions:
         - path: "**/*.js"
           instructions:
             "Review the JavaScript code for conformity with the Google
             JavaScript style guide, highlighting any deviations."
         - path: "tests/**/*"
           instructions:
             "Assess the unit test code employing the Mocha testing framework.
             Test descriptions must be sufficiently detailed to clarify the
             purpose of each test."

   • auto_review: Manages settings for automatic code reviews.

     • enabled: Automatic code review (default: true).
     • auto_incremental_review: Automatic incremental code review(s) on each push (default: true).
     • ignore_title_keywords: Review will be ignored if a pull request title contains one of the list of keywords (case-insensitive).
     • labels: Review will be triggered if a pull request matches one of the list of labels (case-insensitive).
     • drafts: Determines whether draft pull requests are reviewed (default: true).
     • base_branches: A list of base branches for which the reviews will trigger, apart from the default branch. Accepts regex pattern. Example:

     reviews:
       auto_review:
         base_branches:
           - develop
           - feat/.*

   • tools: Configures external tools integration settings.

     • ast-grep: Configuration for ast-grep integration.

       • rule_dirs: The directory name where the custom ast-grep rules are stored.
       • util_dirs: The directory name where the custom ast-grep utils are stored.
       • essential_rules: Enable the ast-grep-essentials package, which contains community-driven security and best practice rules. Defaults to true.
       • packages: A package allows you to share rules across multiple projects. Essentially, a package is a collection of ast-grep rules.

     • github-checks: Configuration for GitHub Checks integration.

       • enabled: Enable integration, defaults to true.
       • timeout_ms: Time in milliseconds to wait for all GitHub Checks to conclude, defaults to 90000 (1.5 minutes), maximum is 300000 (5 minutes), minimum is 0 (no timeout).

     • markdownlint: Configuration for markdownlint integration.

       • enabled: Enable integration, defaults to true.

     • ruff: Configuration for ruff integration.

       • enabled: Enable integration, defaults to true.

     • shellcheck: Configuration for shellcheck integration.

       • enabled: Enable integration, defaults to true.

     • biome: Configuration for biome integration.

       • enabled: Enable integration, defaults to true.

     • hadolint: Configuration for hadolint integration.

       • enabled: Enable integration, defaults to true.

     • languagetool: Configuration for languagetool integration.

       • enabled: Enable integration, defaults to true.
       • level: The level of the rule. It can be one default or picky. If set to picky, additional rules will be activated, i.e. rules that you might only find useful when checking formal text.
       • enabled_rules: IDs of rules to be enabled. The rule won't run unless 'level' is set to a level that activates the rule.
       • disabled_rules: IDs of rules to be disabled.
       • enabled_categories: IDs of categories to be enabled.
       • disabled_categories: IDs of categories to be disabled.
       • enabled_only: Only the rules and categories whose IDs are specified with enabled_rules or enabled_categories are enabled.

       reviews:
         tools:
           ast-grep:
             rule_dirs:
               - "rules"
             util_dirs:
               - "utils"
             essential_rules: true
             packages:
               - "my-awesome-org/my-awesome-package" # public GitHub repository that contains ast-grep rules
           github-checks:
             enabled: true
             timeout_ms: 90000
           markdownlint:
             enabled: true
           ruff:
             enabled: true
           shellcheck:
             enabled: true
           biome:
             enabled: true
           hadolint:
             enabled: true
           languagetool:
             enabled: true
             enabled_only: false
             level: default
             enabled_categories:
               - "TON_ACADEMIC"
               - "CASING"

6. knowledge_base: Configures knowledge base settings.

   • learnings: Configures learnings settings.
     • scope: Specify the scope of learnings to use for the knowledge base. local uses the repository's learnings, global uses the organization's learnings, and auto uses repository's learnings for public repositories and organization's learnings for private repositories. Default is auto.
   • issues: Configures issues settings.
     • scope: Specify the scope of git platform (GitHub/GitLab) issues to use for the knowledge base. local uses the repository's issues, global uses the organization's issues, and auto uses repository's issues for public repositories and organization's issues for private repositories. Default is auto.
   • jira: Configures Jira settings.
     • project_keys: A list of Jira project keys to use for the knowledge base. If not provided, all projects will be used.
   • linear: Configures Linear settings.
     • team_keys: A list of Linear team keys to use for the knowledge base. If not provided, all teams will be used.

7. chat: Defines the behavior of CodeRabbit's bot in conversations.

   • auto_reply: The bot automatically replies without the need of the user tagging it (default: true).

Refer: CodeRabbit Configuration Schema.

Please note that code reviews commence with new pull requests or incremental commits to existing pull requests once the CodeRabbit app is installed. Should you have any questions or require assistance, our support team is here to help.