You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/changelog.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,16 @@ description: The latest updates and changes to CodeRabbit.
5
5
sidebar_position: 13
6
6
---
7
7
8
+
## July 10, 2025
9
+
10
+
### Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks
11
+
12
+
We're excited to announce enhanced Python static analysis capabilities with nbqa support for Jupyter Notebooks!
13
+
14
+
Our existing integrated [Ruff](https://docs.astral.sh/ruff/), [Flake8](https://flake8.pycqa.org/) and [Pylint](https://pylint.pycqa.org/) tools now support linting Jupyter Notebooks (`.ipynb` files) using [nbqa](https://github.com/nbQA-dev/nbQA). This allows you to maintain code quality across your Python projects, including Jupyter Notebooks.
15
+
16
+
See our [Ruff](/tools/ruff), [Flake8](/tools/flake8), and [Pylint](/tools/pylint) documentation for more details.
17
+
8
18
## July 3, 2025
9
19
10
20
### Enhanced Python Static Analysis: Flake8 Support
Copy file name to clipboardExpand all lines: docs/guides/code-review-overview.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,8 @@ description: An overview of CodeRabbit's core code review features.
4
4
sidebar_label: Overview
5
5
---
6
6
7
+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'
8
+
7
9
The central feature of CodeRabbit is its ability to proactively review
8
10
new pull requests on your code repository.
9
11
@@ -42,6 +44,15 @@ perform a code review:
42
44
- If an open pull request that CodeRabbit has already reviewed gets modified with another
43
45
commit, then CodeRabbit performs an incremental review that focuses on the new commit.
44
46
47
+
### Which pull requests get automatically reviewed {#eligibility}
48
+
49
+
CodeRabbit automatically reviews a pull request when **either** of the following statements is true:
50
+
51
+
- The pull request is in a public repository. CodeRabbit reviews pull requests against the main branch of your public repositories by default. This feature is available to every subscription tier, including the free plan.
52
+
- The pull request is in a private repository and your organization is on the Pro plan with a seat assigned to you. Only under this condition does CodeRabbit review private-repository pull requests.
53
+
54
+
<ProPlanNotice />
55
+
45
56
## Interact with CodeRabbit reviews {#interact}
46
57
47
58
After CodeRabbit attaches its initial code-review comment to a pull request, you can
Copy file name to clipboardExpand all lines: docs/guides/configuration-overview.md
+22Lines changed: 22 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,6 +46,28 @@ For more information, see [Set your repository preferences](/guides/repository-s
46
46
47
47
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).
48
48
49
+
## Configuration priority {#priority}
50
+
51
+
CodeRabbit follows a specific hierarchy when determining which configuration settings to use. Understanding this priority system helps you manage your configuration effectively:
52
+
53
+
### Priority order (highest to lowest)
54
+
55
+
1.**Local `.coderabbit.yaml` file of head branch**
56
+
2.**Repository settings** (web UI)
57
+
3.**Organization settings** (web UI)
58
+
59
+
### How priority works
60
+
61
+
-**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.
62
+
-**If you don't have a local YAML file but have enabled repository settings**: Organization settings are ignored. Only repository settings are used.
63
+
-**If you have organization settings and repository settings are disabled**: Only organization settings are used.
64
+
65
+
### Configuration inheritance
66
+
67
+
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.
68
+
69
+
This means that configuration is not merged or inherited - the highest priority source takes complete control over all settings.
70
+
49
71
## Initial configuration {#initial}
50
72
51
73
The [Initial configuration guide](/guides/initial-configuration) tours you through several settings that we
- If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
135
137
- Values marked with [] are not optional to provide.
136
138
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
139
+
-`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.
- If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
130
132
Values marked with [] are optional and can be omitted if the feature is not needed.
131
133
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
134
+
-`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.
- For `GITHUB_HOSTNAME`, use GitHub Enterprise server's hostname, for example, “github.acme-inc.com”
151
153
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
152
154
- When `ENABLE_LEARNINGS` is set to `true`, CodeRabbit will use `CODERABBIT_API_KEY` to store learnings on our servers.
155
+
-`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.
Copy file name to clipboardExpand all lines: docs/self-hosted/gitlab.md
+37-1Lines changed: 37 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,13 +37,46 @@ Consult official CodeRabbitAI documentation for a detailed [guide](https://docs.
37
37
1.**Navigate to Add Webhook Page**: Go to the webhook configuration page in the desired GitLab project.
38
38
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`).
39
39
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).
40
-
4. Select triggers:
40
+
4.**Select triggers**:
41
41
42
42
- Push events
43
43
- Comments
44
44
- Issues events
45
45
- Merge request events
46
46
47
+
## Add Webhook Using a Script
48
+
49
+
We have a convenient [script](/code/gitlab-webhook.sh) to help you add webhooks to a project or all projects under a group in a GitLab instance.
- If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
142
177
- Values marked with [] are not optional to provide.
143
178
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
179
+
-`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.
0 commit comments