From df22dc640bc42310316f4db359a92959061b735b Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Mon, 14 Jul 2025 08:22:29 -0700 Subject: [PATCH 1/2] Add YAML_CONFIG option to self-hosted documentation for Azure DevOps, Bitbucket, GitHub, and GitLab --- docs/self-hosted/azure-devops.md | 3 +++ docs/self-hosted/bitbucket.md | 3 +++ docs/self-hosted/github.md | 3 +++ docs/self-hosted/gitlab.md | 3 +++ 4 files changed, 12 insertions(+) diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md index a843e1a7..3f3d0e6c 100644 --- a/docs/self-hosted/azure-devops.md +++ b/docs/self-hosted/azure-devops.md @@ -127,6 +127,8 @@ LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] + +YAML_CONFIG=[] ``` :::note @@ -134,6 +136,7 @@ PERPLEXITY_API_KEY=[] - If you are using Azure OpenAI, verify that the model deployment names are in the .env file. - Values marked with [] are not optional to provide. - You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys. +- `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit's behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](/docs/getting-started/configure-coderabbit.md) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string. ::: diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md index 7e7faf2b..a46f1245 100644 --- a/docs/self-hosted/bitbucket.md +++ b/docs/self-hosted/bitbucket.md @@ -122,6 +122,8 @@ LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] + +YAML_CONFIG=[] ``` :::note @@ -129,6 +131,7 @@ PERPLEXITY_API_KEY=[] - If you are using Azure OpenAI, verify that the model deployment names are in the .env file. Values marked with [] are optional and can be omitted if the feature is not needed. - You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys. +- `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit's behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](/docs/getting-started/configure-coderabbit.md) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string. ::: diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md index 3031e45c..9e1908c6 100644 --- a/docs/self-hosted/github.md +++ b/docs/self-hosted/github.md @@ -140,6 +140,8 @@ LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] + +YAML_CONFIG=[] ``` :::note @@ -150,6 +152,7 @@ PERPLEXITY_API_KEY=[] - For `GITHUB_HOSTNAME`, use GitHub Enterprise server's hostname, for example, “github.acme-inc.com” - You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys. - When `ENABLE_LEARNINGS` is set to `true`, CodeRabbit will use `CODERABBIT_API_KEY` to store learnings on our servers. +- `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit's behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](/docs/getting-started/configure-coderabbit.md) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string. ::: diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md index cd35c19f..5b540370 100644 --- a/docs/self-hosted/gitlab.md +++ b/docs/self-hosted/gitlab.md @@ -134,6 +134,8 @@ LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] + +YAML_CONFIG=[] ``` :::note @@ -141,6 +143,7 @@ PERPLEXITY_API_KEY=[] - If you are using Azure OpenAI, verify that the model deployment names are in the .env file. - Values marked with [] are not optional to provide. - You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys. +- `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit's behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](/docs/getting-started/configure-coderabbit.md) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string. ::: From 76a3ad8be947b5e0517541ec761050a34636aee7 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Mon, 14 Jul 2025 08:51:16 -0700 Subject: [PATCH 2/2] Update YAML_CONFIG placeholder to escaped format in self-hosted documentation for Azure DevOps, Bitbucket, GitHub, and GitLab --- docs/self-hosted/azure-devops.md | 2 +- docs/self-hosted/bitbucket.md | 2 +- docs/self-hosted/github.md | 2 +- docs/self-hosted/gitlab.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md index 3f3d0e6c..c8926b0f 100644 --- a/docs/self-hosted/azure-devops.md +++ b/docs/self-hosted/azure-devops.md @@ -128,7 +128,7 @@ LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] -YAML_CONFIG=[] +YAML_CONFIG=[] ``` :::note diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md index a46f1245..bccbb251 100644 --- a/docs/self-hosted/bitbucket.md +++ b/docs/self-hosted/bitbucket.md @@ -123,7 +123,7 @@ LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] -YAML_CONFIG=[] +YAML_CONFIG=[] ``` :::note diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md index 9e1908c6..6e2b27c1 100644 --- a/docs/self-hosted/github.md +++ b/docs/self-hosted/github.md @@ -141,7 +141,7 @@ LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] -YAML_CONFIG=[] +YAML_CONFIG=[] ``` :::note diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md index 5b540370..94175bda 100644 --- a/docs/self-hosted/gitlab.md +++ b/docs/self-hosted/gitlab.md @@ -135,7 +135,7 @@ LINEAR_PAT=[] ENABLE_WEB_SEARCH=[true] PERPLEXITY_API_KEY=[] -YAML_CONFIG=[] +YAML_CONFIG=[] ``` :::note