Skip to content

Commit 871babc

Browse files
authored
Merge branch 'main' into github
2 parents fa2fded + 5aa268e commit 871babc

File tree

13 files changed

+67
-16
lines changed

13 files changed

+67
-16
lines changed

docs/changelog.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 13
66
---
77

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+
818
## July 3, 2025
919

1020
### Enhanced Python Static Analysis: Flake8 Support

docs/guides/code-review-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ perform a code review:
4848

4949
CodeRabbit automatically reviews a pull request when **either** of the following statements is true:
5050

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.
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.
5252
- 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.
5353

5454
<ProPlanNotice />

docs/guides/configuration-overview.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,28 @@ For more information, see [Set your repository preferences](/guides/repository-s
4646

4747
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).
4848

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+
4971
## Initial configuration {#initial}
5072

5173
The [Initial configuration guide](/guides/initial-configuration) tours you through several settings that we

docs/guides/initial-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ By default, CodeRabbit writes thorough code reviews with several sub-sections. I
7272
- [Related issues](/reference/configuration#related-issues): lists issues found in your issue tracker that might be related to this pull request.
7373
- [Related pull requests](/reference/configuration#realted-prs): lists pull requests that might be related to this pull request.
7474
- [Suggested labels](/reference/configuration#suggested-labels): Suggests labels for this pull request.
75-
- [Suggested reviewers](/reference/configuration#suggested-reveiwers): automatically suggest reviewers for PR
75+
- [Suggested reviewers](/reference/configuration#suggested-reviewers): automatically suggest reviewers for PR
7676
- [Poem](/reference/configuration#poem): generates a short poem about this pull request.
7777

7878
## Adjust path-specific CodeRabbit behavior {#path}

docs/self-hosted/azure-devops.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,13 +127,16 @@ LINEAR_PAT=[<linear-personal-access-token>]
127127

128128
ENABLE_WEB_SEARCH=[true]
129129
PERPLEXITY_API_KEY=[<perplexity-api-key>]
130+
131+
YAML_CONFIG=[<escaped-yaml-config>]
130132
```
131133

132134
:::note
133135

134136
- If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
135137
- Values marked with [] are not optional to provide.
136138
- 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.
137140

138141
:::
139142

docs/self-hosted/bitbucket.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,13 +122,16 @@ LINEAR_PAT=[<linear-personal-access-token>]
122122

123123
ENABLE_WEB_SEARCH=[true]
124124
PERPLEXITY_API_KEY=[<perplexity-api-key>]
125+
126+
YAML_CONFIG=[<escaped-yaml-config>]
125127
```
126128

127129
:::note
128130

129131
- If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
130132
Values marked with [] are optional and can be omitted if the feature is not needed.
131133
- 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.
132135

133136
:::
134137

docs/self-hosted/github.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,8 @@ LINEAR_PAT=[<linear-personal-access-token>]
140140

141141
ENABLE_WEB_SEARCH=[true]
142142
PERPLEXITY_API_KEY=[<perplexity-api-key>]
143+
144+
YAML_CONFIG=[<escaped-yaml-config>]
143145
```
144146

145147
:::note
@@ -150,6 +152,7 @@ PERPLEXITY_API_KEY=[<perplexity-api-key>]
150152
- For `GITHUB_HOSTNAME`, use GitHub Enterprise server's hostname, for example, “github.acme-inc.com”
151153
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
152154
- 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.
153156

154157
:::
155158

docs/self-hosted/gitlab.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,13 +134,16 @@ LINEAR_PAT=[<linear-personal-access-token>]
134134

135135
ENABLE_WEB_SEARCH=[true]
136136
PERPLEXITY_API_KEY=[<perplexity-api-key>]
137+
138+
YAML_CONFIG=[<escaped-yaml-config>]
137139
```
138140

139141
:::note
140142

141143
- If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
142144
- Values marked with [] are not optional to provide.
143145
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
146+
- `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.
144147

145148
:::
146149

docs/tools/flake8.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

13-
[Flake8](https://flake8.pycqa.org/) is a Python linting utility that wraps PyFlakes, pycodestyle, and Mccabe to check your Python code for style and logical errors.
13+
[Flake8](https://flake8.pycqa.org/) is a Python linting utility that wraps PyFlakes, pycodestyle, and Mccabe to check your Python or Jupiter Notebook code for style and logical errors.
1414

1515
## Supported Files
1616

1717
Flake8 will run on files with the following extensions:
1818

1919
- `*.py`
20+
- `*.ipynb` (using nbqa)
2021

2122
## Configuration
2223

@@ -42,3 +43,4 @@ Flake8 can detect many issues such as:
4243
- [Flake8 GitHub Repository](https://github.com/pycqa/flake8)
4344
- [Flake8 Documentation](https://flake8.pycqa.org/en/latest/)
4445
- [Flake8 Configuration](https://flake8.pycqa.org/en/latest/user/configuration.html)
46+
- [nbqa Documentation](https://github.com/nbQA-dev/nbQA)

docs/tools/list.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
3737
| Java | [PMD][PMD] | Code Quality |
3838
| Protobuf | [Buf][Buf] | Code Quality |
3939
| Python | [Ruff][Ruff], [Pylint][Pylint], [Flake8][Flake8] | Code Quality |
40+
| Jupyter Notebooks | [Ruff][Ruff], [Pylint][Pylint], [Flake8][Flake8] | Code Quality |
4041
| Regal | [Regal][Regal] | Code Quality |
4142
| Ruby | [RuboCop][RuboCop], [Brakeman][Brakeman] | Code Quality, Code Security |
4243
| Rust | [Clippy][Clippy] | Code Quality |

0 commit comments

Comments
 (0)