From 922c66bbe7a9a7486daf2fabdf7e538f1e75e60d Mon Sep 17 00:00:00 2001 From: alex Date: Tue, 11 Mar 2025 13:05:28 -0400 Subject: [PATCH 1/3] adding info for using comment tags --- docs/guides/custom-reports.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index 791c0211..14426eff 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -71,6 +71,8 @@ Your custom reports can access the following PR information that you can referen #### Pull Request Status +Contained within the `` tag. + - `Merged`: boolean (true/false) - Whether the PR has been merged - `Draft`: boolean (true/false) - Whether the PR is in draft state - `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 #### Basic Information +Contained within the `` tag. + - `Pull request number`: number - The PR's identifier - `Title`: string - PR title - `URL`: string - Link to the PR @@ -88,16 +92,25 @@ Your custom reports can access the following PR information that you can referen - `Closed at`: datetime (if applicable) - When the PR was closed - `Source branch`: string - Source branch name - `Target branch`: string - Target branch name - -#### Additional Context - - `Labels`: array of strings - All labels applied to the PR - `Reviewers`: array of strings - Assigned reviewers' usernames -- `Description`: markdown - Full PR description -- `Summary`: string - AI-generated summary of changes -- `Comments`: array of objects - - `username`: string - Comment author - - `body`: markdown - Comment content + +#### Summarized PR Details + +- ``: string - Contains the body of your pull request (aka the PR description at the top of the PR page). +- ``: 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: + - `filename`: string - The name of the file that was changed. + - `AI-generated summary of changes`: markdown - An overall summary of the changes made in the file. + - `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. + +#### Comments + +- ``: array of comment objects - Contains all the comments made on the PR. +- ``: object - Each indidvidual comment is wrapped in this tag and is an object with the following properties: + - ``: string - The username of the comment author. + - ``: datetime - The date and time the comment was created. + - ``: datetime - The date and time the comment was last updated. + - ``: markdown - The content of the comment. Here's an example prompt that uses these data points: From 21a11af863da02c9ac73c2b2ee6ae07c6d2defb4 Mon Sep 17 00:00:00 2001 From: alex Date: Tue, 11 Mar 2025 13:06:32 -0400 Subject: [PATCH 2/3] fix sentence --- docs/guides/custom-reports.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index 14426eff..2a409e98 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -98,7 +98,7 @@ Contained within the `` tag. #### Summarized PR Details - ``: string - Contains the body of your pull request (aka the PR description at the top of the PR page). -- ``: 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: +- ``: 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 for each file that was changed: - `filename`: string - The name of the file that was changed. - `AI-generated summary of changes`: markdown - An overall summary of the changes made in the file. - `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. From bab8e9d355bd310e3613848a86a0252f98eeb852 Mon Sep 17 00:00:00 2001 From: alex Date: Tue, 11 Mar 2025 13:10:09 -0400 Subject: [PATCH 3/3] lint fix --- docs/guides/custom-reports.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index 2a409e98..ce263b9d 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -98,7 +98,7 @@ Contained within the `` tag. #### Summarized PR Details - ``: string - Contains the body of your pull request (aka the PR description at the top of the PR page). -- ``: 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 for each file that was changed: +- ``: 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 for each file that was changed: - `filename`: string - The name of the file that was changed. - `AI-generated summary of changes`: markdown - An overall summary of the changes made in the file. - `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.