Skip to main content
The settings map connects common settings across the places you meet them: the YAML V2 key, the label you see in the web interface, the YAML V3 key, the feature page that explains the setting, and the entry in the configuration reference. Search for a key or a label, then follow the links. The map covers the settings people look up most. For every key, see the V2 reference and the V3 reference. For every V2 key and its V3 location, see Map V2 keys to V3.

How to read the map

Schema V3 is a limited preview. A V2 key that moved in V3 shows its new path. A V2 key that V3 fixes to a value, or keeps outside the file, says so in the V3 column.

Settings in the web interface

Each row links to the reference entry for the key in both schemas. Section paths follow the settings index: flat fields at the top of the file appear in General, flat fields under reviews appear in Reviews > General, and most objects under reviews, such as auto_review, have their own page. reviews.auto_approvals is an exception: it’s a section of Reviews > General.

Compare a setting in V2 and V3

Most V2 keys move to a new path in V3: review behavior goes under reviews.behavior, comment output under reviews.output, and personality settings under fun. A few V2 keys have no V3 key. V3 fixes reviews.poem and reviews.sequence_diagrams off and chat.auto_reply on, and keeps settings such as knowledge_base outside the file. Map V2 keys to V3 lists every key.

Settings that live outside YAML

With V3, these V2 settings have no key in the file. For a repository in the preview, set them under the same keys in the Preferences YAML editor on the repository’s V3 preferences page, in the settings index:
  • early_access
  • knowledge_base
  • chat.integrations
  • reviews.finishing_touches and reviews.post_merge_actions
  • code_generation
  • issue_enrichment
  • reviews.auto_review.ignore_title_keywords and reviews.auto_review.ignore_usernames
Review instructions and custom checks move out of YAML into Markdown files: reviews.path_instructions becomes .coderabbit/instructions/, and reviews.pre_merge_checks.custom_checks becomes .coderabbit/pre-merge-checks/. On GitHub Cloud, these documents also work with V2. See Instruction and check documents.

What’s next

Configuration reference

Every V2 key with its type, default and description.

Configuration reference V3

Every V3 key. V3 is a limited preview.

Tools reference

The settings for each review tool.