Skip to content

docs(snapshots): Document removal and rename detection for selective uploads#17904

Merged
NicoHinderling merged 3 commits into
masterfrom
nico/docs-snapshots-selective-removal-detection
May 28, 2026
Merged

docs(snapshots): Document removal and rename detection for selective uploads#17904
NicoHinderling merged 3 commits into
masterfrom
nico/docs-snapshots-selective-removal-detection

Conversation

@NicoHinderling
Copy link
Copy Markdown
Contributor

Document the new --all-image-file-names and --all-image-file-names-file CLI flags that enable removal and rename detection in selective snapshot mode.

Previously, selective uploads could not distinguish deliberately deleted snapshots from ones that simply weren't part of the subset. These new flags let users pass the full list of image file names from their test suite, allowing Sentry to categorize missing images as skipped, removed, or renamed.

Changes:

  • Added "Detecting Removals and Renames" subsection to both the CLI reference (docs/cli/snapshots.mdx) and the product docs (docs/product/snapshots/uploading-snapshots/index.mdx)
  • Added the two new flags to the CLI options reference table
  • Updated the existing selective mode limitation note to reflect the new capability

IS YOUR CHANGE URGENT?

  • None: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

…uploads

Add documentation for --all-image-file-names and --all-image-file-names-file
flags that enable removal and rename detection in selective snapshot mode.
These flags let users pass the full list of image file names from their test
suite so Sentry can distinguish skipped, removed, and renamed images.

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 27, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment May 28, 2026 8:40pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview May 28, 2026 8:40pm

Request Review

@NicoHinderling NicoHinderling marked this pull request as ready for review May 27, 2026 22:09
@codeowner-assignment codeowner-assignment Bot requested a review from a team May 27, 2026 22:09
Inform users that very large snapshot sets may exceed download limits
and suggest generating baselines locally as an alternative.

Co-Authored-By: Claude <noreply@anthropic.com>
Document the new --all-image-file-names-as-regex and
--all-image-file-names-as-regex-file flags. Make clear that all four
flags are mutually exclusive with a warning alert.

Co-Authored-By: Claude <noreply@anthropic.com>
@NicoHinderling NicoHinderling enabled auto-merge (squash) May 28, 2026 20:31
@NicoHinderling NicoHinderling merged commit 07e394b into master May 28, 2026
21 checks passed
@NicoHinderling NicoHinderling deleted the nico/docs-snapshots-selective-removal-detection branch May 28, 2026 20:41
NicoHinderling added a commit that referenced this pull request May 29, 2026
…lective uploads (#17904)" (#17931)

## DESCRIBE YOUR PR

Reverts the documentation added in #17904, which documented removal and
rename detection (`--all-image-file-names` /
`--all-image-file-names-file`) for selective snapshot uploads.

The feature documentation is being pulled back until the underlying
functionality is ready to ship, so the published docs don't get ahead of
the product.

This restores `docs/cli/snapshots.mdx`,
`docs/product/snapshots/uploading-snapshots/index.mdx`, and
`docs/product/snapshots/local-testing/index.mdx` to their pre-#17904
state.

## IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [x] None: Not urgent, can wait up to 1 week+

## SLA

- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!

## PRE-MERGE CHECKLIST

*Make sure you've checked the following before merging your changes:*

- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants