From 5d2acbf0d77a4666ea72914b17c74469ad70609f Mon Sep 17 00:00:00 2001 From: alex Date: Thu, 17 Jul 2025 13:42:40 -0400 Subject: [PATCH 1/6] add in docs for new reporting filtering and data --- docs/guides/custom-reports.md | 8 ++++++++ docs/guides/scheduled-reports.md | 3 ++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index a22b359e..ddb2e7a1 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -117,6 +117,14 @@ Contained within the `` tag. - ``: datetime - The date and time the comment was last updated. - ``: markdown - The content of the comment. +#### CI/CD Check Status + +- ``: array of check objects - Contains all CI/CD checks for the PR. _GitHub Only_. +- ``: object - Each individual check is wrapped in this tag and is an object with the following properties: + - ``: string - The name of the CI/CD check. + - ``: string - The status of the check (e.g., "success", "failure", "in_progress", "canceled"). + - ``: string - The URL to view the detailed results of the check. + Here's an example prompt that uses these data points: ```text diff --git a/docs/guides/scheduled-reports.md b/docs/guides/scheduled-reports.md index 34c59032..cef41d46 100644 --- 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 From 0f70f20c0db2c417c40fb0764861e88f9fb1d540 Mon Sep 17 00:00:00 2001 From: alex Date: Thu, 17 Jul 2025 14:10:40 -0400 Subject: [PATCH 2/6] update changelog --- docs/changelog.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/changelog.md b/docs/changelog.md index d273ffcb..b49dec47 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -5,6 +5,24 @@ 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 Integration + +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. + ## July 10, 2025 ### Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks From 8c8cf9e5e11f37a9bf4e777916d44dcfecfefac9 Mon Sep 17 00:00:00 2001 From: alex Date: Thu, 17 Jul 2025 14:11:31 -0400 Subject: [PATCH 3/6] fix title --- docs/changelog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.md b/docs/changelog.md index b49dec47..51683977 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -19,7 +19,7 @@ Reports now support exclusion filters using the `NOT_IN` option, allowing you to 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 Integration +#### 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. From 86b8187f0d59e939ff2a8a7d4a37700e6b24d7d4 Mon Sep 17 00:00:00 2001 From: alex Date: Thu, 17 Jul 2025 14:20:13 -0400 Subject: [PATCH 4/6] add score card info in --- docs/changelog.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/changelog.md b/docs/changelog.md index 51683977..8c2858bb 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -23,6 +23,10 @@ We've enhanced the default daily standup report template to include a "Next Step 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 score card report feature that allows you to grade and create report cards for your developers. This custom report option 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 From d6eb0539ac1318b1254839eebeae69482288c751 Mon Sep 17 00:00:00 2001 From: alex Date: Thu, 17 Jul 2025 14:23:06 -0400 Subject: [PATCH 5/6] minor docs improvements --- docs/guides/custom-reports.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index ddb2e7a1..b2a10504 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -307,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 `` 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": @@ -348,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: From 473439c25e3cb0916e0d2bb853f91217eab33490 Mon Sep 17 00:00:00 2001 From: alex Date: Thu, 17 Jul 2025 14:24:26 -0400 Subject: [PATCH 6/6] minor changes --- docs/changelog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.md b/docs/changelog.md index 8c2858bb..9fe435ad 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -25,7 +25,7 @@ Reports now include CI/CD GitHub Action check status as a data source. Your repo #### Score Card Custom Report Option -We've added a new score card report feature that allows you to grade and create report cards for your developers. This custom report option 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. +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