Skip to content

Commit 922c66b

Browse files
adding info for using comment tags
1 parent 6656798 commit 922c66b

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

docs/guides/custom-reports.md

+21-8
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ Your custom reports can access the following PR information that you can referen
7171

7272
#### Pull Request Status
7373

74+
Contained within the `<pr_details>` tag.
75+
7476
- `Merged`: boolean (true/false) - Whether the PR has been merged
7577
- `Draft`: boolean (true/false) - Whether the PR is in draft state
7678
- `State`: string ("open"/"closed") - Current state of the PR
@@ -79,6 +81,8 @@ Your custom reports can access the following PR information that you can referen
7981

8082
#### Basic Information
8183

84+
Contained within the `<pr_details>` tag.
85+
8286
- `Pull request number`: number - The PR's identifier
8387
- `Title`: string - PR title
8488
- `URL`: string - Link to the PR
@@ -88,16 +92,25 @@ Your custom reports can access the following PR information that you can referen
8892
- `Closed at`: datetime (if applicable) - When the PR was closed
8993
- `Source branch`: string - Source branch name
9094
- `Target branch`: string - Target branch name
91-
92-
#### Additional Context
93-
9495
- `Labels`: array of strings - All labels applied to the PR
9596
- `Reviewers`: array of strings - Assigned reviewers' usernames
96-
- `Description`: markdown - Full PR description
97-
- `Summary`: string - AI-generated summary of changes
98-
- `Comments`: array of objects
99-
- `username`: string - Comment author
100-
- `body`: markdown - Comment content
97+
98+
#### Summarized PR Details
99+
100+
- `<pr_description>`: string - Contains the body of your pull request (aka the PR description at the top of the PR page).
101+
- `<file_changes_summary>`: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AI durring the PR review process. This includes several sections:
102+
- `filename`: string - The name of the file that was changed.
103+
- `AI-generated summary of changes`: markdown - An overall summary of the changes made in the file.
104+
- `Alterations to the declarations of exported or public entities`: markdown - A more specific breakdown of the changes made to the file such as exactly what was added, removed, or modified.
105+
106+
#### Comments
107+
108+
- `<pr_comments>`: array of comment objects - Contains all the comments made on the PR.
109+
- `<comment>`: object - Each indidvidual comment is wrapped in this tag and is an object with the following properties:
110+
- `<comment_author_username>`: string - The username of the comment author.
111+
- `<comment_created_at>`: datetime - The date and time the comment was created.
112+
- `<comment_updated_at>`: datetime - The date and time the comment was last updated.
113+
- `<comment_body>`: markdown - The content of the comment.
101114

102115
Here's an example prompt that uses these data points:
103116

0 commit comments

Comments
 (0)