-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Adding sentry prevent AI docs #13884
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.
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
Open
sfanahata
wants to merge
1
commit into
master
Choose a base branch
from
sentry-prevent-ai
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
title: Sentry Prevent AI | ||
sidebar_order: 130 | ||
description: "Get code reviews and new tests for better code and coverage using Sentry Prevent AI." | ||
--- | ||
|
||
Sentry Prevent AI 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. | ||
|
||
<Alert> | ||
Sentry Prevent AI is currently in <strong>beta</strong>. Beta features are still a work in progress and may have bugs. Please reach out on GitHub Issues if you have any feedback or concerns. | ||
</Alert> | ||
|
||
{/*  */} | ||
|
||
## Getting Started | ||
|
||
To enable the Sentry Prevent AI assistant in your GitHub organization or on specific repositories, you need to install the Sentry Prevent AI GitHub App Integration. This allows the assistant to analyze pull requests and provide insights. | ||
|
||
If you're not an admin, copy the Sentry Prevent AI GitHub App Integration link and share it with your organization's admin or owner to install it. | ||
|
||
## Sentry Prevent AI Commands | ||
|
||
After installing the app, use these commands in your pull request comments: | ||
|
||
- `@sentry-prevent-ai-reviewer review` — The assistant will review the PR and make suggestions. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
- `@sentry-prevent-ai-reviewer test` — The assistant will generate tests for your PR. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
{/*  */} | ||
|
||
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. | ||
|
||
## Frequently Asked Questions | ||
|
||
**What data does Sentry Prevent need access to for the AI system to function, and what information is sent to third-party AI providers?** | ||
|
||
Sentry Prevent 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. | ||
|
||
## Feedback & Support | ||
|
||
Have feedback? Drop us a line on GitHub Issues or contact Sentry support. | ||
|
||
--- | ||
|
||
For more information, see the [Sentry Prevent documentation](https://docs.sentry.io/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it worth adding a link to the place where you can submit a github issue?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think so - if we're still taking feedback!