Skip to content

add in docs for new reporting filtering and data #461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 17, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
add in docs for new reporting filtering and data
  • Loading branch information
alexcoderabbitai committed Jul 17, 2025
commit 5d2acbf0d77a4666ea72914b17c74469ad70609f
8 changes: 8 additions & 0 deletions docs/guides/custom-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/guides/scheduled-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down