Content-Length: 3794 | pFad | http://github.com/coderabbitai/coderabbit-docs/pull/443.patch

thub.com From 88f980666d0c2fdffe1473db620a440d881630cd Mon Sep 17 00:00:00 2001 From: alex Date: Fri, 11 Jul 2025 15:34:40 -0400 Subject: [PATCH 1/2] add note on config priority --- docs/guides/configuration-overview.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/guides/configuration-overview.md b/docs/guides/configuration-overview.md index 2a0dce54..a59a7ae4 100644 --- a/docs/guides/configuration-overview.md +++ b/docs/guides/configuration-overview.md @@ -46,6 +46,28 @@ For more information, see [Set your repository preferences](/guides/repository-s While the web interface provides and easier way to explore the available configuration options for your repository, we recommend using a `.coderabbit.yaml` file [as a best practice](/guides/setup-best-practices#yaml). +## Configuration priority {#priority} + +CodeRabbit follows a specific hierarchy when determining which configuration settings to use. Understanding this priority system helps you manage your configuration effectively: + +### Priority order (highest to lowest) + +1. **Local `.coderabbit.yaml` file of head branch** +2. **Repository settings** (web UI) +3. **Organization settings** (web UI) + +### How priority works + +- **If you have a local `.coderabbit.yaml` file in your source or head branch**: All repository and organization settings are ignored. Only the local YAML file configuration is used. Anything not defined in that file uses default settings. +- **If you don't have a local YAML file but have enabled repository settings**: Organization settings are ignored. Only repository settings are used. +- **If you have organization settings and repository settings are disabled**: Only organization settings are used. + +### Configuration inheritance + +When a configuration source is active, it completely overrides all lower-priority sources. For example, if you set `reviews.tools.github-checks.timeout_ms` to `900000` in organization settings, but you have a local `.coderabbit.yaml` file that doesn't define this setting, CodeRabbit will use the default value of `90000` instead of the organization setting. + +This means that configuration is not merged or inherited - the highest priority source takes complete control over all settings. + ## Initial configuration {#initial} The [Initial configuration guide](/guides/initial-configuration) tours you through several settings that we From af661134ae145851901d1adae6b37f0127c26ec8 Mon Sep 17 00:00:00 2001 From: alex Date: Fri, 11 Jul 2025 15:35:50 -0400 Subject: [PATCH 2/2] fix --- docs/guides/configuration-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/configuration-overview.md b/docs/guides/configuration-overview.md index a59a7ae4..b2c401f2 100644 --- a/docs/guides/configuration-overview.md +++ b/docs/guides/configuration-overview.md @@ -58,7 +58,7 @@ CodeRabbit follows a specific hierarchy when determining which configuration set ### How priority works -- **If you have a local `.coderabbit.yaml` file in your source or head branch**: All repository and organization settings are ignored. Only the local YAML file configuration is used. Anything not defined in that file uses default settings. +- **If you have a local `.coderabbit.yaml` file in your head branch**: All repository and organization settings are ignored. Only the local YAML file configuration is used. Anything not defined in that file uses default settings. - **If you don't have a local YAML file but have enabled repository settings**: Organization settings are ignored. Only repository settings are used. - **If you have organization settings and repository settings are disabled**: Only organization settings are used.

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!