Skip to content

Commit ccf1356

Browse files
committed
remove v1 config documentation
1 parent afea359 commit ccf1356

File tree

1 file changed

+0
-69
lines changed

1 file changed

+0
-69
lines changed

docs/guides/configure-coderabbit.md

Lines changed: 0 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -217,75 +217,6 @@ YAML settings:
217217
Refer:
218218
[CodeRabbit Configuration Schema](https://coderabbit.ai/integrations/schema.v2.json).
219219

220-
<details>
221-
222-
<summary> version 1 (deprecated) </summary>
223-
224-
#### Version 1: `deprecated` (Please use [version 2](#yaml))
225-
226-
```yaml
227-
settings:
228-
# Enables automatic reviewing of draft pull requests.
229-
enable_draft_pr_reviews: true
230-
# Specifies additional base/target branches to be reviewed. Accept regex pattern.
231-
additional_branches_to_be_reviewed:
232-
- "master"
233-
- "yaml/test"
234-
# Disables generation of release notes.
235-
disable_high_level_summary: false
236-
# Specific review instructions for certain file paths. File paths accept glob pattern
237-
path_based_instructions:
238-
- path: "**/*.js"
239-
instructions:
240-
"Review the JavaScript code against the Google JavaScript style guide
241-
and point out any mismatches"
242-
- path: "tests/**/*"
243-
instructions:
244-
"Review the following unit test code written using the Mocha test
245-
library. Ensure that: - The code adheres to best practices associated
246-
with Mocha. - Descriptive test names are used to clearly convey the
247-
intent of each test."
248-
# Comma separated list of keywords in the title that should be ignored.
249-
ignored_pr_titles: "WIP"
250-
# ISO Code for the review language.
251-
review_language: "en"
252-
# Disables review and other status comments.
253-
disable_review_status: false
254-
# Add walkthrough comment in a collapsible section.
255-
collapse_walkthrough_comment: true
256-
# Disable automatic code reviews for this repository.
257-
disable_review: false
258-
```
259-
260-
This configuration file consists of the following settings:
261-
262-
1. **`enable_draft_pr_reviews`**: Set to **`false`** to disable draft pull
263-
request(PR) reviews.
264-
2. **`additional_branches_to_be_reviewed`**: Define additional branches to be
265-
reviewed besides the default branch.
266-
3. **`disable_high_level_summary`**: If set to **`true`**, disables high-level
267-
summary generation.
268-
4. **`path_based_instructions`**: Allows you to specify instructions based on
269-
file paths. In this example, instructions for Python and JavaScript files are
270-
provided, encouraging adherence to the Google style guide.
271-
5. **`ignored_pr_titles`**: Specifies ignored PR titles, in this case, "WIP"
272-
(Work in Progress).
273-
6. **`review_language`**: Sets the review language to French (`fr`).
274-
7. **`disable_poem`**: If set to **`false`**, enables the "poem" feature.
275-
8. **`early_access_program`**: Determines whether to enable the early access
276-
program (set to **`false`** in this case).
277-
9. **`exclude_file_patterns`**: Specifies patterns for excluding certain files
278-
from review, such as `!dist/**` and `!**.md`.
279-
10. **`limit_reviews_by_label`**: Limits reviews by label, targeting "first_bug"
280-
label reviews.
281-
11. **`disable_review`**: Totally disables automatic code reviews for the
282-
repository.
283-
12. **`disable_review_status`**: Disables review and other status comments.
284-
13. **`collapse_walkthrough_comment`**: Specifies whether to collapse
285-
walkthrough comments on the review.
286-
287-
</details>
288-
289220
### 2. Configure CodeRabbit through the UI
290221

291222
Reviews can also be configured through the UI under repository settings:

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy