Skip to content

Commit acf0fb0

Browse files
author
Shannon Anahata
committed
up
dating CLI doc, mention of sentry prevent
1 parent 9703fbd commit acf0fb0

File tree

6 files changed

+70
-57
lines changed

6 files changed

+70
-57
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: Sentry AI Code Review
3+
sidebar_order: 30
4+
description: "Get code reviews and new tests for better code and coverage using Sentry's AI Code Review."
5+
---
6+
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.
8+
9+
<Alert>
10+
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.
11+
</Alert>
12+
13+
## Getting Started
14+
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.
16+
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.
18+
19+
## AI Code Review Commands
20+
21+
After installing the app, use these commands in your pull request comments:
22+
23+
- `@sentry review` - The assistant will review the PR and make suggestions.
24+
25+
- `@sentry generate-test` - The assistant will generate tests for your PR.
26+
27+
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.
28+
29+
![Sentry's AI Code Review Overview](./img/sentry-prevent-review.png)
30+
31+
## Frequently Asked Questions
32+
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?**
34+
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.
36+
37+
**Does Sentry's AI Code Review run anywhere outside of GitHub, and does it run in the background?**
38+
39+
Sentry's AI Code Review only runs on GitHub, and only runs when triggered by a comment.
40+
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.
42+
43+
You can learn more about AI privacy and security [here](/product/ai-in-sentry/ai-privacy-and-security/).
44+
45+
## Feedback & Support
46+
47+
Have feedback? Drop us a line on GitHub Issues or contact Sentry support.
48+
49+
---
50+
51+
For more information, see [Sentry's AI Code Review documentation](https://docs.sentry.io/).

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

Lines changed: 0 additions & 51 deletions
This file was deleted.

docs/product/test-analytics/index.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: Test Analytics
33
sidebar_order: 135
4-
description: Learn about how Sentry Prevent's Test Analytics tools can help you improve your code.
4+
description: Learn about how Sentry's Test Analytics tools can help you improve your code.
55
---
66

7-
Sentry Prevent Test Analytics provides actionable insights into your CI test runs, helping you identify flaky tests, track failures, and optimize your test suite for faster, more reliable deployments.
7+
Sentry Test Analytics provides actionable insights into your CI test runs, helping you identify flaky tests, track failures, and optimize your test suite for faster, more reliable deployments.
88

99
## Why Use Test Analytics?
1010

@@ -16,12 +16,12 @@ Sentry Prevent Test Analytics provides actionable insights into your CI test run
1616
## Getting Started
1717

1818
<Alert>
19-
Sentry Prevent Test Analytics is currently in <strong>beta</strong>. Beta features are still a work in progress and may have bugs.
19+
Sentry Test Analytics is currently in <strong>beta</strong>. Beta features are still a work in progress and may have bugs.
2020
</Alert>
2121

2222
![Test Analytics Dashboard](./img/TA-dash.png)
2323

24-
To use Sentry Prevent Test Analytics, you’ll need to install the [Sentry app](https://github.com/apps/sentry-io) on your GitHub organization or specific repositories. Once installed, choose your JUnit XML Report framework and [set your permissions](#permissions-and-repository-tokens) using a repository secret.
24+
To use Sentry Test Analytics, you’ll need to install the [Sentry app](https://github.com/apps/sentry-io) on your GitHub organization or specific repositories. Once installed, choose your JUnit XML Report framework and [set your permissions](#permissions-and-repository-tokens) using a repository secret.
2525

2626
<Alert>
2727
**The only test result file format we support is JUnit XML**. Most test frameworks support outputting test results in this format, with some configuration.
@@ -41,7 +41,7 @@ If you are already using GitHub Actions, you can use the `getsentry/prevent-acti
4141
with:
4242
token: ${{ secrets.SENTRY_PREVENT_TOKEN }}
4343
```
44-
### 2. Use [Sentry Prevent’s CLI](/product/test-analytics/cli/) to Upload Testing Reports
44+
### 2. Use [Sentry Prevent CLI](/product/test-analytics/sentry-prevent-cli/) to Upload Testing Reports
4545
If you do not use Github Actions, install the Sentry Prevent CLI using `pip install sentry-prevent-cli` (for Python), or use a binary platform.
4646

4747
```bash {tabTitle:macos}

docs/product/test-analytics/sentry-prevent-cli/index.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Learn how to use the Sentry Prevent CLI to upload test results to S
77
## Installation
88

99
<Alert>
10-
While the snippets below can be used to download and use the CLI directly, it is highly recommended to perform signature and SHASUM verification to ensure integrity of the CLI before use. See [Integrity Checking the Uploader](/product/test-analytics/cli/#integrity-checking-the-uploader) below for more information.
10+
While the snippets below can be used to download and use the CLI directly, it is highly recommended to perform signature and SHASUM verification to ensure integrity of the CLI before use. See [Integrity Checking the Uploader](/product/test-analytics/sentry-prevent-cli/#integrity-checking-the-uploader) below for more information.
1111
</Alert>
1212

1313
For `Python`, install the Sentry Prevent CLI using `pip install sentry-prevent-cli`. You need to have `Python3` as the default.
@@ -46,4 +46,12 @@ chmod +x sentry-prevent-cli
4646
curl -L https://github.com/getsentry/sentry-prevent-cli/releases/latest/download/sentry-prevent-cli-alpine-arm64 -o sentry-prevent-cli
4747
chmod +x sentry-prevent-cli
4848
```
49+
## Uploading Test Results
50+
51+
To upload test results, use the following command:
52+
53+
```bash
54+
sentry-prevent-cli db upload --report-type test_results --file <report_name>.junit.xml
55+
```
56+
4957
## Integrity Checking the Uploader

redirects.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,6 +1201,11 @@ const userDocsRedirects = [
12011201
source: '/product/ai-in-sentry/seer/seer-privacy-and-security',
12021202
destination: '/product/ai-in-sentry/ai-privacy-and-security/',
12031203
},
1204+
// Redirects for Sentry Prevent AI
1205+
{
1206+
source: '/product/ai-in-sentry/sentry-prevent-ai/',
1207+
destination: '/product/ai-in-sentry/ai-code-review/',
1208+
}
12041209
];
12051210

12061211
/**

0 commit comments

Comments
 (0)