Merge branch 'main' into feature/issue/160

Author: syedalinaqihasni

docs/changelog.md

@@ -5,6 +5,18 @@ description: The latest updates and changes to CodeRabbit.
 sidebar_position: 13
 ---
 
+## May 25, 2025
+
+### New Security and Code Quality Tools
+
+We're excited to announce the addition of two powerful tools to our static analysis arsenal:
+
+- **Brakeman**: A static analysis security vulnerability scanner for Ruby on Rails applications. It helps identify security issues in your Ruby codebase by analyzing Gemfile, Ruby files (_.rb), and ERB templates (_.erb).
+
+- **Clippy**: The official linter for Rust code, helping catch common mistakes and improve your Rust code quality. It analyzes \*.rs files and supports configuration through clippy.toml files.
+
+Both tools can be configured through their respective config files or through CodeRabbit's settings page. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details.
+
 ## May 19, 2025
 
 ### Lua Support with Luacheck

docs/platforms/github-enterprise-server.md

@@ -111,6 +111,7 @@ steps below to
        - Pull request review thread
        - Push
        - Release
+   - **Where can this GitHub App be installed?**: Select `Any account`
 6. Click **Create GitHub App**.
 
 Once the GitHub App has been created, click on **Generate a new client secret**
@@ -170,3 +171,19 @@ Use this CodeRabbit IP if your instance requires IP whitelisting
 
 VPN tunneling is available as an add-on package. Please reach out to us at
 [contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested.
+
+### **FAQ**
+
+#### Who should create the OAuth App and GitHub App?
+
+The OAuth App and GitHub App should be created by a user with administrative
+privileges on the GitHub Enterprise Server instance. This user will be responsible for managing the integration with CodeRabbit.
+
+#### I see an error when trying to log in to CodeRabbit. What should I do?
+
+If you encounter an error during the login process, please ensure that:
+
+- The OAuth App and GitHub App are correctly configured with the right URLs and permissions.
+- The browser local storage and cookies related to CodeRabbit are cleared.
+
+If the issue persists, contact our support team.

docs/self-hosted/azure-devops.md

@@ -64,7 +64,7 @@ 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 deployments, gpt-4.1 (optionally).
+## it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
 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>
@@ -96,6 +96,7 @@ HTTPS_PROXY=[<https-proxy-url>]
 NO_PROXY=[<no-proxy-url>]
 
 # if using AWS Bedrock
+# it is required to have access to claude-3-haiku, claude-3-5-haiku, claude-sonnet-4, claude-opus-4.
 LLM_PROVIDER=bedrock-anthropic
 LLM_TIMEOUT=360000
 AWS_ACCESS_KEY_ID=<aws-access-key>

docs/self-hosted/bitbucket.md

@@ -56,7 +56,7 @@ 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 deployments, gpt-4.1 (optionally).
+## it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
 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>
@@ -88,6 +88,7 @@ HTTPS_PROXY=[<https-proxy-url>]
 NO_PROXY=[<no-proxy-url>]
 
 # if using AWS Bedrock
+# it is required to have access to claude-3-haiku, claude-3-5-haiku, claude-sonnet-4, claude-opus-4.
 LLM_PROVIDER=bedrock-anthropic
 LLM_TIMEOUT=360000
 AWS_ACCESS_KEY_ID=<aws-access-key>

docs/self-hosted/github.md

@@ -67,7 +67,7 @@ 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 deployments, gpt-4.1 (optionally).
+# it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
 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>
@@ -99,6 +99,7 @@ HTTPS_PROXY=[<https-proxy-url>]
 NO_PROXY=[<no-proxy-url>]
 
 # if using AWS Bedrock
+# it is required to have access to claude-3-haiku, claude-3-5-haiku, claude-sonnet-4, claude-opus-4.
 LLM_PROVIDER=bedrock-anthropic
 LLM_TIMEOUT=360000
 AWS_ACCESS_KEY_ID=<aws-access-key>

docs/self-hosted/gitlab.md

@@ -62,7 +62,7 @@ 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 deployments, gpt-4.1 (optionally).
+## it is recommended to deploy gpt-4.1-mini, o4-mini, o3, gpt-4.1 (optionally).
 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>
@@ -94,6 +94,7 @@ HTTPS_PROXY=[<https-proxy-url>]
 NO_PROXY=[<no-proxy-url>]
 
 # if using AWS Bedrock
+# it is required to have access to claude-3-haiku, claude-3-5-haiku, claude-sonnet-4, claude-opus-4.
 LLM_PROVIDER=bedrock-anthropic
 LLM_TIMEOUT=360000
 AWS_ACCESS_KEY_ID=<aws-access-key>

docs/tools/brakeman.md

@@ -0,0 +1,40 @@
+---
+title: Brakeman
+sidebar_label: Brakeman
+description: CodeRabbit's guide to Brakeman.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+<ProPlanNotice />
+```
+
+[Brakeman](https://brakemanscanner.org/) is a static analysis tool which checks Ruby on Rails applications for security vulnerabilities. It scans your application's code for potential security issues and provides detailed reports about any vulnerabilities it finds.
+
+## Supported Files
+
+Brakeman will run on files with the following extensions:
+
+- `Gemfile`
+- `*.rb`
+- `*.erb`
+
+## Features
+
+Brakeman can detect many critical vulnerabilities such as:
+
+- SQL injection
+- Cross-site scripting (XSS)
+- Mass assignment
+- Remote code execution
+- And many more security vulnerabilities
+- Out of date package versions
+- Etc
+
+## Links
+
+- [Brakeman Official Website](https://brakemanscanner.org/)
+- [Brakeman GitHub Repository](https://github.com/presidentbeef/brakeman)
+- [Brakeman Documentation](https://brakemanscanner.org/docs/)
+- [Warning Types](https://brakemanscanner.org/docs/warning_types/)

docs/tools/clippy.md

@@ -0,0 +1,50 @@
+---
+title: Clippy
+sidebar_label: Clippy
+description: CodeRabbit's guide to Clippy.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+<ProPlanNotice />
+```
+
+[Clippy](https://github.com/rust-lang/rust-clippy) is a collection of lints to catch common mistakes and improve your Rust code. It is the official linter for the Rust programming language.
+
+## Supported Files
+
+Clippy will run on files with the following extensions:
+
+- `*.rs`
+
+## Configuration
+
+Clippy supports the following configuration files:
+
+- `clippy.toml`
+- `.clippy.toml`
+
+:::note
+
+Clippy does not require configuration to run. If no configuration file is found, it will use default settings.
+
+A Cargo.toml is required.
+
+:::
+
+## Features
+
+Clippy can detect many code quality issues such as:
+
+- Style violations
+- Common mistakes
+- Performance issues
+- Deprecated code patterns
+- And many more Rust-specific issues
+
+## Links
+
+- [Clippy GitHub Repository](https://github.com/rust-lang/rust-clippy)
+- [Clippy Documentation](https://rust-lang.github.io/rust-clippy/master/)
+- [Available Lints](https://rust-lang.github.io/rust-clippy/master/index.html)

docs/tools/list.md

@@ -35,7 +35,8 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
 | Protobuf                    | [Buf][Buf]                                                 | Code Quality                                        |
 | Python                      | [Ruff][Ruff]                                               | Code Quality                                        |
 | Regal                       | [Regal][Regal]                                             | Code Quality                                        |
-| Ruby                        | [RuboCop][RuboCop]                                         | Code Quality                                        |
+| Ruby                        | [RuboCop][RuboCop], [Brakeman][Brakeman]                   | Code Quality, Code Security                         |
+| Rust                        | [Clippy][Clippy]                                           | Code Quality                                        |
 | Semgrep                     | [Semgrep][Semgrep]                                         | Code Security                                       |
 | Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck]                                   | Code Quality                                        |
 | Shopify                     | [Shopify CLI][ShopifyCLI]                                  | Code Quality                                        |
@@ -74,3 +75,5 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
 [oxlint]: /tools/oxlint.md
 [ShopifyCLI]: /tools/shopify-cli.md
 [Luacheck]: /tools/luacheck.md
+[Brakeman]: /tools/brakeman.md
+[Clippy]: /tools/clippy.md