Skip to content

Commit 4598f42

Browse files
authored
Merge branch 'main' into PrasadBhat4/configure-coderabbit-docs-improvements
2 parents c588cf9 + a9bb694 commit 4598f42

File tree

9 files changed

+69
-23
lines changed

9 files changed

+69
-23
lines changed

docs/changelog.md

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

8+
## July 23, 2025
9+
10+
### ⚡️ Unit Test Generation - Beta
11+
12+
CodeRabbit's unit test generation is now available in Beta! Automatically generate comprehensive unit tests for your code changes, ensuring better test coverage and catching edge cases you might miss. Our AI analyzes your code structure and creates tests that follow best practices and your project's testing patterns. Learn more [here](https://docs.coderabbit.ai/finishing-touches/unit-test-generation), or just try it under ✨ Finishing Touches.
13+
814
## July 17, 2025
915

1016
### Enhanced Reporting Capabilities

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ In-trial and open-source plans have lower rate limits than the paid plan. In all
203203

204204
:::
205205

206-
The following limits enforced _per developer_:
206+
The following limits are enforced _per developer_:
207207

208208
| Feature | Free Plan | Trial Plan | OSS Plan | Pro/Lite Plan |
209209
| -------------------------------- | ------------------------------------------ | --------------------------------- | ----------------------------- | ----------------------------- |

docs/finishing-touches/unit-test-generation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
```
1111

1212
:::warning
13-
This feature is [experimental](/early-access#experiments).
13+
This feature is in beta.
1414
:::
1515

1616
# Unit Test Generation
1717

1818
Unit Test Generation is part of the [finishing touches](/future-development#finishing-touches).
1919

20-
Unit Test Generation is an Early Access Experimental feature.
21-
2220
## Usage
2321

22+
![Unit Test Generation](/img/finishing-touches/utg.gif)
23+
2424
Once you are done with your pull request and its reviews, you may want to perform finishing touches to your code, such as adding unit tests. You can request CodeRabbit to generate unit tests by typing `@coderabbitai generate unit tests` in a comment under that pull request or by clicking a checkbox under **Generate Unit Tests** in the CodeRabbit Walkthrough.
2525

2626
Once sent, CodeRabbit will perform the following actions:

docs/self-hosted/azure-devops.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,19 @@ CODERABBIT_LICENSE_KEY=<license-key>
119119

120120
CODERABBIT_API_KEY=<coderabbitai-api-key>
121121
ENABLE_METRICS=[true]
122-
ENABLE_LEARNINGS=[true]
123-
# if using CodeRabbit's learnings, also provide the following
124-
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
125-
OBJECT_STORE_URI=[<object-store-uri>]
122+
123+
# CodeRabbit - KNOWLEDGE BASE
124+
#
125+
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
126+
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
127+
128+
ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.
129+
130+
ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
131+
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
132+
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
133+
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
134+
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.
126135

127136
JIRA_HOST=[<jira-host-url>]
128137
JIRA_PAT=[<jira-personal-access-token>]

docs/self-hosted/bitbucket.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,20 @@ CODERABBIT_LICENSE_KEY=<license-key>
117117

118118
CODERABBIT_API_KEY=<coderabbitai-api-key>
119119
ENABLE_METRICS=[true]
120-
ENABLE_LEARNINGS=[true]
121-
# if using CodeRabbit's learnings, also provide the following
122-
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
123-
OBJECT_STORE_URI=[<object-store-uri>]
120+
121+
122+
# CodeRabbit - KNOWLEDGE BASE
123+
#
124+
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
125+
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
126+
127+
ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.
128+
129+
ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
130+
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
131+
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
132+
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
133+
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.
124134

125135
JIRA_HOST=[<jira-host-url>]
126136
JIRA_PAT=[<jira-personal-access-token>]

docs/self-hosted/github.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,20 @@ CODERABBIT_LICENSE_KEY=<license-key>
135135

136136
CODERABBIT_API_KEY=<coderabbitai-api-key>
137137
ENABLE_METRICS=[true]
138-
ENABLE_LEARNINGS=[true]
139-
# if using CodeRabbit's learnings, also provide the following
140-
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
141-
OBJECT_STORE_URI=[<object-store-uri>]
138+
139+
140+
# CodeRabbit - KNOWLEDGE BASE
141+
#
142+
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
143+
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
144+
145+
ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.
146+
147+
ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
148+
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
149+
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
150+
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
151+
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.
142152

143153
JIRA_HOST=[<jira-host-url>]
144154
JIRA_PAT=[<jira-personal-access-token>]

docs/self-hosted/gitlab.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,21 @@ CODERABBIT_LICENSE_KEY=<license-key>
161161

162162
CODERABBIT_API_KEY=<coderabbitai-api-key>
163163
ENABLE_METRICS=[true]
164-
ENABLE_LEARNINGS=[true]
165-
# if using CodeRabbit's learnings, also provide the following
166-
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
167-
OBJECT_STORE_URI=[<object-store-uri>]
164+
165+
166+
# CodeRabbit - KNOWLEDGE BASE
167+
#
168+
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
169+
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
170+
171+
ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.
172+
173+
ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
174+
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
175+
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
176+
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
177+
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.
178+
168179

169180
JIRA_HOST=[<jira-host-url>]
170181
JIRA_PAT=[<jira-personal-access-token>]

static/img/finishing-touches/utg.gif

15.5 MB
Loading

static/schema/schema.v2.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -615,7 +615,7 @@
615615
"enabled": {
616616
"type": "boolean",
617617
"default": true,
618-
"description": "Enable Biome | Biome is a fast formatter, linter, and analyzer for web projects. | Enable Biome integration. | v1.9.4"
618+
"description": "Enable Biome | Biome is a fast formatter, linter, and analyzer for web projects. | Enable Biome integration. | v2.1.2"
619619
}
620620
},
621621
"additionalProperties": false,
@@ -716,7 +716,7 @@
716716
"enabled": {
717717
"type": "boolean",
718718
"default": true,
719-
"description": "Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v1.64.8"
719+
"description": "Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v2.2.2"
720720
},
721721
"config_file": {
722722
"type": "string",
@@ -897,7 +897,7 @@
897897
"enabled": {
898898
"type": "boolean",
899899
"default": true,
900-
"description": "Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.122.0"
900+
"description": "Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.128.1"
901901
},
902902
"config_file": {
903903
"type": "string",

0 commit comments

Comments
 (0)