Skip to content

Commit 5d2acbf

Browse files
add in docs for new reporting filtering and data
1 parent 75408fc commit 5d2acbf

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

docs/guides/custom-reports.md

Lines changed: 8 additions & 0 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

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)