Skip to content

Commit 72c2da7

Browse files
Update coderabbig guide page with new coderabbit.yaml changes
1 parent 7d868b1 commit 72c2da7

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/guides/customize-coderabbit.md

+22
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ reviews:
6969
base_branches:
7070
- "develop"
7171
- "feat/.*"
72+
tools:
73+
ast-grep:
74+
rules_folder: "custom-rules-folder-name"
75+
utils_folder: "custom-utils-folder-name"
7276
chat:
7377
auto_reply: true
7478
```
@@ -110,6 +114,12 @@ Yaml settings:
110114
`true`).
111115
- **base_branches**: A list of base branches where the reviews will occur
112116
apart from the default branch. Accepts regex pattern.
117+
- **tools**: Configurations for the tools used in the review.
118+
- **ast-grep**: Configurations for the ast-grep tool.
119+
- **rules_folder**: The folder name where the custom ast-grep rules are
120+
stored.
121+
- **utils_folder**: The folder name where the custom ast-grep utils are
122+
stored.
113123
4. **chat**: Defines the behavior of CodeRabbit's bot in conversations.
114124
- **auto_reply**: The bot automatically replies without the need of the user
115125
tagging it ( default: `true` ).
@@ -154,6 +164,12 @@ settings:
154164
collapse_walkthrough_comment: true
155165
# Disable automatic code reviews for this repository.
156166
disable_review: false
167+
# External tools configurations
168+
tools:
169+
# tools configuration for ast-grep
170+
ast-grep:
171+
rules_folder: "custom-rules-folder-name"
172+
utils_folder: "custom-utils-folder-name"
157173
```
158174

159175
<!-- ![code](./images/ymlrabbit.png) -->
@@ -187,6 +203,12 @@ This configuration file consists of the following settings:
187203
be posted.
188204
13. **collapse_walkthrough_comment**: Specifies whether to collapse walkthrough
189205
comments on the review.
206+
14. **tools**: Configurations for the tools used in the review.
207+
- **ast-grep**: Configurations for the ast-grep tool.
208+
- **rules_folder**: The folder name where the custom ast-grep rules are
209+
stored.
210+
- **utils_folder**: The folder name where the custom ast-grep utils are
211+
stored.
190212

191213
Refer:
192214
[CodeRabbit configuration schema](https://coderabbit.ai/integrations/coderabbit-overrides.json).

0 commit comments

Comments
 (0)