Skip to content

docs(snapshots): Add sentry-cli reference page for snapshots#17464

Merged
runningcode merged 5 commits intomtopo27/snapshots-ea-product-docsfrom
no/snapshots-cli-docs
May 4, 2026
Merged

docs(snapshots): Add sentry-cli reference page for snapshots#17464
runningcode merged 5 commits intomtopo27/snapshots-ea-product-docsfrom
no/snapshots-cli-docs

Conversation

@runningcode
Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Add a dedicated /cli/snapshots/ page for sentry-cli build snapshots, the command that underpins Snapshots uploads. Makes the command discoverable from the CLI left nav and documents behavior that wasn't previously covered.

  • Adds docs/cli/snapshots.mdx — basic usage, git metadata auto-detection (head/base SHA, VCS provider, PR number), --selective sharding, --diff-threshold, and a full flag reference.
  • Moves the sentry-cli build snapshots flag table out of docs/product/snapshots/uploading-snapshots/index.mdx — that page now links to the CLI reference.
  • Expands the one-line sentry-cli mention in docs/platforms/android/snapshots/index.mdx into a short section with an example for Android users who don't use the Sentry Android Gradle Plugin.

Stacked on top of mtopo27/snapshots-ea-product-docs.

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.):
  • Other deadline:
  • 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

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 23, 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 4, 2026 2:38pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview May 4, 2026 2:38pm

Request Review

@codeowner-assignment codeowner-assignment Bot requested review from a team April 23, 2026 15:45
Comment thread docs/cli/snapshots.mdx
Comment thread docs/platforms/android/snapshots/index.mdx Outdated
Comment thread docs/cli/snapshots.mdx Outdated
Copy link
Copy Markdown
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

LGTM

Comment thread docs/cli/snapshots.mdx
runningcode and others added 4 commits May 4, 2026 16:13
Add a dedicated /cli/snapshots/ page documenting the experimental
`sentry-cli build snapshots` command: basic usage, git metadata
auto-detection behavior, --selective sharding, and the full flag
reference.

Move the flag table out of the uploading-snapshots product page and
link to the new CLI page instead. Expand the Android guide's one-line
sentry-cli mention into a short section with a concrete example for
users who don't use the Sentry Android Gradle Plugin.
Co-authored-by: Alex Krawiec <alexanderkrawiec@gmail.com>
Remove --header from CLI snapshots flag reference since it's a global
sentry-cli flag. Collapse multi-line Alert text to avoid rendering
artifacts.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@runningcode runningcode force-pushed the no/snapshots-cli-docs branch from ca76d40 to 9aeeb17 Compare May 4, 2026 14:19
@codeowner-assignment codeowner-assignment Bot requested a review from a team May 4, 2026 14:19
Comment thread docs/product/snapshots/uploading-snapshots/index.mdx
Point Android and Apple CI integration links to the dedicated
/product/snapshots/integrating-into-ci/ page instead of a
non-existent anchor on the uploading-snapshots page.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@runningcode runningcode merged commit 5de0c3d into mtopo27/snapshots-ea-product-docs May 4, 2026
8 checks passed
@runningcode runningcode deleted the no/snapshots-cli-docs branch May 4, 2026 14:40
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.

4 participants