@@ -52,7 +52,7 @@ YAML settings:
52
52
' You must use talk like Mr. T. I pity the fool who doesn' t!'
53
53
3. **`early_access`** : Enroll in the early access program to take advantage of
54
54
forthcoming features before their general release (default:`false`).
55
- 4. **`reviews`** : Configurations for the code reviews .
55
+ 4. **`reviews`** : Configures review settings .
56
56
57
57
- **`request_changes_workflow`**: Enable request changes review workflow for
58
58
CodeRabbit reviews. (default : ` false` ).
@@ -90,7 +90,7 @@ YAML settings:
90
90
purpose of each test."
91
91
` ` `
92
92
93
- - **`auto_review`**: Manages settings for automated code reviews, such as:
93
+ - **`auto_review`**: Manages settings for automated code reviews.
94
94
95
95
- **`enabled`**: Automated code review (default: `true`).
96
96
- **`ignore_title_keywords`**: Review will be ignored if a pull request
@@ -109,9 +109,9 @@ YAML settings:
109
109
- "feat/.*"
110
110
` ` `
111
111
112
- - **`tools`**: Configurations for the tools used in the review .
112
+ - **`tools`**: Configures external tools integration settings .
113
113
114
- - **`ast-grep`**: Configurations for the `ast-grep` tool .
114
+ - **`ast-grep`**: Configuration for `ast-grep` integration .
115
115
- **`rule_dirs`**: The directory name where the custom `ast-grep` rules
116
116
are stored.
117
117
- **`util_dirs`**: The directory name where the custom `ast-grep` utils
@@ -132,9 +132,9 @@ YAML settings:
132
132
- **`languagetool`**: Configuration for `languagetool` integration.
133
133
134
134
- **`enabled`**: Enable integration, defaults to true.
135
- - **`level`**: The level of the rule. Can be one `default` or `picky`. If
136
- set to `picky`, additional rules will be activated, i.e. rules that you
137
- might only find useful when checking formal text.
135
+ - **`level`**: The level of the rule. It can be one `default` or `picky`.
136
+ If set to `picky`, additional rules will be activated, i.e. rules that
137
+ you might only find useful when checking formal text.
138
138
- **`enabled_rules`**: IDs of rules to be enabled. The rule won't run
139
139
unless 'level' is set to a level that activates the rule.
140
140
- **`disabled_rules`**: IDs of rules to be disabled.
@@ -169,7 +169,28 @@ YAML settings:
169
169
- "CASING"
170
170
` ` `
171
171
172
- 5. **`chat`** : Defines the behavior of CodeRabbit's bot in conversations.
172
+ 5. **`knowledge_base`** : Configures knowledge base settings.
173
+
174
+ - **`learnings`**: Configures learnings settings.
175
+ - **`scope`**: Specify the scope of learnings to use for the knowledge
176
+ base. `local` uses the repository's learnings, `global` uses the
177
+ organization's learnings, and `auto` uses repository's learnings for
178
+ public repositories and organization's learnings for private
179
+ repositories.
180
+ - **`issues`**: Configures issues settings.
181
+ - **`scope`**: Specify the scope of git platform (GitHub/GitLab) issues to
182
+ use for the knowledge base. `local` uses the repository's issues,
183
+ ` global` uses the organization's issues, and `auto` uses repository's
184
+ issues for public repositories and organization's issues for private
185
+ repositories.
186
+ - **`jira`**: Configures Jira settings.
187
+ - **`project_keys`**: A list of Jira project keys to use for the knowledge
188
+ base. If not provided, all projects will be used.
189
+ - **`linear`**: Configures Linear settings.
190
+ - **`team_keys`**: A list of Linear team keys to use for the knowledge
191
+ base. If not provided, all teams will be used.
192
+
193
+ 6. **`chat`** : Defines the behavior of CodeRabbit's bot in conversations.
173
194
- **`auto_reply`**: The bot automatically replies without the need of the
174
195
user tagging it (default : ` true` ).
175
196
@@ -180,7 +201,7 @@ Refer:
180
201
181
202
<summary> version 1 (deprecated) </summary>
182
203
183
- # ### Version 1: `deprecated` (Please use version [version 2](#yaml))
204
+ # ### Version 1: `deprecated` (Please use [version 2](#yaml))
184
205
185
206
` ` ` yaml
186
207
settings:
@@ -214,7 +235,6 @@ settings:
214
235
collapse_walkthrough_comment: true
215
236
# Disable automatic code reviews for this repository.
216
237
disable_review: false
217
- # External tools configurations
218
238
` ` `
219
239
220
240
This configuration file consists of the following settings :
0 commit comments