From 63d32bace812ca963efaca1dfbfbc4c017b7cfff Mon Sep 17 00:00:00 2001
From: Aravind Putrevu <aravind.putrevu@gmail.com>
Date: Thu, 12 Dec 2024 17:16:06 +0530
Subject: [PATCH 1/4] docs: add note about Pro-tier tools in knowledge base
---
docs/integrations/knowledge-base.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/docs/integrations/knowledge-base.md b/docs/integrations/knowledge-base.md
index b8e4f1d3..03e35c44 100644
--- a/docs/integrations/knowledge-base.md
+++ b/docs/integrations/knowledge-base.md
@@ -7,6 +7,10 @@ sidebar_position: 4
CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Issues
The issues knowledge base allows CodeRabbit to use the context from linked and related issues while reviewing the code.
From 4ff759dbd4e74835dd7e77612a69dbd3f1d8cc33 Mon Sep 17 00:00:00 2001
From: Aravind Putrevu <aravind.putrevu@gmail.com>
Date: Thu, 12 Dec 2024 17:16:38 +0530
Subject: [PATCH 2/4] docs: add Pro-tier tools note to various tool guides
---
docs/tools/actionlint.md | 4 ++++
docs/tools/biome.md | 4 ++++
docs/tools/buf.md | 4 ++++
docs/tools/checkov.md | 4 ++++
docs/tools/circleci.md | 4 ++++
docs/tools/cppcheck.md | 4 ++++
docs/tools/detekt.md | 4 ++++
docs/tools/eslint.md | 4 ++++
docs/tools/gitleaks.md | 4 ++++
docs/tools/golangci-lint.md | 4 ++++
docs/tools/hadolint.md | 4 ++++
docs/tools/languagetool.md | 4 ++++
docs/tools/markdownlint.md | 4 ++++
docs/tools/phpstan.md | 4 ++++
docs/tools/pmd.md | 4 ++++
docs/tools/regal.md | 4 ++++
docs/tools/rubocop.md | 4 ++++
docs/tools/ruff.md | 4 ++++
docs/tools/semgrep.md | 4 ++++
docs/tools/shellcheck.md | 4 ++++
docs/tools/swiftlint.md | 4 ++++
docs/tools/tools.md | 4 ++++
docs/tools/yamllint.md | 4 ++++
23 files changed, 92 insertions(+)
diff --git a/docs/tools/actionlint.md b/docs/tools/actionlint.md
index c05171f5..c37fc840 100644
--- a/docs/tools/actionlint.md
+++ b/docs/tools/actionlint.md
@@ -7,6 +7,10 @@ description: CodeRabbit's guide to Actionlint.
[Actionlint](https://github.com/rhysd/actionlint/) is a static checker for
GitHub Actions workflow files.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
We look for `GitHub Action` files specifically in the following directory:
diff --git a/docs/tools/biome.md b/docs/tools/biome.md
index 953debee..6605d9fa 100644
--- a/docs/tools/biome.md
+++ b/docs/tools/biome.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Biome.
[Biome](https://biomejs.dev/) is a linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Biome will run on files with the following extensions:
diff --git a/docs/tools/buf.md b/docs/tools/buf.md
index 51fbb446..58073812 100644
--- a/docs/tools/buf.md
+++ b/docs/tools/buf.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Buf.
[Buf](https://buf.build/) offers linting for Protobuf files.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Buf will run on files with the following extensions:
diff --git a/docs/tools/checkov.md b/docs/tools/checkov.md
index 93a7e3d1..42b754f2 100644
--- a/docs/tools/checkov.md
+++ b/docs/tools/checkov.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Checkov.
[Checkov](https://www.checkov.io/) is a static code analysis tool for scanning Infrastructure as Code (IaC) files for misconfigurations.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Checkov will run on files with the following files and extensions:
diff --git a/docs/tools/circleci.md b/docs/tools/circleci.md
index 89fa0714..c22d4f12 100644
--- a/docs/tools/circleci.md
+++ b/docs/tools/circleci.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to CircleCi.
[CircleCi](https://circleci.com/) is a static checker and validator for circleci config files.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
We look for `CircleCi Configuration` files specifically in the following directory:
diff --git a/docs/tools/cppcheck.md b/docs/tools/cppcheck.md
index 105d7bbd..3df7406b 100644
--- a/docs/tools/cppcheck.md
+++ b/docs/tools/cppcheck.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Cppcheck.
[Cppcheck](https://cppcheck.sourceforge.io/) is a static code analysis tool for the C and C++ programming languages.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Cppcheck will run on files with the following extensions:
diff --git a/docs/tools/detekt.md b/docs/tools/detekt.md
index b52e4ae0..a7102e96 100644
--- a/docs/tools/detekt.md
+++ b/docs/tools/detekt.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Detekt.
[Detekt](https://detekt.dev/) is a static code analysis tool specifically designed for Kotlin projects
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Detekt will run on files with the following extensions:
diff --git a/docs/tools/eslint.md b/docs/tools/eslint.md
index bdf6d9b4..40d27d85 100644
--- a/docs/tools/eslint.md
+++ b/docs/tools/eslint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to ESLint.
[ESLint](https://eslint.org/) is a linter for JavaScript, TypeScript, JSX, TSX, CSS, etc.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
ESLint will run on files with the following extensions:
diff --git a/docs/tools/gitleaks.md b/docs/tools/gitleaks.md
index 1e725b06..90b6547e 100644
--- a/docs/tools/gitleaks.md
+++ b/docs/tools/gitleaks.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Gitleaks.
[Gitleaks](https://gitleaks.io/) is a secret-scanner.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Gitleaks will run on all files.
diff --git a/docs/tools/golangci-lint.md b/docs/tools/golangci-lint.md
index 541db7b9..94ef9453 100644
--- a/docs/tools/golangci-lint.md
+++ b/docs/tools/golangci-lint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to golangci-lint.
[golangci-lint](https://golangci-lint.run/) is a fast Go linters runner.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
golangci-lint will run on files with the following extensions:
diff --git a/docs/tools/hadolint.md b/docs/tools/hadolint.md
index 044a561d..da6b6374 100644
--- a/docs/tools/hadolint.md
+++ b/docs/tools/hadolint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Hadolint.
[Hadolint](https://github.com/hadolint/hadolint) is a Dockerfile linter.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Hadolint will run on files with the following file names:
diff --git a/docs/tools/languagetool.md b/docs/tools/languagetool.md
index 8ef4a59f..cfd3cf66 100644
--- a/docs/tools/languagetool.md
+++ b/docs/tools/languagetool.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to LanguageTool.
[LanguageTool](https://github.com/languagetool-org/languagetool) is a style and grammar checker.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
LanguageTool will run on files with the following extensions:
diff --git a/docs/tools/markdownlint.md b/docs/tools/markdownlint.md
index 137eb56b..74e1b460 100644
--- a/docs/tools/markdownlint.md
+++ b/docs/tools/markdownlint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Markdownlint.
[Markdownlint](https://github.com/DavidAnson/markdownlint) is a linter for Markdown.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Markdownlint will run on files with the following extensions:
diff --git a/docs/tools/phpstan.md b/docs/tools/phpstan.md
index a756f4c4..f6f24d4c 100644
--- a/docs/tools/phpstan.md
+++ b/docs/tools/phpstan.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to PHPStan.
[PHPStan](https://phpstan.org/) is a static analysis tool for PHP.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
PHPStan will run on files with the following extensions:
diff --git a/docs/tools/pmd.md b/docs/tools/pmd.md
index 948083d1..65f28004 100644
--- a/docs/tools/pmd.md
+++ b/docs/tools/pmd.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to PMD.
[PMD](https://pmd.github.io/) is an extensible multilanguage static code analyzer. Itβs mainly concerned with Java.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
PMD will run on files with the following extensions:
diff --git a/docs/tools/regal.md b/docs/tools/regal.md
index eeca3664..062b0e96 100644
--- a/docs/tools/regal.md
+++ b/docs/tools/regal.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Regal.
[Regal](https://docs.styra.com/regal/) is a linter and language server for Rego.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Regal will run on files with the following extensions:
diff --git a/docs/tools/rubocop.md b/docs/tools/rubocop.md
index 4172bea4..f770f486 100644
--- a/docs/tools/rubocop.md
+++ b/docs/tools/rubocop.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Rubocop.
[Rubocop](https://rubocop.org/) A Ruby static code analyzer and formatter, based on the community Ruby style guide.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Rubocop will run on the following files and extensions:
diff --git a/docs/tools/ruff.md b/docs/tools/ruff.md
index 255ce816..afb8a7ec 100644
--- a/docs/tools/ruff.md
+++ b/docs/tools/ruff.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Ruff.
[Ruff](https://docs.astral.sh/ruff/) is a linter for Python.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Ruff will run on files with the following extensions:
diff --git a/docs/tools/semgrep.md b/docs/tools/semgrep.md
index 3098082a..1165b7ec 100644
--- a/docs/tools/semgrep.md
+++ b/docs/tools/semgrep.md
@@ -7,6 +7,10 @@ description: CodeRabbit's guide to Semgrep.
[Semgrep](https://semgrep.dev/) is a static analysis tool designed to scan code
for security vulnerabilities and code quality issues.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Configuration
Semgrep uses a YAML style configuration file. By default we will automatically
diff --git a/docs/tools/shellcheck.md b/docs/tools/shellcheck.md
index 752e8675..335401e3 100644
--- a/docs/tools/shellcheck.md
+++ b/docs/tools/shellcheck.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to ShellCheck.
[ShellCheck](https://www.shellcheck.net/) is a linter for shell scripts.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
ShellCheck will run on files with the following extensions:
diff --git a/docs/tools/swiftlint.md b/docs/tools/swiftlint.md
index 516d99af..fad72361 100644
--- a/docs/tools/swiftlint.md
+++ b/docs/tools/swiftlint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to SwiftLint.
[SwiftLint](https://realm.github.io/SwiftLint/) is a linter for Swift.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
SwiftLint will run on files with the following extensions:
diff --git a/docs/tools/tools.md b/docs/tools/tools.md
index 3dce7e93..f2bc1377 100644
--- a/docs/tools/tools.md
+++ b/docs/tools/tools.md
@@ -7,6 +7,10 @@ sidebar_position: 1
CodeRabbit supports various linters and security analysis tools to improve the code review process. The output of these tools is used to enhance the feedback provided by CodeRabbit, making it possible to provide 1-click fixes for common issues.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Enabling/Disabling Tools
You can enable or disable tools by setting `reviews.tools.<tool>.enabled` in your project's `.coderabbit.yaml` file or setting the "Review β Tools β Tool β Enabled" field in CodeRabbit's settings page.
diff --git a/docs/tools/yamllint.md b/docs/tools/yamllint.md
index 962a2a78..ce7a87a3 100644
--- a/docs/tools/yamllint.md
+++ b/docs/tools/yamllint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Yamllint.
[Yamllint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML.
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
## Files
Yamllint will run on files with the following extensions:
From c9aebc8da10a2d11a96772e003ec896d142232ca Mon Sep 17 00:00:00 2001
From: Aravind Putrevu <aravind.putrevu@gmail.com>
Date: Thu, 12 Dec 2024 17:20:22 +0530
Subject: [PATCH 3/4] fix: update GitHub link to point to the correct
repository
---
docusaurus.config.ts | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index 0cc10d8d..affcf507 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -211,7 +211,7 @@ const config: Config = {
position: "right",
},
{
- href: "https://github.com/coderabbitai",
+ href: "https://github.com/coderabbitai/coderabbit-docs",
className: "github-link",
"aria-label": "GitHub",
position: "right",
From 371d446baf06dbdf8f7fb2c9a1246ce2428a7fd4 Mon Sep 17 00:00:00 2001
From: Aravind Putrevu <aravind.putrevu@gmail.com>
Date: Thu, 12 Dec 2024 17:25:29 +0530
Subject: [PATCH 4/4] docs: remove beta label and clarify Pro-tier availability
for on-demand reports
---
docs/guides/ondemand-reports.md | 16 +++++++---------
1 file changed, 7 insertions(+), 9 deletions(-)
diff --git a/docs/guides/ondemand-reports.md b/docs/guides/ondemand-reports.md
index 90c2db2f..10194419 100644
--- a/docs/guides/ondemand-reports.md
+++ b/docs/guides/ondemand-reports.md
@@ -1,6 +1,6 @@
---
title: On-demand Reports
-sidebar_label: On-demand Reports (Beta)
+sidebar_label: On-demand Reports
description: CodeRabbit offers a way to generate on-demand reports using a simple API request
sidebar_position: 6
---
@@ -9,19 +9,17 @@ sidebar_position: 6
import ReportSchema from "@site/src/components/ReportSchema";
```
-:::info
-
-This feature is in beta
+CodeRabbit offers a way to generate on-demand reports using the [CodeRabbit API](https://api.coderabbit.ai/api/swagger/).
+You will need an API Key to access the CodeRabbit API and generate an on-demand report.
+:::note
+Reports are available under [Pro-tier](https://coderabbit.ai/pricing).
:::
-CodeRabbit offers a way to generate on-demand reports using the [CodeRabbit API](https://api.coderabbit.ai/api/swagger/).
-You will need an API Key to access the CodeRabbit API and generate an on-demand report.
-
## Create an API key
-Sign in to your CodeRabbit account and navigate to the [**API Keys**](https://app.coderabbit.ai/settings/api-keys) page under 'Organization Settings' in the left sidebar.
-Click on the **Create API Key** button and enter a name for the API Key.
+Sign in to your CodeRabbit account and navigate to the [**API Keys**](https://app.coderabbit.ai/settings/api-keys) page under 'Organization Settings' in the left sidebar.
+Click on the **Create API Key** button and enter a name for the API Key.
Copy the API key, and keep it safe as it won't be visible again.
