Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Commit b1678e7

Browse files
jmacdotorgjmacdotorg
authored
Merge branch 'main' into best-practices
2 parents a17241b + 94f88f3 commit b1678e7

File tree

9 files changed

+120
-8
lines changed

9 files changed

+120
-8
lines changed

‎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/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)
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