Skip to content

Commit 0c9e6f5

Browse files
author
Shannon Anahata
committed
Update AI Code Review docs with master changes
- Incorporate error prediction features from master - Add enhanced setup instructions with required integrations - Update image reference to prevent-ai-response.png - Expand FAQ section with new questions - Maintain 'Sentry's AI Code Review' branding throughout
1 parent 6248533 commit 0c9e6f5

File tree

1 file changed

+24
-19
lines changed
  • docs/product/ai-in-sentry/ai-code-review

1 file changed

+24
-19
lines changed
Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,56 @@
11
---
22
title: Sentry AI Code Review
33
sidebar_order: 30
4-
description: "Get code reviews and new tests for better code and coverage using Sentry's AI Code Review."
4+
description: "Get error predictions, code reviews and new tests for better code and coverage using Sentry's AI Code Review."
55
---
66

7-
Sentry's AI Code Review is a generative AI assistant developed by Sentry. It helps you generate new tests for uncovered code and reviews your code changes, offering suggestions for improvement before merging pull requests.
7+
Sentry's AI Code Review is a generative AI assistant developed by Sentry. It helps you generate new tests for uncovered code and reviews your code changes, predicting errors and offering suggestions for improvement before merging pull requests.
88

99
<Alert>
1010
Sentry's AI Code Review is currently in <strong>beta</strong>. Beta features are still a work in progress and may have bugs. Please join the [Discord conversation](https://discord.com/channels/621778831602221064/1385700674557444190) to share your feedback.
1111
</Alert>
1212

1313
## Getting Started
1414

15-
To enable Sentry's AI Code Review in your GitHub organization or on specific repositories, you need to install the [Seer by Sentry app](https://github.com/apps/seer-by-sentry). This allows the assistant to analyze pull requests, provide insights, and write tests.
15+
To enable Sentry's AI Code Review in your GitHub organization or on specific repositories, you need to install the [Seer by Sentry app](https://github.com/apps/seer-by-sentry). This allows the assistant to analyze pull requests, provide insights, and write tests. **You must also have the [Sentry Github integration](/organization/integrations/source-code-mgmt/github/) enabled.**
1616

17-
If you're not an admin, copy the Seer by Sentry GitHub App Integration link and share it with your organization's admin or owner to install it.
17+
1. Install the [Seer by Sentry app](https://github.com/apps/seer-by-sentry) in your GitHub organization or specific repositories.
18+
2. Enable these required settings in your Sentry [organization settings](https://sentry.io/orgredirect/settings/:orgslug/):
19+
- `Show Generative AI Features`
20+
- `Enable PR Review and Test Generation`
21+
22+
If you're not an admin, share the Seer by Sentry GitHub App Integration link with your organization's admin or owner to install it.
1823

1924
## AI Code Review Commands
2025

21-
After installing the app, use these commands in your pull request comments:
26+
After installing the app, Sentry's AI Code Review can help you in three ways:
27+
28+
1. **Error Prediction** - When you create a pull request and set it to `Ready for Review`, Sentry's 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, Sentry's AI Code Review will add comments to your PR.
2229

23-
- `@sentry review` - The assistant will review the PR and make suggestions.
30+
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.
2431

25-
- `@sentry generate-test` - The assistant will generate tests for your PR.
32+
3. **`@sentry generate-test`** - Use this command in a PR comment, and the assistant will generate tests for your PR.
2633

2734
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.
2835

29-
![Sentry's AI Code Review Overview](./img/sentry-prevent-review.png)
36+
![Sentry's AI Code Review Overview](./img/prevent-ai-response.png)
3037

3138
## Frequently Asked Questions
3239

33-
**What data does Sentry's AI Code Review need access to for the AI system to function, and what information is sent to third-party AI providers?**
40+
- **What data does Sentry's AI Code Review need access to for the AI system to function, and what information is sent to third-party AI providers?**
3441

35-
Sentry's AI Code Review requires access to your pull requests, including PR metadata, repository information, file names, directory structures, and code diffs. The file names, code diffs, and PR descriptions are sent to the AI provider for analysis.
42+
Sentry's AI Code Review requires access to your pull requests, including PR metadata, repository information, file names, directory structures, and code diffs. Only file names, code diffs, and PR descriptions are sent to the AI provider for analysis.
3643

37-
**Does Sentry's AI Code Review run anywhere outside of GitHub, and does it run in the background?**
44+
- **Does Sentry's AI Code Review run anywhere outside of GitHub, and does it run in the background?**
3845

39-
Sentry's AI Code Review only runs on GitHub, and only runs when triggered by a comment.
46+
Sentry's 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.
4047

41-
The [Show Generative AI Features toggle](https://sentry.io/orgredirect/organizations/:orgslug/settings/#hideAiFeatures) does not currently apply to Sentry's AI Code Review. if you don't want Sentry's AI Code Review used on your projects, you can uninstall the [Seer app](https://github.com/apps/seer-by-sentry) at any time.
48+
You can learn more about AI privacy and security [here](/product/ai-in-sentry/ai-privacy-and-security/).
4249

43-
You can learn more about AI privacy and security [here](/product/ai-in-sentry/ai-privacy-and-security/).
50+
- **Why aren't `@sentry` commands working?**
4451

45-
## Feedback & Support
52+
Sentry's AI Code Review will respond with a message to enable the `Show Generative AI Features` and `Enable PR Review and Test Generation` settings in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/), if you have not already enabled them. Once enabled, try `@sentry review` or `@sentry generate-test` again to run Sentry's AI Code Review.
4653

47-
Have feedback? Drop us a line on GitHub Issues or contact Sentry support.
48-
49-
---
54+
- **Are AI Code Review features available in the EU region?**
5055

51-
For more information, see [Sentry's AI Code Review documentation](https://docs.sentry.io/).
56+
Not currently, although we're working on it.

0 commit comments

Comments
 (0)