Skip to content

Commit d3f45f6

Browse files
add in docs for new reporting filtering and data (#461)
* add in docs for new reporting filtering and data * update changelog * fix title * add score card info in * minor docs improvements
1 parent 75408fc commit d3f45f6

File tree

3 files changed

+34
-3
lines changed

3 files changed

+34
-3
lines changed

docs/changelog.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,28 @@ description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 13
66
---
77

8+
## July 17, 2025
9+
10+
### Enhanced Reporting Capabilities
11+
12+
We're excited to announce significant improvements to our reporting system that will make your automated reports more powerful and actionable!
13+
14+
#### Exclusion Filters with NOT_IN Option
15+
16+
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.
17+
18+
#### Next Steps Section in Daily Standup Reports
19+
20+
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.
21+
22+
#### CI/CD GitHub Action Check Status Awareness
23+
24+
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.
25+
26+
#### Score Card Custom Report Option
27+
28+
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.
29+
830
## July 10, 2025
931

1032
### Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks

docs/guides/custom-reports.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,14 @@ Contained within the `<pr_details>` tag.
117117
- `<comment_updated_at>`: datetime - The date and time the comment was last updated.
118118
- `<comment_body>`: markdown - The content of the comment.
119119

120+
#### CI/CD Check Status
121+
122+
- `<pr_checks>`: array of check objects - Contains all CI/CD checks for the PR. _GitHub Only_.
123+
- `<pr_check>`: object - Each individual check is wrapped in this tag and is an object with the following properties:
124+
- `<pr_check_name>`: string - The name of the CI/CD check.
125+
- `<pr_check_status>`: string - The status of the check (e.g., "success", "failure", "in_progress", "canceled").
126+
- `<pr_check_url>`: string - The URL to view the detailed results of the check.
127+
120128
Here's an example prompt that uses these data points:
121129

122130
```text
@@ -299,7 +307,7 @@ Issues and tickets brings in conversations, descriptions, and comments from Jira
299307

300308
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.
301309

302-
> **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.
310+
> **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.
303311
304312
For example you can ask coderabbit to check serveral conditions on a pull request and produce a "Score Chart":
305313

@@ -340,7 +348,7 @@ Generate a weekly code review report for the author of this pull request only fo
340348
- `1` → Passed
341349

342350
**Final Score Calculation:**
343-
Combine the scores from the parameters above to derive the final code quality score (out of 5).
351+
Combine the scores from the parameters above to derive the final code quality score (out of 9).
344352
**Output Format:**
345353
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:
346354

docs/guides/scheduled-reports.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,12 @@ Choose a time that works for all team members, especially for distributed teams
5252

5353
### Report Parameters
5454

55-
Reports can be filtered using multiple parameters:
55+
Reports can be filtered using multiple parameters, match pull requests using the **IN** option and exclude pull requests using the **NOT_IN** option:
5656

5757
- **Repositories**: Select specific repositories to monitor
5858
- **Labels**: Filter by GitHub labels with operators:
5959
- IN: Match any selected label
60+
- NOT_IN: Exclude any pr with select label
6061
- ALL: Match all selected labels
6162
- **Users**: Filter by specific GitHub users
6263
- **Teams**: Filter by organization teams

0 commit comments

Comments
 (0)