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 underreviews.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.
- YAML V2
- YAML V3
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_accessknowledge_basechat.integrationsreviews.finishing_touchesandreviews.post_merge_actionscode_generationissue_enrichmentreviews.auto_review.ignore_title_keywordsandreviews.auto_review.ignore_usernames
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.