Skip to content

Commit 9a76837

Browse files
suejung-sentryShannon Anahatasfanahatacoolguyzone
authored
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]>
1 parent d59e942 commit 9a76837

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

docs/product/ai-in-sentry/ai-code-review/index.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ If you're not an admin, share the Seer by Sentry GitHub App Integration link wit
2828

2929
After installing the app, AI Code Review can help you in three ways:
3030

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.
3232

3333
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.
3434

3535
3. **`@sentry generate-test`** - Use this command in a PR comment, and the assistant will generate tests for your PR.
3636

3737
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.
3838

39-
![Sentry Prevent AI Overview](./img/prevent-ai-response.png)
39+
![Sentry Prevent AI Overview =900x](./img/prevent-ai-response.png)
4040

4141
## Frequently Asked Questions
4242

@@ -46,7 +46,7 @@ Once you have added a comment, the assistant will reply, acknowledging the reque
4646

4747
- **Does AI Code run anywhere outside of GitHub, and does it run in the background?**
4848

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.
5050

5151
You can learn more about AI privacy and security [here](/product/ai-in-sentry/ai-privacy-and-security/).
5252

@@ -57,3 +57,11 @@ AI Code Review only runs on GitHub. It will run once when a PR is marked `ready
5757
- **Is AI Code Review available in the EU region?**
5858

5959
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.

docs/product/ai-in-sentry/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Sentry leverages artificial intelligence (AI) and machine learning (ML) to enhan
88

99
## AI-Powered Features
1010

11-
### [Seer](/product/ai-in-sentry/seer/)
11+
### Seer
1212

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.
1414

1515
- **[Issue Fix](/product/ai-in-sentry/seer/issue-fix/)**: Automated root cause analysis and suggested code fixes, for errors and performance issues.
1616
- **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
1919

2020
**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.
2121

22-
### [AI Code Review](/product/ai-in-sentry/sentry-prevent-ai/)
22+
### AI Code Review
2323

24-
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
2525

2626
### Query Assistant
2727

0 commit comments

Comments
 (0)