Merge branch 'main' into best-practices

Author: jmacdotorg

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

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>]

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>]

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>]

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>]

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)

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)

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

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,