From de846148245d76eaa97b582bf8611b0df5a0ee22 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Sat, 19 Oct 2024 08:36:32 -0700 Subject: [PATCH 1/4] add self-hosted section and update category positions --- docs/configure-coderabbit.md | 4 +- docs/faq.md | 2 +- docs/guides/_category_.yml | 2 +- docs/integrations/_category_.yml | 2 +- docs/platforms/_category_.yaml | 2 +- docs/self-hosted/_category_.yaml | 4 + docs/self-hosted/azure-devops.md | 118 +++++++++++++++++++++++++ docs/self-hosted/github.md | 143 +++++++++++++++++++++++++++++++ docs/self-hosted/gitlab.md | 126 +++++++++++++++++++++++++++ docs/tools/_category_.yml | 2 +- 10 files changed, 398 insertions(+), 7 deletions(-) create mode 100644 docs/self-hosted/_category_.yaml create mode 100644 docs/self-hosted/azure-devops.md create mode 100644 docs/self-hosted/github.md create mode 100644 docs/self-hosted/gitlab.md diff --git a/docs/configure-coderabbit.md b/docs/configure-coderabbit.md index a4cec308..39ae2442 100644 --- a/docs/configure-coderabbit.md +++ b/docs/configure-coderabbit.md @@ -5,7 +5,7 @@ description: CodeRabbit offers various configuration options to tailor the reviews to your specific requirements. Configuration can be made using one of the below options. -sidebar_position: 3 +sidebar_position: 4 --- ```mdx-code-block @@ -47,7 +47,7 @@ Write your configuration file in the below editor to validate: :::note -`.coderabit.yaml` configuration file should exist in the feature branch for CodeRabbit review. +`.coderabit.yaml` configuration file should exist in the feature branch for CodeRabbit review. ::: diff --git a/docs/faq.md b/docs/faq.md index f71f14f6..279ab45f 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,7 +2,7 @@ title: FAQs sidebar_label: FAQs description: Frequently asked questions about CodeRabbit. -sidebar_position: 8 +sidebar_position: 9 --- ### General diff --git a/docs/guides/_category_.yml b/docs/guides/_category_.yml index 674b49ba..6f708227 100644 --- a/docs/guides/_category_.yml +++ b/docs/guides/_category_.yml @@ -1,4 +1,4 @@ label: Guides -position: 6 +position: 7 collapsible: true collapsed: true diff --git a/docs/integrations/_category_.yml b/docs/integrations/_category_.yml index 1b85855e..54e65b06 100644 --- a/docs/integrations/_category_.yml +++ b/docs/integrations/_category_.yml @@ -1,4 +1,4 @@ label: Integrations -position: 7 +position: 8 collapsible: true collapsed: true diff --git a/docs/platforms/_category_.yaml b/docs/platforms/_category_.yaml index 32fe7bb9..31e215f7 100644 --- a/docs/platforms/_category_.yaml +++ b/docs/platforms/_category_.yaml @@ -1,4 +1,4 @@ label: Supported Git Platforms -position: 5 +position: 6 collapsible: true collapsed: true diff --git a/docs/self-hosted/_category_.yaml b/docs/self-hosted/_category_.yaml new file mode 100644 index 00000000..f965af15 --- /dev/null +++ b/docs/self-hosted/_category_.yaml @@ -0,0 +1,4 @@ +label: Self-Hosted CodeRabbit +position: 3 +collapsible: true +collapsed: true diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md new file mode 100644 index 00000000..983bd9f2 --- /dev/null +++ b/docs/self-hosted/azure-devops.md @@ -0,0 +1,118 @@ +--- +title: Use Self-Hosted CodeRabbit With Azure DevOps +sidebar_label: Azure DevOps +description: Instructions to self-host CodeRabbit and integrate it with Azure DevOps. +sidebar_position: 3 +--- + +## Create a Azure DevOps User + +* **Username**: Set the username to "CodeRabbit" for easier identification (optional). +* **Profile Image**: Use the CodeRabbitAI logo for the user image (optional). + +## Add User to Projects + +Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with rights to post reviews & open PRs. + +## Create a Personal Access Token for CodeRabbit user + +Generate a personal access token for the CodeRabbit user to be added in the `.env` file as `AZURE_DEVOPS_BOT_TOKEN`. + +**Necessary Scopes**: + +* `Code` - Full +* `Work Items` - Read, write, and manage + +Consult official CodeRabbitAI documentation for a detailed [guide](https://docs.coderabbit.ai/platforms/azure-devops#generating-a-personal-access-token) on creating personal access tokens. + +## Add the necessary webhooks to each project + +1. **Navigate to projects Service Hooks Page**: Go to the service hooks configuration page in the desired Azure DevOps project. + +2. **Add the following webhooks:** + 1. Pull request created + 2. Pull request updated + 3. Pull request commented on + +3. **Add Webhook URL**: Enter the URL pointing to the CodeRabbit service, followed by `/azure_webhooks` (e.g., [`http://127.0.0.1:8080/azure_webhooks`](http://127.0.0.1:8080/azure_webhooks)) for each webhook. + +## Prepare an `.env` file + +Create an `.env` file with the following content: + +```bash +# if using OpenAI +LLM_PROVIDER=openai +LLM_TIMEOUT=360000 +OPENAI_API_KEYS= +OPENAI_BASE_URL=[] +OPENAI_ORG_ID=[] +OPENAI_PROJECT_ID=[] + +# if using Azure OpenAI +LLM_PROVIDER=azure-openai +LLM_TIMEOUT=360000 +AZURE_OPENAI_ENDPOINT= +AZURE_OPENAI_API_KEY= +AZURE_GPT4OMINI_DEPLOYMENT_NAME= +AZURE_GPT4O_DEPLOYMENT_NAME= +## o1-mini is optional +AZURE_O1_MINI_DEPLOYMENT_NAME=[] +## o1-preview is optional: it’s very expensive but provides best reviews +AZURE_O1_DEPLOYMENT_NAME=[] +## gpt-4-turbo is optional: it’s expensive but provides better reviews than gpt-4o +AZURE_GPT4TURBO_DEPLOYMENT_NAME=[] + +TEMP_PATH=/cache + +AST_GREP_RULES_PATH=/home/jailuser/ast-grep-rules +AST_GREP_ESSENTIALS=ast-grep-essentials + +SELF_HOSTED=azure-devops + +AZURE_DEVOPS_BOT_TOKEN= +AZURE_DEVOPS_BOT_USERNAME= +CODERABBIT_LICENSE_KEY= + +CODERABBIT_API_KEY=[] +ENABLE_LEARNINGS=[true] +ENABLE_METRICS=[true] + +JIRA_HOST=[] +JIRA_PAT=[] + +LINEAR_PAT=[] +``` + +:::note + +* Verify that 3 LLM models 4o-mini, 4o, and 4-turbo are available. If you are using Azure OpenAI, also verify their deployment names 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. + +::: + +## Pull the CodeRabbit Docker image + +Authenticate and pull the Docker image using the provided credentials file: + +```bash +cat coderabbit.json | docker login -u _json_key --password-stdin us-docker.pkg.dev +docker pull us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +``` + +### Verify the image is up + +You can query `/health` endpoint to verify that the coderabbit-agent service is up and running. + +```bash +curl 127.0.0.1:8080/health +``` + +## Host the image + +You can host the image on a server, serverless function, or container environment and expose port `8080`. Run the Docker image with the equivalent command on your chosen platform, ensuring you replace the `.env` file path with the path to your actual `.env` file: + +```bash +docker run --env-file .env --publish 127.0.0.1:8080:8080 us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +``` diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md new file mode 100644 index 00000000..f6c6f5aa --- /dev/null +++ b/docs/self-hosted/github.md @@ -0,0 +1,143 @@ +--- +title: Use Self-Hosted CodeRabbit With GitHub +sidebar_label: GitHub +description: Instructions to self-host CodeRabbit and integrate it with GitHub. +sidebar_position: 1 +--- + +## Create a GitHub App + +Set the following Repository permissions: + +* Checks: Read-only +* Contents: Read and write +* Commit statuses: Read and write +* Discussions: Read-only +* Issues: Read & write +* Metadata: Read-only +* Pull requests: Read & write + +Set the following Organization permissions: + +* Members: Read-only + +Set the following events: + +* Meta +* Issue comment +* Issues +* Label +* Public +* Pull request +* Pull request review +* Pull request review comment +* Pull request review thread +* Push +* Release + +## Gather information from the GitHub App + +* App ID +* Client ID +* Client Secret +* Webhook Secret + +## Prepare an `.env` file + +```bash +# if using OpenAI +LLM_PROVIDER=openai +LLM_TIMEOUT=360000 +OPENAI_API_KEYS= +OPENAI_BASE_URL=[] +OPENAI_ORG_ID=[] +OPENAI_PROJECT_ID=[] + +# if using Azure OpenAI +LLM_PROVIDER=azure-openai +LLM_TIMEOUT=360000 +AZURE_OPENAI_ENDPOINT= +AZURE_OPENAI_API_KEY= +AZURE_GPT4OMINI_DEPLOYMENT_NAME= +AZURE_GPT4O_DEPLOYMENT_NAME= +## o1-mini is optional +AZURE_O1_MINI_DEPLOYMENT_NAME=[] +## o1-preview is optional: it’s very expensive but provides best reviews +AZURE_O1_DEPLOYMENT_NAME=[] +## gpt-4-turbo is optional: it’s expensive but provides better reviews than gpt-4o +AZURE_GPT4TURBO_DEPLOYMENT_NAME=[] + +# if using Anthropic +LLM_PROVIDER=anthropic +LLM_TIMEOUT=360000 +ANTHROPIC_API_KEYS= +ANTHROPIC_BASE_URL=[] + +TEMP_PATH=/cache + +AST_GREP_RULES_PATH=/home/jailuser/ast-grep-rules +AST_GREP_ESSENTIALS=ast-grep-essentials + +SELF_HOSTED=github + +GH_WEBHOOK_SECRET= +GITHUB_HOSTNAME=[] +GITHUB_APP_CLIENT_ID= +GITHUB_APP_CLIENT_SECRET= +GITHUB_APP_ID= +GITHUB_APP_PEM_FILE= + +CODERABBIT_LICENSE_KEY= + +CODERABBIT_API_KEY=[] +ENABLE_LEARNINGS=[true] +ENABLE_METRICS=[true] + +JIRA_HOST=[] +JIRA_PAT=[] + +LINEAR_PAT=[] + +OAUTH2_ENDPOINT=[] +OAUTH2_CLIENT_ID=[] +OAUTH2_CLIENT_SECRET=[] +``` + +:::note + +* Verify that 3 LLM models 4o-mini, 4o, and 4-turbo are available. If you are using Azure OpenAI, also verify their deployment names in the .env file. +* Values marked with [] are optional to provide. +* For `GITHUB_APP_PEM_FILE`, flatten the PEM file by replacing newlines with `\n`. +* 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. + +::: + +## Pull the CodeRabbit Docker image + +Using the credentials file shared with you, first authenticate and then pull the image. + +```bash +cat coderabbit.json | docker login -u _json_key --password-stdin us-docker.pkg.dev +docker pull us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +``` + +## Host the image + +You can choose to host it on a server, serverless function, or a container environment and expose the port “8080”. Run the Docker image with the equivalent of the following command on the platform of your choice, replacing the “.env” file with the path to your “.env” file: + +```bash +docker run --env-file .env --publish 127.0.0.1:8080:8080 us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +``` + +### Verify the image is up + +You can query `/health` endpoint to verify that the coderabbit-agent service is up and running. + +```bash +curl 127.0.0.1:8080/health +``` + +## Install the GitHub App + +You can install the GitHub App on your GitHub organization or user account and point the Webhook URL to the hosted CodeRabbit instance, for example, `http://127.0.0.1:8080/github_webhooks`. GitHub will send events to the CodeRabbit instance. diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md new file mode 100644 index 00000000..80903217 --- /dev/null +++ b/docs/self-hosted/gitlab.md @@ -0,0 +1,126 @@ +--- +title: Use Self-Hosted CodeRabbit With GitLab +sidebar_label: GitLab +description: Instructions to self-host CodeRabbit and integrate it with GitLab. +sidebar_position: 2 +--- + +## Create a GitLab User + +* **Username**: Set the username to "CodeRabbit" for easier identification (optional). +* **Profile Image**: Use the CodeRabbitAI logo for the user image (optional). + +## Add User to Projects + +Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with at least `Developer` access. + +## Create a Personal Access Token for CodeRabbit user + +Generate a personal access token for the CodeRabbit user to be added in the `.env` file as `GITLAB_BOT_TOKEN`. + +**Necessary Scopes**: + +* `api` + +Consult official CodeRabbitAI documentation for a detailed [guide](https://docs.coderabbit.ai/integrations/self-hosted-gitlab#generating-personal-access-token) on creating personal access tokens. + +Add a webhook to each project + +1. **Navigate to Add Webhook Page**: Go to the webhook configuration page in the desired GitLab project. +2. **Add Webhook URL**: Enter the URL pointing to the CodeRabbit service, followed by `/gitlab_webhooks` (e.g., `http://127.0.0.1:8080/gitlab_webhooks`). +3. **Generate and Save Secret Token**: Generate a secret token, add it to the webhook, and store it securely. This will be needed for the `.env` file as `GITLAB_WEBHOOK_SECRET` (you can use a single secret token for all projects). +4. Select triggers: + + * Push events + * Comments + * Issues events + * Merge request events + +Ensure the CodeRabbit user has at least “Developer”access to the current project. + +## Prepare an `.env` file + +Create an `.env` file with the following content: + +```bash +# if using OpenAI +LLM_PROVIDER=openai +LLM_TIMEOUT=360000 +OPENAI_API_KEYS= +OPENAI_BASE_URL=[] +OPENAI_ORG_ID=[] +OPENAI_PROJECT_ID=[] + +# if using Azure OpenAI +LLM_PROVIDER=azure-openai +LLM_TIMEOUT=360000 +AZURE_OPENAI_ENDPOINT= +AZURE_OPENAI_API_KEY= +AZURE_GPT4OMINI_DEPLOYMENT_NAME= +AZURE_GPT4O_DEPLOYMENT_NAME= +## o1-mini is optional +AZURE_O1_MINI_DEPLOYMENT_NAME= +## o1-preview is optional: it’s very expensive but provides best reviews +AZURE_O1_DEPLOYMENT_NAME= +## gpt-4-turbo is optional: it’s expensive but provides better reviews +AZURE_GPT4TURBO_DEPLOYMENT_NAME=[] + +# if using Anthropic +LLM_PROVIDER=anthropic +LLM_TIMEOUT=360000 +ANTHROPIC_API_KEYS= +ANTHROPIC_BASE_URL=[] + +TEMP_PATH=/cache + +AST_GREP_RULES_PATH=/home/jailuser/ast-grep-rules +AST_GREP_ESSENTIALS=ast-grep-essentials + +SELF_HOSTED=gitlab + +GITLAB_BOT_TOKEN= +GITLAB_WEBHOOK_SECRET= +CODERABBIT_LICENSE_KEY= + +CODERABBIT_API_KEY=[] +ENABLE_LEARNINGS=[true] +ENABLE_METRICS=[true] + +JIRA_HOST=[] +JIRA_PAT=[] + +LINEAR_PAT=[] +``` + +:::note + +* Verify that 3 LLM models 4o-mini, 4o, and 4-turbo are available. If you are using Azure OpenAI, also verify their deployment names 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. + +::: + +## Pull the CodeRabbit Docker image + +Authenticate and pull the Docker image using the provided credentials file: + +```bash +cat coderabbit.json | docker login -u _json_key --password-stdin us-docker.pkg.dev +docker pull us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +``` + +### Verify the image is up + +You can query `/health` endpoint to verify that the coderabbit-agent service is up and running. + +```bash +curl 127.0.0.1:8080/health +``` + +## Host the image + +You can host the image on a server, serverless function, or container environment and expose port `8080`. Run the Docker image with the equivalent command on your chosen platform, ensuring you replace the `.env` file path with the path to your actual `.env` file: + +```bash +docker run --env-file .env --publish 127.0.0.1:8080:8080 us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +``` diff --git a/docs/tools/_category_.yml b/docs/tools/_category_.yml index 0ea58591..ede457e0 100644 --- a/docs/tools/_category_.yml +++ b/docs/tools/_category_.yml @@ -1,4 +1,4 @@ label: Supported Tools -position: 4 +position: 5 collapsible: true collapsed: true From cde464d1b84eec5ad0eeb1582b18e70a65d36b26 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Sat, 19 Oct 2024 08:46:34 -0700 Subject: [PATCH 2/4] Refactor Docker image pull command to use a placeholder for the Docker registry --- docs/self-hosted/azure-devops.md | 4 ++-- docs/self-hosted/github.md | 4 ++-- docs/self-hosted/gitlab.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md index 983bd9f2..f89370b3 100644 --- a/docs/self-hosted/azure-devops.md +++ b/docs/self-hosted/azure-devops.md @@ -98,7 +98,7 @@ Authenticate and pull the Docker image using the provided credentials file: ```bash cat coderabbit.json | docker login -u _json_key --password-stdin us-docker.pkg.dev -docker pull us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +docker pull /coderabbit-agent:latest ``` ### Verify the image is up @@ -114,5 +114,5 @@ curl 127.0.0.1:8080/health You can host the image on a server, serverless function, or container environment and expose port `8080`. Run the Docker image with the equivalent command on your chosen platform, ensuring you replace the `.env` file path with the path to your actual `.env` file: ```bash -docker run --env-file .env --publish 127.0.0.1:8080:8080 us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +docker run --env-file .env --publish 127.0.0.1:8080:8080 /coderabbit-agent:latest ``` diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md index f6c6f5aa..e464176d 100644 --- a/docs/self-hosted/github.md +++ b/docs/self-hosted/github.md @@ -119,7 +119,7 @@ Using the credentials file shared with you, first authenticate and then pull the ```bash cat coderabbit.json | docker login -u _json_key --password-stdin us-docker.pkg.dev -docker pull us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +docker pull /coderabbit-agent:latest ``` ## Host the image @@ -127,7 +127,7 @@ docker pull us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest You can choose to host it on a server, serverless function, or a container environment and expose the port “8080”. Run the Docker image with the equivalent of the following command on the platform of your choice, replacing the “.env” file with the path to your “.env” file: ```bash -docker run --env-file .env --publish 127.0.0.1:8080:8080 us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +docker run --env-file .env --publish 127.0.0.1:8080:8080 /coderabbit-agent:latest ``` ### Verify the image is up diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md index 80903217..44281ef8 100644 --- a/docs/self-hosted/gitlab.md +++ b/docs/self-hosted/gitlab.md @@ -106,7 +106,7 @@ Authenticate and pull the Docker image using the provided credentials file: ```bash cat coderabbit.json | docker login -u _json_key --password-stdin us-docker.pkg.dev -docker pull us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +docker pull /coderabbit-agent:latest ``` ### Verify the image is up @@ -122,5 +122,5 @@ curl 127.0.0.1:8080/health You can host the image on a server, serverless function, or container environment and expose port `8080`. Run the Docker image with the equivalent command on your chosen platform, ensuring you replace the `.env` file path with the path to your actual `.env` file: ```bash -docker run --env-file .env --publish 127.0.0.1:8080:8080 us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +docker run --env-file .env --publish 127.0.0.1:8080:8080 /coderabbit-agent:latest ``` From c7dae7075d3cd2627f4cfe71f150f085f018749b Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Mon, 21 Oct 2024 09:07:17 -0700 Subject: [PATCH 3/4] Refactor webhook URLs in self-hosted documentation --- docs/self-hosted/azure-devops.md | 2 +- docs/self-hosted/gitlab.md | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md index f89370b3..3348ae65 100644 --- a/docs/self-hosted/azure-devops.md +++ b/docs/self-hosted/azure-devops.md @@ -34,7 +34,7 @@ Consult official CodeRabbitAI documentation for a detailed [guide](https://docs. 2. Pull request updated 3. Pull request commented on -3. **Add Webhook URL**: Enter the URL pointing to the CodeRabbit service, followed by `/azure_webhooks` (e.g., [`http://127.0.0.1:8080/azure_webhooks`](http://127.0.0.1:8080/azure_webhooks)) for each webhook. +3. **Add Webhook URL**: Enter the URL pointing to the CodeRabbit service, followed by `/azure_webhooks` (e.g., `http://127.0.0.1:8080/azure_webhooks`) for each webhook. ## Prepare an `.env` file diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md index 44281ef8..1fba8590 100644 --- a/docs/self-hosted/gitlab.md +++ b/docs/self-hosted/gitlab.md @@ -24,7 +24,7 @@ Generate a personal access token for the CodeRabbit user to be added in the `.en Consult official CodeRabbitAI documentation for a detailed [guide](https://docs.coderabbit.ai/integrations/self-hosted-gitlab#generating-personal-access-token) on creating personal access tokens. -Add a webhook to each project +## Add a webhook to each project 1. **Navigate to Add Webhook Page**: Go to the webhook configuration page in the desired GitLab project. 2. **Add Webhook URL**: Enter the URL pointing to the CodeRabbit service, followed by `/gitlab_webhooks` (e.g., `http://127.0.0.1:8080/gitlab_webhooks`). @@ -36,8 +36,6 @@ Add a webhook to each project * Issues events * Merge request events -Ensure the CodeRabbit user has at least “Developer”access to the current project. - ## Prepare an `.env` file Create an `.env` file with the following content: From f2843685f5bff15d5ab489f7d0bf841f65f4ca6e Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Mon, 21 Oct 2024 09:15:05 -0700 Subject: [PATCH 4/4] Refactor webhook URLs in self-hosted documentation --- docs/self-hosted/azure-devops.md | 4 ++-- docs/self-hosted/github.md | 2 +- docs/self-hosted/gitlab.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md index 3348ae65..2e229ec4 100644 --- a/docs/self-hosted/azure-devops.md +++ b/docs/self-hosted/azure-devops.md @@ -27,7 +27,7 @@ Consult official CodeRabbitAI documentation for a detailed [guide](https://docs. ## Add the necessary webhooks to each project -1. **Navigate to projects Service Hooks Page**: Go to the service hooks configuration page in the desired Azure DevOps project. +1. **Navigate to project's Service Hooks Page**: Go to the service hooks configuration page in the desired Azure DevOps project. 2. **Add the following webhooks:** 1. Pull request created @@ -86,7 +86,7 @@ LINEAR_PAT=[] :::note -* Verify that 3 LLM models 4o-mini, 4o, and 4-turbo are available. If you are using Azure OpenAI, also verify their deployment names in the .env file. +* 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. diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md index e464176d..2afcf984 100644 --- a/docs/self-hosted/github.md +++ b/docs/self-hosted/github.md @@ -105,7 +105,7 @@ OAUTH2_CLIENT_SECRET=[] :::note -* Verify that 3 LLM models 4o-mini, 4o, and 4-turbo are available. If you are using Azure OpenAI, also verify their deployment names in the .env file. +* If you are using Azure OpenAI, verify that the model deployment names are in the .env file. * Values marked with [] are optional to provide. * For `GITHUB_APP_PEM_FILE`, flatten the PEM file by replacing newlines with `\n`. * For `GITHUB_HOSTNAME`, use GitHub Enterprise server's hostname, for example, “github.acme-inc.com” diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md index 1fba8590..dc738721 100644 --- a/docs/self-hosted/gitlab.md +++ b/docs/self-hosted/gitlab.md @@ -92,7 +92,7 @@ LINEAR_PAT=[] :::note -* Verify that 3 LLM models 4o-mini, 4o, and 4-turbo are available. If you are using Azure OpenAI, also verify their deployment names in the .env file. +* 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.