Merge branch 'main' into rbac

jmacdotorg · web-flow · commit c30fd69751ee · 2025-06-11T17:07:21.000-04:00
diff --git a/README.md b/README.md
@@ -37,20 +37,25 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
 
 ## Getting Started
 
-1. Clone this repository:
+1. Make sure that you have the following prerequisites installed:
+
+   - [Node.js](https://nodejs.org/)
+   - [pnpm](https://pnpm.io/installation)
+
+2. Clone this repository:
 
    ```sh
    git clone https://github.com/coderabbit-ai/coderabbit-docs.git
    cd coderabbit-docs
    ```
 
-2. Install dependencies:
+3. Install Node.js dependencies using `pnpm`:
 
    ```sh
    pnpm install
    ```
 
-3. Start the development server:
+4. Start the development server:
 
    ```sh
    pnpm start
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -5,6 +5,16 @@ description: The latest updates and changes to CodeRabbit.
 sidebar_position: 13
 ---
 
+## June 11, 2025
+
+### Enhanced Static Analysis: HTMLHint and Checkmake Support
+
+We're excited to announce that two new static analysis tools are now supported on CodeRabbit!
+
+- [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.
+
+- [Checkmake](https://github.com/mrtazz/checkmake) is a linter for Makefiles that helps ensure your build scripts follow best practices and maintain consistency.
+
 ## June 5, 2025
 
 ### Enhanced Static Analysis: Dotenv Linter and Pylint Support
diff --git a/docs/finishing-touches/docstrings.md b/docs/finishing-touches/docstrings.md
@@ -50,36 +50,32 @@ code_generation:
 
 These software forges are supported:
 
-- [x] Azure DevOps
-- [ ] Bitbucket Cloud
-- [ ] Bitbucket Data Center
-- [x] GitHub
-- [x] GitLab
+- Azure DevOps
+- GitHub
+- GitLab
 
 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.
 
 ## Supported languages
 
 These languages are supported:
 
-- [x] Bash
-- [x] C
-- [x] C#
-- [x] C++
-- [x] Elixir
-- [x] Go
-- [ ] Haskell
-- [x] Java
-- [x] JavaScript
-- [x] Kotlin
-- [x] Lua
-- [x] Php
-- [x] Python
-- [x] React TypeScript
-- [x] Ruby
-- [x] Rust
-- [ ] Scala
-- [x] Swift
-- [x] TypeScript
+- Bash
+- C
+- C#
+- C++
+- Elixir
+- Go
+- Java
+- JavaScript
+- Kotlin
+- Lua
+- Php
+- Python
+- React TypeScript
+- Ruby
+- Rust
+- Swift
+- TypeScript
 
 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.
diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md
@@ -30,7 +30,7 @@ Create a new, private repository on GitHub. Name the new repository `coderabbit-
 
 To integrate CodeRabbit with your GitHub account, follow these steps:
 
-1. Visit [the CodeRabbit login page](https://app.coderabbit.ai/login).
+1. Visit [the CodeRabbit login page](https://app.coderabbit.ai/login?free-trial).
 1. Click **Login with GitHub**.
 1. Click **Authorize coderabbitai**.
 
diff --git a/docs/getting-started/support.md b/docs/getting-started/support.md
@@ -14,7 +14,7 @@ All CodeRabbit users have access to the [CodeRabbit Discord Server](http://disco
 ## Support Tickets
 
 :::tip
-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.
+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.
 :::
 
 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.
diff --git a/docs/guides/install-vscode.md b/docs/guides/install-vscode.md
@@ -14,7 +14,7 @@ The instructions on this page are specific to using the extension with VSCode. I
 
 Before you can use the CodeRabbit VSCode extension, you need a CodeRabbit account.
 
-If you don't already have an account, you can create one by visiting [the CodeRabbit login page](https://app.coderabbit.ai/login).
+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).
 
 ## Install the extension
 
diff --git a/docs/overview/why-coderabbit.md b/docs/overview/why-coderabbit.md
@@ -57,7 +57,7 @@ Your intelligent code review companion that understands context.
 > 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).
 
 :::info Get Started
-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.
+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.
 :::
 
 ## CodeRabbit is Context-Aware
@@ -432,9 +432,9 @@ Try CodeRabbit on your next pull request. Experience how AI-powered code review
 
 > 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.
 
-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.
+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.
 
 <div style={{display: 'flex', gap: '10px', marginTop: '20px'}}>
-  <a href="https://app.coderabbit.ai/login" className="button button--primary button--lg">Sign Up Free</a>
+  <a href="https://app.coderabbit.ai/login?free-trial" className="button button--primary button--lg">Sign Up Free</a>
   <a href="https://discord.gg/coderabbit" className="button button--secondary button--lg">Join Discord</a>
 </div>
diff --git a/docs/platforms/bitbucket-cloud.md b/docs/platforms/bitbucket-cloud.md
@@ -18,9 +18,9 @@ This guide will assist you in effectively integrating CodeRabbit with Bitbucket
 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.
 
 1. Create a new Bitbucket account specifically for CodeRabbit and treat it as a service account.
-1. Name the account "CodeRabbit".
-1. If your Bitbucket workspace requires two-step verification, then you must also enable two-step verification on this new account.
-1. Generate an App Password to enable seamless integration between CodeRabbit and your Bitbucket repositories.
+2. Name the account "CodeRabbit".
+3. If your Bitbucket workspace requires two-step verification, then you must also enable two-step verification on this new account.
+4. Generate an App Password to enable seamless integration between CodeRabbit and your Bitbucket repositories.
 
 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.
 
diff --git a/docs/platforms/github-com.md b/docs/platforms/github-com.md
@@ -53,7 +53,7 @@ If you opt to authorize all repositories during setup, CodeRabbit will automatic
 
 ### 5. CodeRabbit Configuration
 
-You can configure CodeRabbit through a YAML file or using the [App's UI](https://app.coderabbit.ai/login).
+You can configure CodeRabbit through a YAML file or using the [App's UI](https://app.coderabbit.ai/login?free-trial).
 
 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.
 
diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md
@@ -32,4 +32,4 @@ CodeRabbit supports various Git platforms to provide code review for your reposi
 | Bitbucket Datacenter | [Supported](../self-hosted/bitbucket.md) |
 | Bitbucket Cloud      | [Supported](./bitbucket-cloud.md)        |
 
-[login]: https://app.coderabbit.ai/login
+[login]: https://app.coderabbit.ai/login?free-trial
diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md
@@ -64,7 +64,8 @@ LLM_PROVIDER=azure-openai
 LLM_TIMEOUT=360000
 AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
 AZURE_OPENAI_API_KEY=<key>
-## it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=<text-embedding-3-large-deployment-name>
 AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
 AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
 AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
@@ -116,7 +117,7 @@ CODERABBIT_API_KEY=<coderabbitai-api-key>
 ENABLE_METRICS=[true]
 ENABLE_LEARNINGS=[true]
 # if using CodeRabbit's learnings, also provide the following
-# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
 OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md
@@ -56,7 +56,8 @@ LLM_PROVIDER=azure-openai
 LLM_TIMEOUT=360000
 AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
 AZURE_OPENAI_API_KEY=<key>
-## it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=<text-embedding-3-large-deployment-name>
 AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
 AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
 AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
@@ -111,7 +112,7 @@ CODERABBIT_API_KEY=<coderabbitai-api-key>
 ENABLE_METRICS=[true]
 ENABLE_LEARNINGS=[true]
 # if using CodeRabbit's learnings, also provide the following
-# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
 OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md
@@ -67,7 +67,8 @@ LLM_PROVIDER=azure-openai
 LLM_TIMEOUT=360000
 AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
 AZURE_OPENAI_API_KEY=<key>
-# it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=<text-embedding-3-large-deployment-name>
 AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
 AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
 AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
@@ -129,7 +130,7 @@ CODERABBIT_API_KEY=<coderabbitai-api-key>
 ENABLE_METRICS=[true]
 ENABLE_LEARNINGS=[true]
 # if using CodeRabbit's learnings, also provide the following
-# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
 OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md
@@ -62,7 +62,8 @@ LLM_PROVIDER=azure-openai
 LLM_TIMEOUT=360000
 AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
 AZURE_OPENAI_API_KEY=<key>
-## it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+# it is recommended to deploy text-embedding-3-large, gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
+AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=<text-embedding-3-large-deployment-name>
 AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
 AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
 AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
@@ -113,14 +114,17 @@ SELF_HOSTED=gitlab
 
 GITLAB_BOT_TOKEN=<personal-access-token>
 GITLAB_WEBHOOK_SECRET=<webhook-secret-key>
+# if seeing '500 Internal Server Error' in CodeRabbit logs when trying to post review comments,
+# make sure to set the following environment variable to 1500 (1.5 seconds).
+GITLAB_PUBLISH_DELAY=[<delay-ms-between-draft-and-publish>]
 
 CODERABBIT_LICENSE_KEY=<license-key>
 
 CODERABBIT_API_KEY=<coderabbitai-api-key>
 ENABLE_METRICS=[true]
 ENABLE_LEARNINGS=[true]
 # if using CodeRabbit's learnings, also provide the following
-# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
 OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
diff --git a/docs/tools/checkmake.md b/docs/tools/checkmake.md
@@ -0,0 +1,30 @@
+---
+title: Checkmake
+sidebar_label: Checkmake
+description: CodeRabbit's guide to Checkmake.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+<ProPlanNotice />
+```
+
+[Checkmake](https://github.com/mrtazz/checkmake) is a linter for Makefiles.
+
+## Files
+
+Checkmake will run checks against any `Makefile`.
+
+## Configuration
+
+Checkmake supports the following config files:
+
+- `checkmake.yml`
+- `checkmake.yaml`
+
+CodeRabbit will use the default settings based on the profile selected if no config file is found.
+
+## Links
+
+- [Checkmake Configuration](https://github.com/mrtazz/checkmake#configuration)
diff --git a/docs/tools/htmlhint.md b/docs/tools/htmlhint.md
@@ -0,0 +1,31 @@
+---
+title: HTMLHint
+sidebar_label: HTMLHint
+description: CodeRabbit's guide to HTMLHint.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+<ProPlanNotice />
+```
+
+[HTMLHint](https://htmlhint.com/) is a static code analysis tool for HTML.
+
+## Files
+
+HTMLHint will run checks against `*.html` files.
+
+## Configuration
+
+HTMLHint supports the following config files:
+
+- `.htmlhintrc`
+- `.htmlhintrc.json`
+- `htmlhintrc.json`
+
+CodeRabbit will use the default settings based on the profile selected if no config file is found.
+
+## Links
+
+- [HTMLHint Configuration](https://htmlhint.com/docs/user-guide/getting-started)
diff --git a/docs/tools/list.md b/docs/tools/list.md
@@ -23,12 +23,14 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
 | GitLab Pipelines            | [Pipeline Remediation][Pipeline]                           | CI/CD Failure Remediation                           |
 | Go                          | [golangci-lint][golangci-lint]                             | Code Quality                                        |
 | Helm                        | [Checkov][Checkov]                                         | Code Security                                       |
+| HTML                        | [HTMLHint][HTMLHint]                                       | Code Quality                                        |
 | Javascript                  | [Biome][Biome], [oxlint][oxlint]                           | Code Quality                                        |
 | JSON, JSONC                 | [Biome][Biome]                                             | Code Quality                                        |
 | JSX                         | [Biome][Biome], [oxlint][oxlint]                           | Code Quality                                        |
 | Kotlin                      | [detekt][detekt]                                           | Code Quality                                        |
 | Kubernetes                  | [Checkov][Checkov]                                         | Code Security                                       |
 | Lua                         | [Luacheck][Luacheck]                                       | Code Quality                                        |
+| Makefile                    | [Checkmake][Checkmake]                                     | Code Quality                                        |
 | Markdown                    | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking                      |
 | PHP                         | [PHPStan][PHPStan]                                         | Code Quality                                        |
 | Plaintext                   | [LanguageTool][LanguageTool]                               | Grammar and Spell Checking                          |
@@ -80,3 +82,5 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
 [Clippy]: /tools/clippy.md
 [Pylint]: /tools/pylint.md
 [DotenvLinter]: /tools/dotenv.md
+[HTMLHint]: /tools/htmlhint.md
+[Checkmake]: /tools/checkmake.md
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
@@ -908,6 +908,36 @@
 									"additionalProperties": false,
 									"default": {},
 									"description": "dotenv-linter is a tool for checking and fixing .env files for problems and best practices"
+								},
+								"htmlhint": {
+									"type": "object",
+									"properties": {
+										"enabled": {
+											"type": "boolean",
+											"default": true,
+											"description": "Enable HTMLHint | HTMLHint is a static code analysis tool for HTML files. | Enable HTMLHint integration. | v1.5.0"
+										},
+										"config_file": {
+											"type": "string",
+											"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'."
+										}
+									},
+									"additionalProperties": false,
+									"description": "HTMLHint is a static code analysis tool for HTML files.",
+									"default": {}
+								},
+								"checkmake": {
+									"type": "object",
+									"properties": {
+										"enabled": {
+											"type": "boolean",
+											"default": true,
+											"description": "Enable checkmake | checkmake is a linter for Makefiles. | v0.2.2"
+										}
+									},
+									"additionalProperties": false,
+									"default": {},
+									"description": "checkmake is a linter for Makefiles."
 								}
 							},
 							"additionalProperties": false,
