Skip to content

Custom reporting optional data #264

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.

Sign up for GitHub

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 4 commits into from
Apr 2, 2025
Merged

Custom reporting optional data #264

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4682bea
wip
alexcoderabbitai Apr 2, 2025
cd21b7b
add issues
alexcoderabbitai Apr 2, 2025
125a354
put comments back the way it was
alexcoderabbitai Apr 2, 2025
c65bfbf
fix english
alexcoderabbitai Apr 2, 2025
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
Prev Previous commit
Next Next commit
add issues
  • Loading branch information
@alexcoderabbitai
alexcoderabbitai committed Apr 2, 2025
commit cd21b7b1975abcca8e5af7840155ecffd4e7ef04
15 changes: 12 additions & 3 deletions docs/guides/custom-reports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ Within each group, sort by:

### Optional Data Sources

You can also include optional data sources in your custom reports. By default, CodeRabbit will not include the following data sources. In a custom report you will see the option to include these data sources by clicking the `Select Optional Data Sources` button. This adds special XML tags to your prompt that allow you to include this data in your report.
You can also include optional data sources in your custom reports. By default, CodeRabbit will not include the following data sources. In a custom report you will see the option to include these data sources by clicking the `Select Optional Data Sources` button. This adds special XML tags to your prompt that allow you to include this data in your report.

#### Bot Comments

Expand All @@ -273,8 +273,17 @@ These are very similar in structure to regular user comments but with a few key

Issues and tickets brings in conversations, descriptions, and comments from Jira and Linear in your repository. To enable issues and tickets you must include the tag `<include_issues_and_tickets>` in your prompt.

- `<issues_and_tickets>`: array of comment objects - Contains all the comments made on the PR.
- `<issue_or_ticket>`: object - Each individual comment is wrapped in this tag and is an object with the following properties:
- `<issues_and_tickets>`: array of issue objects - Contains all the linked issues and tickets.
- `<issue>`: object - Each individual issue is wrapped in this tag and is an object with the following properties:
- `<issue_title>`: string - The title or thread ID of the issue.
- `<issue_url>`: string - The URL to the issue.
- `<issue_id>`: string - The unique identifier of the issue.
- `<issue_author>`: string - The username of who created the issue.
- `<issue_created_at>`: datetime - The date and time the issue was created.
- `<issue_updated_at>`: datetime - The date and time the issue was last updated.
- `<issue_body>`: markdown - The content/description of the issue. This contains the following sections:
- `<issue_description>`: markdown - The description of the issue.
- `<issue_comments>`: array of comment objects - Contains all the comments made on the issue.

## Best Practices

Expand Down