You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore(ai-code-review): Add which webhooks we use (#15327)
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
*Tell us what you're changing and why. If your PR **resolves an issue**,
please link it so it closes automatically.*
We got feedback that it'd be nice to clarify in the docs more about when
Error Prediction runs. I added it to the FAQ with more information about
the GitHub webhooks that we listen to.
Preview:
https://sentry-docs-git-sshin-doc.sentry.dev/product/ai-in-sentry/ai-code-review/
## IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [x] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
---------
Co-authored-by: Shannon Anahata <[email protected]>
Co-authored-by: Shannon Anahata <[email protected]>
Co-authored-by: Alex Krawiec <[email protected]>
Copy file name to clipboardExpand all lines: docs/product/ai-in-sentry/ai-code-review/index.mdx
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,15 +28,15 @@ If you're not an admin, share the Seer by Sentry GitHub App Integration link wit
28
28
29
29
After installing the app, AI Code Review can help you in three ways:
30
30
31
-
1.**Error Prediction** - When you create a pull request and set it to `Ready for Review`, AI Code Review will check for errors in your code. If no error is found, you will see a 🎉 emoji as a reaction to your PR description. Otherwise, AI Code Review will add comments to your PR.
31
+
1.**Error Prediction** - When you create a pull request and set it to `Ready for Review`, AI Code Review will check for errors in your code. If no error is found, you will see a 🎉 emoji as a reaction to your PR description. Otherwise, AI Code Review will add comments to your PR. **Note:** We skip review if you set your PR to `draft` on creation.
32
32
33
33
2.**`@sentry review`** - Use this command in a PR comment, and the assistant will review the PR and predict errors, as well as make suggestions.
34
34
35
35
3.**`@sentry generate-test`** - Use this command in a PR comment, and the assistant will generate tests for your PR.
36
36
37
37
Once you have added a comment, the assistant will reply, acknowledging the request. For code reviews, you will then see comments added to your PR. For test generation, you will see a comment with a link to the generated tests.
38
38
39
-

39
+

40
40
41
41
## Frequently Asked Questions
42
42
@@ -46,7 +46,7 @@ Once you have added a comment, the assistant will reply, acknowledging the reque
46
46
47
47
-**Does AI Code run anywhere outside of GitHub, and does it run in the background?**
48
48
49
-
AI Code Review only runs on GitHub. It will run once when a PR is marked `ready for review`, and otherwise only runs when triggered by a comment.
49
+
AI Code Review only runs on GitHub. It will run once when a PR is marked `ready for review` (either when creating the PR, or after taking it out of draft), and otherwise only runs when triggered by a comment.
50
50
51
51
You can learn more about AI privacy and security [here](/product/ai-in-sentry/ai-privacy-and-security/).
52
52
@@ -57,3 +57,11 @@ AI Code Review only runs on GitHub. It will run once when a PR is marked `ready
57
57
-**Is AI Code Review available in the EU region?**
58
58
59
59
Not currently, although we're working on it.
60
+
61
+
-**When does Error Prediction run?**
62
+
63
+
Error Prediction is automatically triggered by the following GitHub pull_request webhook events:
64
+
-`opened`: when you open a new pull request (we skip those opened in `draft` state)
65
+
-`ready_for_review`: when a draft pull request is marked as “Ready for review”
66
+
67
+
To manually run error prediction and get a general review, comment `@sentry review` in the PR.
Copy file name to clipboardExpand all lines: docs/product/ai-in-sentry/index.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ Sentry leverages artificial intelligence (AI) and machine learning (ML) to enhan
8
8
9
9
## AI-Powered Features
10
10
11
-
### [Seer](/product/ai-in-sentry/seer/)
11
+
### Seer
12
12
13
-
Seer is Sentry's AI debugging agent that helps resolve errors and performance issues in your applications. Seer combines issue detection, analysis, and automated fixing capabilities to streamline your debugging workflow.
13
+
[Seer](/product/ai-in-sentry/seer/) is Sentry's AI debugging agent that helps resolve errors and performance issues in your applications. Seer combines issue detection, analysis, and automated fixing capabilities to streamline your debugging workflow.
14
14
15
15
-**[Issue Fix](/product/ai-in-sentry/seer/issue-fix/)**: Automated root cause analysis and suggested code fixes, for errors and performance issues.
16
16
-**Issue Scan**: Scans issues as they are ingested in Sentry to determine an actionability score and run Seer's issue fix on them automatically.
@@ -19,9 +19,9 @@ Seer is Sentry's AI debugging agent that helps resolve errors and performance is
19
19
20
20
**Issue summary** provides a quick overview of an issue by highlighting key insights taken from event and issue-level metadata. You'll see a quick overview of what's going wrong, a potential cause, and if relevant, insights from trace-connected issues.
AI Code Review helps you generate new tests for uncovered code and reviews your code changes, offering suggestions for improvement before merging pull requests. Currently available only on Github
24
+
[AI Code Review](/product/ai-in-sentry/sentry-prevent-ai/) helps you generate new tests for uncovered code and reviews your code changes, offering suggestions for improvement before merging pull requests. Currently available only on Github
0 commit comments