Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/cli/snapshots.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: Snapshots (CLI)
sidebar_order: 6
description: "Upload snapshot images to Sentry with sentry-cli for visual diffing and GitHub status checks."
early_access: true
beta: true
---

<Include name="feature-available-for-user-group-early-adopter" />
<Include name="feature-stage-beta.mdx" />

The `sentry-cli build snapshots` command uploads a directory of images to [Snapshots](/product/snapshots/) for visual diffing against a base build.

Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/android/snapshots/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ sidebar_title: Snapshots
sidebar_order: 5275
sidebar_section: features
description: Set up snapshots for Android apps with the Sentry Android Gradle Plugin.
early_access: true
beta: true
---

<Include name="feature-available-for-user-group-early-adopter" />
<Include name="feature-stage-beta.mdx" />

Set up [Snapshots](/product/snapshots/) for your Android app with the Sentry Android Gradle Plugin. Generate snapshots locally or in your own CI using your preferred snapshot library, then upload the generated images to Sentry for image diffing, visual review, and GitHub status checks.

Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/apple/common/snapshots/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ sidebar_title: Snapshots
sidebar_order: 4950
sidebar_section: features
description: Set up snapshots for any Apple app using Snapshot Previews or your preferred snapshot library.
early_access: true
beta: true
---

<Include name="feature-available-for-user-group-early-adopter" />
<Include name="feature-stage-beta.mdx" />

Set up [Snapshots](/product/snapshots/) for your Apple app. Generate snapshots locally or in your own CI using your preferred snapshot library, then upload the generated images to Sentry for image diffing, visual review, and GitHub status checks.

Expand Down
2 changes: 1 addition & 1 deletion docs/product/snapshots/agentic-workflow/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 30
description: Connect an AI agent to Sentry's MCP server to inspect snapshot diffs, images, and baselines.
---

<Include name="feature-available-for-user-group-early-adopter" />
<Include name="feature-stage-beta.mdx" />

Connect an AI coding assistant to Sentry's MCP server so it can pull snapshot diffs, images, and baselines on your behalf. This lets you investigate snapshot failures by asking the agent, instead of clicking through the Sentry UI or downloading images by hand. It complements the [local CLI workflow](/product/snapshots/local-testing/): MCP is built for agent-assisted investigation and review, while `sentry-cli` is built for local downloads and diffing.

Expand Down
7 changes: 3 additions & 4 deletions docs/product/snapshots/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: Snapshots
sidebar_order: 138
description: Catch visual changes on every pull request with snapshots.
early_access: true
beta: true
---

<Include name="feature-available-for-user-group-early-adopter" />
<Include name="feature-stage-beta.mdx" />

Snapshots helps you catch unintended visual changes before they reach users. Sentry handles image storage, diffing, CI checks, and more.

Expand All @@ -17,11 +17,10 @@ Snapshots helps you catch unintended visual changes before they reach users. Sen
4. **Results post to your PR** — Snapshot results post to your PR\* via a GitHub status check. See [Integrating Into CI](/product/snapshots/integrating-into-ci/) for setup. You can [configure settings](/product/snapshots/reviewing-snapshots/#status-check-settings) to control status check and comment behavior.
5. **Review and approve** — View snapshot results on the Sentry UI. If the Snapshot "failed" you can approve it from either the PR or the Sentry UI.

\*Note: Snapshots EA only supports Github
\*Note: Snapshots currently only supports GitHub for status check integration and PR comments.

## Prerequisites

- **Early Adopter access** — Enable the Early Adopter toggle in your [organization settings](/organization/early-adopter-features/).
- **Auth token** — A Sentry auth token with `project:write` scope (personal token) or `org:ci` scope (org-level token).
- **sentry-cli >= 3.4.0** — The `build snapshots` command requires version 3.4.0 or later.
- **GitHub integration** — Snapshots can be used with any VCS provider, but only Github is supported for status check integration and PR comments. Install the [Sentry GitHub App](/organization/integrations/source-code-mgmt/github/) and grant it access to your repository for PR integration.
Expand Down
2 changes: 1 addition & 1 deletion docs/product/snapshots/integrating-into-ci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 15
description: Set up Snapshots in CI to receive automated visual diff status checks on every pull request.
---

<Include name="feature-available-for-user-group-early-adopter" />
<Include name="feature-stage-beta.mdx" />

<Include name="snapshots/github-only" />

Expand Down
2 changes: 1 addition & 1 deletion docs/product/snapshots/local-testing/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 25
description: Download baseline snapshots and diff images locally with sentry-cli.
---

<Include name="feature-available-for-user-group-early-adopter" />
<Include name="feature-stage-beta.mdx" />

You can download baseline snapshots from Sentry and diff them against local images without leaving your machine. This is useful for fast iteration during development or for AI-assisted visual regression workflows.

Expand Down
2 changes: 1 addition & 1 deletion docs/product/snapshots/reviewing-snapshots/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 20
description: Review snapshot diffs on your pull request and approve changes.
---

<Include name="feature-available-for-user-group-early-adopter" />
<Include name="feature-stage-beta.mdx" />

## Snapshot Comparisons

Expand Down
2 changes: 1 addition & 1 deletion docs/product/snapshots/uploading-snapshots/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 10
description: Structure your snapshot directory and upload from CI with sentry-cli.
---

<Include name="feature-available-for-user-group-early-adopter" />
<Include name="feature-stage-beta.mdx" />

<Include name="snapshots/ci-alert" />

Expand Down
Loading