Skip to content

Commit a51327b

Browse files
author
Shannon Anahata
committed
adding more details, screenshots, and URLs
1 parent f409a4b commit a51327b

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/product/test-analytics/index.mdx

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,24 @@ sidebar_order: 135
44
description: Learn about how Sentry Prevent'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 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.
88

99
## Why Use Test Analytics?
1010

1111
- **Spot Flaky Tests:** Quickly identify and address tests that fail intermittently, reducing noise and wasted debugging time.
1212
- **Track Failures and Trends:** Monitor cumulative failures, slowest tests, and overall test run efficiency to improve CI reliability.
1313
- **Actionable Insights:** See which lines of code failed within tests, confirm flaky tests, and prioritize fixes.
14-
- **Integrated with Sentry:** Access test analytics alongside your error and performance data for a unified developer experience. Yay
14+
- **Integrated with Sentry:** Access test analytics alongside your error and performance data for a unified developer experience.
1515

1616
## Getting Started
1717

18-
To use Sentry Prevent Test Analytics, you’ll need to install the [Sentry app]() on your GitHub organization or specific repositories. Once installed, choose your JUnit XML Report language and [set your permissions](#permissions-and-repository-tokens) using a repository secret.
18+
<Alert>
19+
Sentry Prevent Test Analytics is currently in <strong>beta</strong>. Beta features are still a work in progress and may have bugs.
20+
</Alert>
21+
22+
![Test Analytics Dashboard](./img/TA-dash.png)
1923

20-
*Insert Arcade GIF or screenshot here*
24+
To use Sentry Prevent Test Analytics, you’ll need to install the [Sentry app]() on your GitHub organization or specific repositories. Once installed, choose your JUnit XML Report language and [set your permissions](#permissions-and-repository-tokens) using a repository secret.
2125

2226
**There are two ways to upload your test results:**
2327

@@ -38,14 +42,12 @@ Now that you've configured your CI to upload your test results, you can inspect
3842

3943
After your workflow runs, view failed tests in the [failed tests dashboard](), or in your GitHub pull request comments.
4044

41-
*Insert Arcade GIF or screenshot here*
45+
![Test Analytics comment](./img/TA-comment.png)
4246

4347
You can see a complete overview of your test analytics in the [test analytics dashboard]().
4448

45-
*insert screenshot here*
46-
4749
## Permissions and Repository Tokens
48-
When configuring Test Analytics, you'll be asked to choose your upload permissions. For GitHub Actions, you can use [OpenID Connect](https://openid.net/developers/how-connect-works/), or generate a repository token. Using the CLI, generate a repository token.
50+
When configuring Test Analytics, you'll be asked to choose your upload permissions. For GitHub Actions, you can use [OpenID Connect](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect), or generate a repository token. Using the CLI, generate a repository token.
4951

5052
You can find a list of repository tokens on the Sentry Prevent [tokens page]().
5153

0 commit comments

Comments
 (0)