Skip to content

Commit c30fd69

Browse files
jmacdotorgjmacdotorg
authored
Merge branch 'main' into rbac
2 parents a7c502b + 94f88f3 commit c30fd69

File tree

18 files changed

+159
-46
lines changed

18 files changed

+159
-46
lines changed

‎README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,20 +37,25 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
3737

3838
## Getting Started
3939

40-
1. Clone this repository:
40+
1. Make sure that you have the following prerequisites installed:
41+
42+
- [Node.js](https://nodejs.org/)
43+
- [pnpm](https://pnpm.io/installation)
44+
45+
2. Clone this repository:
4146

4247
```sh
4348
git clone https://github.com/coderabbit-ai/coderabbit-docs.git
4449
cd coderabbit-docs
4550
```
4651

47-
2. Install dependencies:
52+
3. Install Node.js dependencies using `pnpm`:
4853

4954
```sh
5055
pnpm install
5156
```
5257

53-
3. Start the development server:
58+
4. Start the development server:
5459

5560
```sh
5661
pnpm start

‎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+
## June 11, 2025
9+
10+
### Enhanced Static Analysis: HTMLHint and Checkmake Support
11+
12+
We're excited to announce that two new static analysis tools are now supported on CodeRabbit!
13+
14+
- [HTMLHint](https://htmlhint.com/) is a static code analysis tool for HTML that helps maintain code quality by detecting common mistakes and enforcing best practices.
15+
16+
- [Checkmake](https://github.com/mrtazz/checkmake) is a linter for Makefiles that helps ensure your build scripts follow best practices and maintain consistency.
17+
818
## June 5, 2025
919

1020
### Enhanced Static Analysis: Dotenv Linter and Pylint Support

‎docs/finishing-touches/docstrings.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -50,36 +50,32 @@ code_generation:
5050
5151
These software forges are supported:
5252
53-
- [x] Azure DevOps
54-
- [ ] Bitbucket Cloud
55-
- [ ] Bitbucket Data Center
56-
- [x] GitHub
57-
- [x] GitLab
53+
- Azure DevOps
54+
- GitHub
55+
- GitLab
5856
5957
While Bitbucket is not officially supported, docstrings can still be generated. However, they will be posted in a comment under the pull request. Full support for Bitbucket is planned.
6058
6159
## Supported languages
6260
6361
These languages are supported:
6462
65-
- [x] Bash
66-
- [x] C
67-
- [x] C#
68-
- [x] C++
69-
- [x] Elixir
70-
- [x] Go
71-
- [ ] Haskell
72-
- [x] Java
73-
- [x] JavaScript
74-
- [x] Kotlin
75-
- [x] Lua
76-
- [x] Php
77-
- [x] Python
78-
- [x] React TypeScript
79-
- [x] Ruby
80-
- [x] Rust
81-
- [ ] Scala
82-
- [x] Swift
83-
- [x] TypeScript
63+
- Bash
64+
- C
65+
- C#
66+
- C++
67+
- Elixir
68+
- Go
69+
- Java
70+
- JavaScript
71+
- Kotlin
72+
- Lua
73+
- Php
74+
- Python
75+
- React TypeScript
76+
- Ruby
77+
- Rust
78+
- Swift
79+
- TypeScript
8480
8581
CodeRabbit uses `ast-grep` to parse the code. If you want a new language to be supported, please look into [Add New Language to ast-grep](https://ast-grep.github.io/contributing/add-lang.html#add-new-language-to-ast-grep) first.

‎docs/getting-started/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Create a new, private repository on GitHub. Name the new repository `coderabbit-
3030

3131
To integrate CodeRabbit with your GitHub account, follow these steps:
3232

33-
1. Visit [the CodeRabbit login page](https://app.coderabbit.ai/login).
33+
1. Visit [the CodeRabbit login page](https://app.coderabbit.ai/login?free-trial).
3434
1. Click **Login with GitHub**.
3535
1. Click **Authorize coderabbitai**.
3636

‎docs/getting-started/support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ All CodeRabbit users have access to the [CodeRabbit Discord Server](http://disco
1414
## Support Tickets
1515

1616
:::tip
17-
For assistance from our support team, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://app.coderabbit.ai/login). This will open a chat window where you can submit your support ticket.
17+
For assistance from our support team, click the help icon located in the bottom right corner of the [CodeRabbit UI](https://app.coderabbit.ai/login?free-trial). This will open a chat window where you can submit your support ticket.
1818
:::
1919

2020
Complete the support ticket by providing your name, email, a description of your issue, and attaching any necessary files. If you are reporting a bug, please provide the GitHub or GitLab organization name.

‎docs/guides/install-vscode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The instructions on this page are specific to using the extension with VSCode. I
1414

1515
Before you can use the CodeRabbit VSCode extension, you need a CodeRabbit account.
1616

17-
If you don't already have an account, you can create one by visiting [the CodeRabbit login page](https://app.coderabbit.ai/login).
17+
If you don't already have an account, you can create one by visiting [the CodeRabbit login page](https://app.coderabbit.ai/login?free-trial).
1818

1919
## Install the extension
2020

‎docs/overview/why-coderabbit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Your intelligent code review companion that understands context.
5757
> From its foundation as a Generative AI-first platform, CodeRabbit has evolved to become the preferred code review tool among developers because of its speed, intelligence, adaptability, and support for features like contextual analysis, security scanning, and architectural insights. CodeRabbit supports all major programming languages and integrates with popular development [tools](/tools).
5858
5959
:::info Get Started
60-
If your team needs intelligent code reviews, CodeRabbit delivers. If you're new to AI-powered reviews, [sign up for a Free account](https://app.coderabbit.ai/login), join the [Discord server](https://discord.gg/coderabbit), and start the journey with us.
60+
If your team needs intelligent code reviews, CodeRabbit delivers. If you're new to AI-powered reviews, [sign up for a Free account](https://app.coderabbit.ai/login?free-trial), join the [Discord server](https://discord.gg/coderabbit), and start the journey with us.
6161
:::
6262

6363
## CodeRabbit is Context-Aware
@@ -432,9 +432,9 @@ Try CodeRabbit on your next pull request. Experience how AI-powered code review
432432

433433
> Start reading more about the custom [code review instructions](/guides/review-instructions) or how CodeRabbit verify issues using [knowledge bases](/integrations/knowledge-base) like Linear and Jira.
434434
435-
Transform your code reviews now, [Start your free trial today](https://app.coderabbit.ai/login) and join the Discord server and chat with CodeRabbit users and team.
435+
Transform your code reviews now, [Start your free trial today](https://app.coderabbit.ai/login?free-trial) and join the Discord server and chat with CodeRabbit users and team.
436436

437437
<div style={{display: 'flex', gap: '10px', marginTop: '20px'}}>
438-
<a href="https://app.coderabbit.ai/login" className="button button--primary button--lg">Sign Up Free</a>
438+
<a href="https://app.coderabbit.ai/login?free-trial" className="button button--primary button--lg">Sign Up Free</a>
439439
<a href="https://discord.gg/coderabbit" className="button button--secondary button--lg">Join Discord</a>
440440
</div>

‎docs/platforms/bitbucket-cloud.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ This guide will assist you in effectively integrating CodeRabbit with Bitbucket
1818
To enable CodeRabbit to interact with your Bitbucket repositories, an app password is required. This token grants the necessary permissions for interacting with the Merge Requests and Discussions APIs.
1919

2020
1. Create a new Bitbucket account specifically for CodeRabbit and treat it as a service account.
21-
1. Name the account "CodeRabbit".
22-
1. If your Bitbucket workspace requires two-step verification, then you must also enable two-step verification on this new account.
23-
1. Generate an App Password to enable seamless integration between CodeRabbit and your Bitbucket repositories.
21+
2. Name the account "CodeRabbit".
22+
3. If your Bitbucket workspace requires two-step verification, then you must also enable two-step verification on this new account.
23+
4. Generate an App Password to enable seamless integration between CodeRabbit and your Bitbucket repositories.
2424

2525
We recommend creating a new user as a service account, associating this user to the workspace you'd like to install CodeRabbit on, and providing CodeRabbit with the app password to allow access. During the installation process, CodeRabbit will automatically configure the required webhook for seamless integration.
2626

‎docs/platforms/github-com.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ If you opt to authorize all repositories during setup, CodeRabbit will automatic
5353

5454
### 5. CodeRabbit Configuration
5555

56-
You can configure CodeRabbit through a YAML file or using the [App's UI](https://app.coderabbit.ai/login).
56+
You can configure CodeRabbit through a YAML file or using the [App's UI](https://app.coderabbit.ai/login?free-trial).
5757

5858
You can tailor CodeRabbit's functionality using the `.coderabbit.yaml` file, which you place directly in your GitHub repository. This file mirrors the options available in the CodeRabbit user interface, with each setting in the YAML corresponding to a specific toggle in the UI. Configure CodeRabbit either through the coderabbit.yaml file or the interface, depending on your preference.
5959

‎docs/platforms/platforms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ CodeRabbit supports various Git platforms to provide code review for your reposi
3232
| Bitbucket Datacenter | [Supported](../self-hosted/bitbucket.md) |
3333
| Bitbucket Cloud | [Supported](./bitbucket-cloud.md) |
3434

35-
[login]: https://app.coderabbit.ai/login
35+
[login]: https://app.coderabbit.ai/login?free-trial

‎docs/self-hosted/azure-devops.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@ LLM_PROVIDER=azure-openai
6464
LLM_TIMEOUT=360000
6565
AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
6666
AZURE_OPENAI_API_KEY=<key>
67-
## it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
67+
# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
68+
AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=<text-embedding-3-large-deployment-name>
6869
AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
6970
AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
7071
AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
@@ -116,7 +117,7 @@ CODERABBIT_API_KEY=<coderabbitai-api-key>
116117
ENABLE_METRICS=[true]
117118
ENABLE_LEARNINGS=[true]
118119
# if using CodeRabbit's learnings, also provide the following
119-
# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
120+
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
120121
OBJECT_STORE_URI=[<object-store-uri>]
121122

122123
JIRA_HOST=[<jira-host-url>]

‎docs/self-hosted/bitbucket.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ LLM_PROVIDER=azure-openai
5656
LLM_TIMEOUT=360000
5757
AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
5858
AZURE_OPENAI_API_KEY=<key>
59-
## it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
59+
# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
60+
AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=<text-embedding-3-large-deployment-name>
6061
AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
6162
AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
6263
AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
@@ -111,7 +112,7 @@ CODERABBIT_API_KEY=<coderabbitai-api-key>
111112
ENABLE_METRICS=[true]
112113
ENABLE_LEARNINGS=[true]
113114
# if using CodeRabbit's learnings, also provide the following
114-
# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
115+
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
115116
OBJECT_STORE_URI=[<object-store-uri>]
116117

117118
JIRA_HOST=[<jira-host-url>]

‎docs/self-hosted/github.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ LLM_PROVIDER=azure-openai
6767
LLM_TIMEOUT=360000
6868
AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
6969
AZURE_OPENAI_API_KEY=<key>
70-
# it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
70+
# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
71+
AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=<text-embedding-3-large-deployment-name>
7172
AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
7273
AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
7374
AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
@@ -129,7 +130,7 @@ CODERABBIT_API_KEY=<coderabbitai-api-key>
129130
ENABLE_METRICS=[true]
130131
ENABLE_LEARNINGS=[true]
131132
# if using CodeRabbit's learnings, also provide the following
132-
# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
133+
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
133134
OBJECT_STORE_URI=[<object-store-uri>]
134135

135136
JIRA_HOST=[<jira-host-url>]

‎docs/self-hosted/gitlab.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ LLM_PROVIDER=azure-openai
6262
LLM_TIMEOUT=360000
6363
AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
6464
AZURE_OPENAI_API_KEY=<key>
65-
## it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
65+
# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
66+
AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=<text-embedding-3-large-deployment-name>
6667
AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
6768
AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
6869
AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
@@ -113,14 +114,17 @@ SELF_HOSTED=gitlab
113114

114115
GITLAB_BOT_TOKEN=<personal-access-token>
115116
GITLAB_WEBHOOK_SECRET=<webhook-secret-key>
117+
# if seeing '500 Internal Server Error' in CodeRabbit logs when trying to post review comments,
118+
# make sure to set the following environment variable to 1500 (1.5 seconds).
119+
GITLAB_PUBLISH_DELAY=[<delay-ms-between-draft-and-publish>]
116120

117121
CODERABBIT_LICENSE_KEY=<license-key>
118122

119123
CODERABBIT_API_KEY=<coderabbitai-api-key>
120124
ENABLE_METRICS=[true]
121125
ENABLE_LEARNINGS=[true]
122126
# if using CodeRabbit's learnings, also provide the following
123-
# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
127+
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
124128
OBJECT_STORE_URI=[<object-store-uri>]
125129

126130
JIRA_HOST=[<jira-host-url>]

‎docs/tools/checkmake.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Checkmake
3+
sidebar_label: Checkmake
4+
description: CodeRabbit's guide to Checkmake.
5+
---
6+
7+
```mdx-code-block
8+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
9+
10+
<ProPlanNotice />
11+
```
12+
13+
[Checkmake](https://github.com/mrtazz/checkmake) is a linter for Makefiles.
14+
15+
## Files
16+
17+
Checkmake will run checks against any `Makefile`.
18+
19+
## Configuration
20+
21+
Checkmake supports the following config files:
22+
23+
- `checkmake.yml`
24+
- `checkmake.yaml`
25+
26+
CodeRabbit will use the default settings based on the profile selected if no config file is found.
27+
28+
## Links
29+
30+
- [Checkmake Configuration](https://github.com/mrtazz/checkmake#configuration)

‎docs/tools/htmlhint.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: HTMLHint
3+
sidebar_label: HTMLHint
4+
description: CodeRabbit's guide to HTMLHint.
5+
---
6+
7+
```mdx-code-block
8+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
9+
10+
<ProPlanNotice />
11+
```
12+
13+
[HTMLHint](https://htmlhint.com/) is a static code analysis tool for HTML.
14+
15+
## Files
16+
17+
HTMLHint will run checks against `*.html` files.
18+
19+
## Configuration
20+
21+
HTMLHint supports the following config files:
22+
23+
- `.htmlhintrc`
24+
- `.htmlhintrc.json`
25+
- `htmlhintrc.json`
26+
27+
CodeRabbit will use the default settings based on the profile selected if no config file is found.
28+
29+
## Links
30+
31+
- [HTMLHint Configuration](https://htmlhint.com/docs/user-guide/getting-started)

‎docs/tools/list.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,14 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
2323
| GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
2424
| Go | [golangci-lint][golangci-lint] | Code Quality |
2525
| Helm | [Checkov][Checkov] | Code Security |
26+
| HTML | [HTMLHint][HTMLHint] | Code Quality |
2627
| Javascript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
2728
| JSON, JSONC | [Biome][Biome] | Code Quality |
2829
| JSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
2930
| Kotlin | [detekt][detekt] | Code Quality |
3031
| Kubernetes | [Checkov][Checkov] | Code Security |
3132
| Lua | [Luacheck][Luacheck] | Code Quality |
33+
| Makefile | [Checkmake][Checkmake] | Code Quality |
3234
| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
3335
| PHP | [PHPStan][PHPStan] | Code Quality |
3436
| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
@@ -80,3 +82,5 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
8082
[Clippy]: /tools/clippy.md
8183
[Pylint]: /tools/pylint.md
8284
[DotenvLinter]: /tools/dotenv.md
85+
[HTMLHint]: /tools/htmlhint.md
86+
[Checkmake]: /tools/checkmake.md

‎static/schema/schema.v2.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -908,6 +908,36 @@
908908
"additionalProperties": false,
909909
"default": {},
910910
"description": "dotenv-linter is a tool for checking and fixing .env files for problems and best practices"
911+
},
912+
"htmlhint": {
913+
"type": "object",
914+
"properties": {
915+
"enabled": {
916+
"type": "boolean",
917+
"default": true,
918+
"description": "Enable HTMLHint | HTMLHint is a static code analysis tool for HTML files. | Enable HTMLHint integration. | v1.5.0"
919+
},
920+
"config_file": {
921+
"type": "string",
922+
"description": "Optional path to the HTMLHint configuration file relative to the repository. This is useful when the configuration file is named differently than the default '.htmlhintrc'."
923+
}
924+
},
925+
"additionalProperties": false,
926+
"description": "HTMLHint is a static code analysis tool for HTML files.",
927+
"default": {}
928+
},
929+
"checkmake": {
930+
"type": "object",
931+
"properties": {
932+
"enabled": {
933+
"type": "boolean",
934+
"default": true,
935+
"description": "Enable checkmake | checkmake is a linter for Makefiles. | v0.2.2"
936+
}
937+
},
938+
"additionalProperties": false,
939+
"default": {},
940+
"description": "checkmake is a linter for Makefiles."
911941
}
912942
},
913943
"additionalProperties": false,

0 commit comments

Comments
 (0)