Skip to content

Commit cd21b7b

Browse files
add issues
1 parent 4682bea commit cd21b7b

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

Diff for: docs/guides/custom-reports.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ Within each group, sort by:
254254

255255
### Optional Data Sources
256256

257-
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.
257+
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.
258258

259259
#### Bot Comments
260260

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

274274
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.
275275

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

279288
## Best Practices
280289

0 commit comments

Comments
 (0)