Merge branch 'main' into toc-reviews

NatoBoram · web-flow · commit c04f8c01244d · 2025-07-18T14:45:53.000-04:00
diff --git a/README.md b/README.md
@@ -45,7 +45,7 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
 2. Clone this repository:
 
    ```sh
-   git clone https://github.com/coderabbit-ai/coderabbit-docs.git
+   git clone https://github.com/coderabbitai/coderabbit-docs.git
    cd coderabbit-docs
    ```
 
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -5,6 +5,28 @@ description: The latest updates and changes to CodeRabbit.
 sidebar_position: 13
 ---
 
+## July 17, 2025
+
+### Enhanced Reporting Capabilities
+
+We're excited to announce significant improvements to our reporting system that will make your automated reports more powerful and actionable!
+
+#### Exclusion Filters with NOT_IN Option
+
+Reports now support exclusion filters using the `NOT_IN` option, allowing you to filter out pull requests based on their repository, label, user, or team. This gives you more granular control over what appears in your reports, helping you focus on the most relevant information.
+
+#### Next Steps Section in Daily Standup Reports
+
+We've enhanced the default daily standup report template to include a "Next Steps" section. This provides clear guidance on what actions authors and reviewers should take regarding each pull request or change, making your reports more actionable and helping teams stay on track.
+
+#### CI/CD GitHub Action Check Status Awareness
+
+Reports now include CI/CD GitHub Action check status as a data source. Your reports will be aware of which CI/CD checks are failing or passing, giving you better visibility into the health of your pull requests and helping identify potential issues before they become blockers.
+
+#### Score Card Custom Report Option
+
+We've added a new optional score card report feature that allows you to grade and create report cards for your developers. This custom report optional data source provides a structured way to evaluate developer performance and contributions. See our [custom reports documentation](/guides/custom-reports#remove-prs-without-a-score-cardchart-bot-comment) for more details on how to implement score cards in your reports.
+
 ## July 10, 2025
 
 ### Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks
diff --git a/docs/guides/config-vscode.md b/docs/guides/config-vscode.md
@@ -28,17 +28,21 @@ The **Agent Type** setting lets you choose the extension's response to using the
 
 - **Native**: The extension prompts the AI agent associated with your IDE to apply the suggested fix.
 
-  This works only with VSCode, using Copilot. If you have this option selected when using a different IDE, then the extension instead copies the prompt to your clipboard.
+  This works only with VSCode(using Copilot) and Cursor(you have to start the task). If you have this option selected when using a different IDE, then the extension instead copies the prompt to your clipboard.
 
-- **Claude Code**: The extension opens the Terminal pane of your IDE and tries to use the `claude` command-line program to apply the suggested fix to your code. You need to have Claude Code installed for this option to be effective.
+- **Claude Code**: The extension opens the Terminal pane of your IDE and tries to use the `claude` command-line program to apply the suggested fix to your code. You need to have [Claude Code](https://www.anthropic.com/claude-code) installed for this option to be effective.
 
-- **Codex CLI**: The extension opens the Terminal pane of your IDE and tries to use the `codex` command-line program to apply the suggested fix to your code. You need to have Codex CLI installed for this option to be effective.
+- **Codex CLI**: The extension opens the Terminal pane of your IDE and tries to use the `codex` command-line program to apply the suggested fix to your code. You need to have [Codex CLI](https://github.com/openai/codex) installed for this option to be effective.
 
-- **Cline**: The extension opens the `Cline` sidebar and runs a task to apply the suggested fix to your code. You need to have the `Cline` extension installed for this option to be effective.
+- **OpenCode**: The extension opens the Terminal pane of your IDE and tries to use the `opencode` command-line program to apply the suggested fix to your code. You need to have [OpenCode](https://opencode.ai) installed for this option to be effective.
 
-- **Roo**: The extension opens the `Roo` sidebar and runs a task to apply the suggested fix to your code. You need to have the `Roo` extension installed for this option to be effective.
+- **Cline**: The extension opens the `Cline` sidebar and runs a task to apply the suggested fix to your code. You need to have the [Cline](https://cline.bot/) extension installed for this option to be effective.
 
-- **Kilo Code**: The extension opens the `Kilo Code` sidebar and runs a task to apply the suggested fix to your code. You need to have the `Kilo Code` extension installed for this option to be effective.
+- **Roo**: The extension opens the `Roo` sidebar and runs a task to apply the suggested fix to your code. You need to have the [Roo](https://github.com/RooCodeInc/Roo-Code) extension installed for this option to be effective.
+
+- **Kilo Code**: The extension opens the `Kilo Code` sidebar and runs a task to apply the suggested fix to your code. You need to have the [Kilo Code](https://kilocode.ai/) extension installed for this option to be effective.
+
+- **Augment Code**: The extension opens the `Augment Code` sidebar with the prompt to apply the suggested fix to your code, and you can start the task. You need to have the [Augment Code](https://www.augmentcode.com/) extension installed for this option to be effective.
 
 - **Clipboard**: The extension copies prompt text describing the suggested fix to your clipboard. From there, you can manually paste the prompt into the coding AI agent that you use with your IDE.
 
diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md
@@ -117,6 +117,14 @@ Contained within the `<pr_details>` tag.
   - `<comment_updated_at>`: datetime - The date and time the comment was last updated.
   - `<comment_body>`: markdown - The content of the comment.
 
+#### CI/CD Check Status
+
+- `<pr_checks>`: array of check objects - Contains all CI/CD checks for the PR. _GitHub Only_.
+- `<pr_check>`: object - Each individual check is wrapped in this tag and is an object with the following properties:
+  - `<pr_check_name>`: string - The name of the CI/CD check.
+  - `<pr_check_status>`: string - The status of the check (e.g., "success", "failure", "in_progress", "canceled").
+  - `<pr_check_url>`: string - The URL to view the detailed results of the check.
+
 Here's an example prompt that uses these data points:
 
 ```text
@@ -299,7 +307,7 @@ Issues and tickets brings in conversations, descriptions, and comments from Jira
 
 This option gives you the ability to create a report limited only to pull requests containing a "Score Card" or "Score Chart" bot comment from CodeRabbit or other bots. To enable issues and tickets you must include the tag `<pr_score_card>` in your prompt.
 
-> **IMPORTANT:** This will automatically remove any pull requests from your reports if they do not contain a "Score Card" or "Score Chart" bot comment. Using this option without setting up a flow to create these comments will result in `No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have created a "Score Card" or "Score Chart" bot comment flow.
+> **IMPORTANT:** This will automatically remove any pull requests from your reports if they do not contain a "Score Card" or "Score Chart" bot comment. Using this option without setting up a flow to create these comments will result in `No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have asked coderabbit to create a "Score Card" thourhg a comment or implimented the "Score Chart" bot comment flow below.
 
 For example you can ask coderabbit to check serveral conditions on a pull request and produce a "Score Chart":
 
@@ -340,7 +348,7 @@ Generate a weekly code review report for the author of this pull request only fo
    - `1` → Passed
 
 **Final Score Calculation:**
-Combine the scores from the parameters above to derive the final code quality score (out of 5).
+Combine the scores from the parameters above to derive the final code quality score (out of 9).
 **Output Format:**
 Provide the final report in a table format with the following columns (use shorthand notations), be sure to include this list at the top above the chart in the "Column Notation" section so users understand what the columns mean:
 
diff --git a/docs/guides/ondemand-reports.md b/docs/guides/ondemand-reports.md
@@ -14,7 +14,7 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
 
 This page is about using the CodeRabbit API to generate on-demand reports about your organization's usage of CodeRabbit. For a conceptual overview of reports in CodeRabbit, see [Generate reports](/guides/reports-overview).
 
-If you're new to CodeRabbit's reporting features, then we recommend starting with [Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities.
+If you're new to CodeRabbit's reporting features, then we recommend starting with [Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities. In almost every scenario we recommend using the **Scheduled Reports** option. The **On-demand Report** does not have any additional benifits from the **Scheduled Reports** and has many limitations.
 
 ## API Access
 
diff --git a/docs/guides/reports-overview.md b/docs/guides/reports-overview.md
@@ -17,16 +17,16 @@ You can track and analyze pull request activity across your organization's repos
 
 There are two ways to generate reports:
 
-- **[Scheduled Reports](/guides/scheduled-reports)**: Set up automated, recurring reports that are delivered to your team on a set schedule. Supported delivery channels include the following:
+- **[Scheduled Reports](/guides/scheduled-reports)**: Set up automated, recurring reports that are delivered to your team on a set schedule. **Use this option if you want to adjust your settings and send a report more than once**. Supported delivery channels include the following:
 
   - Email
   - Discord
   - Slack
   - Teams
 
-- **[On-demand Reports](/guides/ondemand-reports)**: If you require customized integration of reports with your own tools and workflows, then you can generate reports programmatically through our API.
+- **[On-demand Reports](/guides/ondemand-reports)**: If you want to test a report format and produce a single report once, try the "On-demand Reports" Option. You can also generate reports programmatically through our API, but we do not recommend this as the API reporting is in beta. If you want to run an **On-demand Report** more than once then you must use the **Scheduled Reports** option.
 
-For your first reports, we recommend exploring scheduled reports. Its web-based UI can help you get familiar with the options available to you.
+In almost every scenario we recommend using the **Scheduled Reports** option. The **On-demand Report** does not have any additional benifits from the **Scheduled Reports** and has many limitations.
 
 ## Customize reports using natural language {#customize}
 
diff --git a/docs/guides/scheduled-reports.md b/docs/guides/scheduled-reports.md
@@ -52,11 +52,12 @@ Choose a time that works for all team members, especially for distributed teams
 
 ### Report Parameters
 
-Reports can be filtered using multiple parameters:
+Reports can be filtered using multiple parameters, match pull requests using the **IN** option and exclude pull requests using the **NOT_IN** option:
 
 - **Repositories**: Select specific repositories to monitor
 - **Labels**: Filter by GitHub labels with operators:
   - IN: Match any selected label
+  - NOT_IN: Exclude any pr with select label
   - ALL: Match all selected labels
 - **Users**: Filter by specific GitHub users
 - **Teams**: Filter by organization teams
diff --git a/docs/platforms/azure-devops.md b/docs/platforms/azure-devops.md
@@ -94,9 +94,8 @@ Follow these steps to generate the token:
 5. Select the organization you want to use the token with or select "All
    accessible organizations."
 6. Enter a name and an expiry date for the token.
-7. We need to have read & write access to "Work Items" & "Code" to post reviews
-   on pull requests. If you are on the Pro tier also add "Build" access for pipeline
-   failure remediation.
-8. Click "Create"
+7. Grant **Read, write, & manage** access to "Work Items" and "Code". CodeRabbit needs these permissions to post code reviews on pull requests.
+8. If you subscribe to CodeRabbit Pro, then you can also grant **Read** access to "Build" for pipeline failure remediation.
+9. Click "Create"
 
 ![CodeRabbit azure devOps personal access token creation form](/img/integrations/azure-access-token.png)
diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md
@@ -103,6 +103,9 @@ LLM_TIMEOUT=360000
 AWS_ACCESS_KEY_ID=<aws-access-key>
 AWS_SECRET_ACCESS_KEY=<aws-secret-access-key>
 AWS_REGION=<aws-region>
+# optionally, use cross-region inference to access models in other regions
+# if this is set to `true`, CodeRabbit will access models from `us`, `eu`, or `ap` regions based on the AWS_REGION value.
+AWS_USE_CROSS_REGION_INFERENCE=[<true>]
 
 TEMP_PATH=/cache
 
diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md
@@ -95,6 +95,9 @@ LLM_TIMEOUT=360000
 AWS_ACCESS_KEY_ID=<aws-access-key>
 AWS_SECRET_ACCESS_KEY=<aws-secret-access-key>
 AWS_REGION=<aws-region>
+# optionally, use cross-region inference to access models in other regions
+# if this is set to `true`, CodeRabbit will access models from `us`, `eu`, or `ap` regions based on the AWS_REGION value.
+AWS_USE_CROSS_REGION_INFERENCE=[<true>]
 
 # System Configuration
 TEMP_PATH=/cache
diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md
@@ -106,6 +106,9 @@ LLM_TIMEOUT=360000
 AWS_ACCESS_KEY_ID=<aws-access-key>
 AWS_SECRET_ACCESS_KEY=<aws-secret-access-key>
 AWS_REGION=<aws-region>
+# optionally, use cross-region inference to access models in other regions
+# if this is set to `true`, CodeRabbit will access models from `us`, `eu`, or `ap` regions based on the AWS_REGION value.
+AWS_USE_CROSS_REGION_INFERENCE=[<true>]
 
 # if using Anthropic
 LLM_PROVIDER=anthropic
diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md
@@ -134,6 +134,9 @@ LLM_TIMEOUT=360000
 AWS_ACCESS_KEY_ID=<aws-access-key>
 AWS_SECRET_ACCESS_KEY=<aws-secret-access-key>
 AWS_REGION=<aws-region>
+# optionally, use cross-region inference to access models in other regions
+# if this is set to `true`, CodeRabbit will access models from `us`, `eu`, or `ap` regions based on the AWS_REGION value.
+AWS_USE_CROSS_REGION_INFERENCE=[<true>]
 
 # if using Anthropic
 LLM_PROVIDER=anthropic
diff --git a/docs/tools/shopify-cli.md b/docs/tools/shopify-cli.md
@@ -12,6 +12,31 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
 
 [Shopify CLI](https://github.com/Shopify/cli) is a command-line tool that helps you build Shopify apps, themes, and custom storefronts. It provides functionality for initializing, building, developing, and deploying Shopify projects.
 
+## Requirements
+
+The tool only runs when the following conditions are met:
+
+### File Types
+
+- Only processes pull requests changing `*.liquid` files
+
+### Configuration Files
+
+- Requires either `.theme-check.yml` or `.theme-check.yaml` configuration file in the project root
+
+### Directory Structure
+
+- Requires the standard Shopify theme directory structure at the project root:
+  - `assets/`
+  - `config/`
+  - `layout/`
+  - `locales/`
+  - `sections/`
+  - `snippets/`
+  - `templates/`
+
+If any of these requirements are not met, the tool will not run.
+
 ## Validation Rules
 
 The tool checks for:
diff --git a/static/code/gitlab-webhook.sh b/static/code/gitlab-webhook.sh
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
