Snapshots

Catch visual changes on every pull request with snapshots.

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

  1. Generate snapshots — Your CI job produces screenshots however you like: Playwright, Paparazzi, or any tool that outputs images
  2. Upload to Sentry — sentry-cli uploads the snapshot directory to Sentry
  3. Sentry diffs against the baseline — Sentry compares images against corresponding base build. With Sentry, you do not have to manage "Golden" images and everything is determined via git metadata.
  4. Results post to your PR — Snapshot results post to your PR* via a GitHub status check. See Integrating Into CI for setup. You can configure 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

  • Early Adopter access — Enable the Early Adopter toggle in your organization settings.
  • 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 and grant it access to your repository for PR integration.

Snapshots works for any platform with a frontend and most platforms have a number of tools to help you generate snapshots. Sentry has a recommended workflow for the following platforms:

Previous
Build Distribution
Next
Uploading Snapshots
Was this helpful?
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").