Skip to content

docs(snapshots): Document selective uploads for subset/sharded CI runs#17807

Merged
NicoHinderling merged 3 commits into
masterfrom
docs/selective-snapshots-uploads
May 19, 2026
Merged

docs(snapshots): Document selective uploads for subset/sharded CI runs#17807
NicoHinderling merged 3 commits into
masterfrom
docs/selective-snapshots-uploads

Conversation

@NicoHinderling
Copy link
Copy Markdown
Contributor

Add a "Selective Uploads" section to the uploading snapshots product docs explaining the --selective flag added in getsentry/sentry-cli#3268.

The new section covers:

  • When to use --selective (sharding tests across parallel CI jobs, running only affected tests)
  • How Sentry treats missing snapshots as unchanged/skipped rather than removed
  • Merging behavior for selective uploads sharing the same commit SHA and app-id
  • Trade-off: removals and renames cannot be detected

The CLI reference at /cli/snapshots/ already documents the flag — this adds the conceptual explanation in the product docs where users discover the feature.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.)
  • Other deadline
  • 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

Adds a Selective Uploads section to the uploading snapshots product docs
explaining the --selective flag behavior: only uploaded snapshots are
diffed, missing ones are treated as unchanged, and selective uploads
with the same commit SHA and app-id are merged.

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

vercel Bot commented May 19, 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 19, 2026 6:58pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview May 19, 2026 6:58pm

Request Review

@NicoHinderling NicoHinderling marked this pull request as ready for review May 19, 2026 18:33
Comment thread docs/product/snapshots/uploading-snapshots/index.mdx
…loads caveat

The limitation that removals and renames cannot be detected with
--selective applies universally, not just on PRs. Align the CLI
reference with the product docs.

Co-Authored-By: Claude <noreply@anthropic.com>
@codeowner-assignment codeowner-assignment Bot requested a review from a team May 19, 2026 18:38

## Selective Uploads

If you only generate a subset of your snapshots per CI run — for example, because you shard tests across parallel jobs or run only affected tests — pass the `--selective` flag on each upload:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • "Selective Uploads" or "Selective Testing"? I lean the latter bc in my mind that is a more known term, but might be wrong
  • nit: i think sharding example is less likely than the latter and should go after

…ples

Address review feedback: "Selective Testing" is a more familiar term
than "Selective Uploads", and running affected tests is a more common
use case than sharding.

Co-Authored-By: Claude <noreply@anthropic.com>
@NicoHinderling NicoHinderling enabled auto-merge (squash) May 19, 2026 18:54
@NicoHinderling NicoHinderling merged commit 9a848c0 into master May 19, 2026
21 checks passed
@NicoHinderling NicoHinderling deleted the docs/selective-snapshots-uploads branch May 19, 2026 19:03
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