Merge branch 'refs/heads/main' into add_azure_devops_saas_page

petrisorcoderabbit · petrisorcoderabbit · commit 4b24fe057d3f · 2024-08-30T19:34:13.000+03:00
diff --git a/docs/about/pricing.md b/docs/about/pricing.md
@@ -1,8 +1,7 @@
 ---
 title: Pricing
 sidebar_label: Pricing
-description:
-  Learn about the plans, pricing, and subscription management of CodeRabbit.
+description: Learn about the plans, pricing, and subscription management of CodeRabbit.
 ---
 
 This section covers the plans, pricing, and subscription management of
diff --git a/docs/guides/ondemand-reports.md b/docs/guides/ondemand-reports.md
@@ -1,8 +1,7 @@
 ---
 title: On-demand Reports
 sidebar_label: On-demand Reports (Beta)
-description:
-  CodeRabbit offers a way to generate on-demand reports using a simple API request
+description: CodeRabbit offers a way to generate on-demand reports using a simple API request
 sidebar_position: 6
 ---
 
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -14,7 +14,6 @@ slug: "/"
   <iframe src="https://www.youtube.com/embed/3SyUOSebG7E?si=i0oT9RAnH0PW81lY" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen></iframe>
 </div>
 
-
 **CodeRabbit** is an innovative, AI-first code reviewer. It provides
 context-aware review feedback on a pull request within minutes, thereby
 significantly reducing the time and effort associated with manual code reviews.
diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md
@@ -10,28 +10,28 @@ CodeRabbit supports various Git platforms to provide code review for your reposi
 ## GitHub
 
 | Host                     | Support                            |
-|--------------------------|------------------------------------|
+| ------------------------ | ---------------------------------- |
 | GitHub.com               | [Supported][login]                 |
 | GitHub Enterprise Server | [Supported](self-hosted-github.md) |
 
 ## GitLab
 
 | Host                | Support                            |
-|---------------------|------------------------------------|
+| ------------------- | ---------------------------------- |
 | GitLab.com          | [Supported](saas-gitlab.md)        |
 | GitLab Self Managed | [Supported](self-hosted-gitlab.md) |
 
 ## Azure DevOps
 
 | Host                | Support     |
-|---------------------|-------------|
+| ------------------- | ----------- |
 | Azure DevOps Cloud  | Coming soon |
 | Azure DevOps Server | Coming soon |
 
 ## Bitbucket
 
 | Host                  | Support     |
-|-----------------------|-------------|
+| --------------------- | ----------- |
 | Cloud                 | Coming soon |
 | Bitbucket Data Center | Coming soon |
 
diff --git a/docs/platforms/saas-gitlab.md b/docs/platforms/saas-gitlab.md
@@ -39,18 +39,18 @@ If your organization opts to use another user within the organization, you can d
 
 #### Recommendations
 
-* **Create a dedicated user for CodeRabbit** - This ensures the user is exclusively for CodeRabbit, allowing better access control.
-* **Use "CodeRabbit" as the username** - This makes the user easily recognizable for future reference.
-* **Use a dedicated email address** - This helps in easy identification and management.
-* **Use the CodeRabbit logo as the profile picture** - This further ensures easy recognition. You can download our logo from [here](/img/integrations/logo.svg "download").
+- **Create a dedicated user for CodeRabbit** - This ensures the user is exclusively for CodeRabbit, allowing better access control.
+- **Use "CodeRabbit" as the username** - This makes the user easily recognizable for future reference.
+- **Use a dedicated email address** - This helps in easy identification and management.
+- **Use the CodeRabbit logo as the profile picture** - This further ensures easy recognition. You can download our logo from [here](/img/integrations/logo.svg "download").
 
 #### Key Points to Remember
 
-* Personal access tokens have expiration dates. Ensure the expiration date covers the duration of your intended use of the CodeRabbit app.
-* Code reviews will be attributed to the owner of the personal access token.
-* If the personal access token expires, you can add a new one via the CodeRabbit UI:
-  * Navigate to the "GitLab User" page in the sidebar.
-  * Click the "Update" button on the displayed card to see the same modal as the initial login.
+- Personal access tokens have expiration dates. Ensure the expiration date covers the duration of your intended use of the CodeRabbit app.
+- Code reviews will be attributed to the owner of the personal access token.
+- If the personal access token expires, you can add a new one via the CodeRabbit UI:
+  - Navigate to the "GitLab User" page in the sidebar.
+  - Click the "Update" button on the displayed card to see the same modal as the initial login.
 
 ### Generating a Personal Access Token
 
@@ -63,7 +63,7 @@ GitLab provides an option to generate a personal access token for a new user. Fo
 5. Click "Add New Token."
 6. Enter a name and an expiry date for the token.
 7. If no expiry date is entered, it defaults to 365 days from the current date.
-8. Ensure the following scopes are selected: `api`, `user`, `email`.
+8. Ensure the following scopes are selected: `api`, `read_api`, `read_user`.
 9. Click "Create Personal Access Token."
 10. Note down the token as it will only be displayed once.
 
diff --git a/docs/platforms/self-hosted-github.md b/docs/platforms/self-hosted-github.md
@@ -20,7 +20,7 @@ complete, you can log in directly.
 
 ### **Step 1: Getting Started**
 
-**Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and 
+**Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and
 select Self-Hosted GitHub
 
 ![login-page](/img/integrations/login-self-hosted-github.png)
diff --git a/docs/platforms/self-hosted-gitlab.md b/docs/platforms/self-hosted-gitlab.md
@@ -12,6 +12,8 @@ To initiate the integration, we require specific information. This is essential
 for the initial setup of CodeRabbit within your domain. Once this setup is
 complete, you can log in directly using the OAuth2 flow.
 
+CodeRabbit supports GitLab `16.x` and above. Version `15.x` may experience unexpected issues such as review comments not being posted or the sign up process not working at all. While we won't block the integration, we recommend upgrading your GitLab instance to obtain the intended experience.
+
 ### **Step 1: Getting Started**
 
 **Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and
diff --git a/docs/tools/detekt.md b/docs/tools/detekt.md
@@ -15,7 +15,7 @@ Detekt will run on files with the following extensions:
 
 ## Configuration
 
-Detekt uses a YAML style configuration file.  
+Detekt uses a YAML style configuration file.
 
 Detekt supports the following config files:
 
diff --git a/docs/tools/regal.md b/docs/tools/regal.md
@@ -0,0 +1,25 @@
+---
+title: Regal
+sidebar_label: Regal
+description: CodeRabbit's guide to Regal.
+---
+
+[Regal](https://docs.styra.com/regal/) is a linter and language server for Rego.
+
+## Files
+
+Regal will run on files with the following extensions:
+
+- `.rego`
+
+## Configuration
+
+Regal uses a YAML style configuration file. We look for the following config file:
+
+- `.regal/config.yaml`
+
+CodeRabbit will use the default settings based on the profile selected if no config file is found.
+
+## Links
+
+- [Regal Configuration](https://docs.styra.com/regal#configuration/)
diff --git a/docs/tools/tools.md b/docs/tools/tools.md
@@ -37,12 +37,12 @@ Remove extraneous f prefix
 ## Supported Tools
 
 | Technology                  | Tools                                                      |
-|:----------------------------|:-----------------------------------------------------------|
+| :-------------------------- | :--------------------------------------------------------- |
 | All                         | [Gitleaks][Gitleaks]                                       |
-| GitHub Actions              | [Actionlint][Actionlint]                                   |
 | CloudFormation              | [Checkov][Checkov]                                         |
 | CSS                         | [Biome][Biome]                                             |
 | Docker                      | [Hadolint][Hadolint], [Checkov][Checkov]                   |
+| GitHub Actions              | [Actionlint][Actionlint]                                   |
 | Go                          | [golangci-lint][golangci-lint]                             |
 | Helm                        | [Checkov][Checkov]                                         |
 | Javascript                  | [Biome][Biome]                                             |
@@ -55,6 +55,7 @@ Remove extraneous f prefix
 | Plaintext                   | [LanguageTool][LanguageTool]                               |
 | Protobuf                    | [Buf][Buf]                                                 |
 | Python                      | [Ruff][Ruff]                                               |
+| Regal                       | [Regal][Regal]                                             |
 | Ruby                        | [Rubocop][Rubocop]                                         |
 | Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck]                                   |
 | Swift                       | [SwiftLint][SwiftLint]                                     |
@@ -63,7 +64,6 @@ Remove extraneous f prefix
 | Typescript                  | [Biome][Biome]                                             |
 | YAML                        | [YamlLint][YamlLint]                                       |
 
-
 [ShellCheck]: ./shellcheck.md
 [Ruff]: ./ruff.md
 [Markdownlint]: ./markdownlint.md
@@ -79,4 +79,5 @@ Remove extraneous f prefix
 [Detekt]: ./detekt.md
 [Rubocop]: ./rubocop.md
 [Buf]: ./buf.md
-[Actionlint]: ./actionlint.md
+[Actionlint]: ./actionlint.md
+[Regal]: ./regal.md
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -26,7 +26,6 @@
     "docusaurus-json-schema-plugin": "^1.12.1",
     "postcss": "^8.4.32",
     "prism-react-renderer": "^2.3.0",
-    "react": "^18.0.0",
     "react-ace": "^12.0.0",
     "react-dom": "^18.0.0",
     "tailwindcss": "^3.4.0"
@@ -35,6 +34,12 @@
     "@docusaurus/module-type-aliases": "^3.1.1",
     "@docusaurus/tsconfig": "^3.1.1",
     "@docusaurus/types": "^3.1.1",
+    "@types/js-yaml": "^4.0.9",
+    "@types/react": "^18.3.4",
+    "ace-builds": "^1.36.1",
+    "ajv": "^8.17.1",
+    "js-yaml": "^4.1.0",
+    "react": "^18.3.1",
     "typescript": "~5.2.2"
   },
   "browserslist": {
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
@@ -576,6 +576,19 @@
 									"default": {},
 									"description": "Buf offers linting for Protobuf files."
 								},
+								"regal": {
+									"type": "object",
+									"properties": {
+										"enabled": {
+											"type": "boolean",
+											"default": true,
+											"description": "Enable Regal | Regal is a linter and language server for Rego. | v0.25.0"
+										}
+									},
+									"additionalProperties": false,
+									"default": {},
+									"description": "Regal is a linter and language server for Rego."
+								},
 								"actionlint": {
 									"type": "object",
 									"properties": {
@@ -674,6 +687,19 @@
 							},
 							"additionalProperties": false,
 							"default": {}
+						},
+						"pull_requests": {
+							"type": "object",
+							"properties": {
+								"scope": {
+									"type": "string",
+									"enum": ["local", "global", "auto"],
+									"default": "auto",
+									"description": "Pull Requests | Specify the scope of pull requests to use for the knowledge base. 'local' uses the repository's pull requests, 'global' uses the organization's pull requests, and 'auto' uses repository's pull requests for public repositories and organization's pull requests for private repositories."
+								}
+							},
+							"additionalProperties": false,
+							"default": {}
 						}
 					},
 					"additionalProperties": false,
