Skip to content

docs(snapshots): Split CI setup into its own page#17424

Open
runningcode wants to merge 1 commit intomtopo27/snapshots-ea-product-docsfrom
no/docs/split-snapshots-ci-page
Open

docs(snapshots): Split CI setup into its own page#17424
runningcode wants to merge 1 commit intomtopo27/snapshots-ea-product-docsfrom
no/docs/split-snapshots-ci-page

Conversation

@runningcode
Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Restructure the snapshots docs so CI setup lives on its own page, mirroring the pattern used by the Size Analysis docs.

The current `uploading-snapshots` page embeds a full GitHub Actions workflow with a `` placeholder. Snapshot generation varies wildly by platform (Playwright, Paparazzi, XCUITests, Laravel Dusk…), so the single baked-in template is misleading. This PR extracts the CI guidance into a dedicated page and keeps the upload page focused on the universal bits (directory structure, JSON metadata, `sentry-cli` reference).

  • New `docs/product/snapshots/integrating-into-ci.mdx` with a skeleton GitHub Actions workflow that handles `push` to main and `pull_request` in one file, plus troubleshooting
  • Trimmed `docs/product/snapshots/uploading-snapshots/index.mdx` — removed the opinionated CI block, added the CI-alert include
  • New includes `includes/snapshots/ci-alert.mdx` and `includes/snapshots/github-only.mdx`, modeled on the size-analysis includes
  • Cross-links from `index.mdx` and `reviewing-snapshots/index.mdx` back to the new CI page
  • Left `TODO` links next to Android/iOS bullets for future platform-specific snapshot pages

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

Extract the GitHub Actions CI example out of the Uploading Snapshots
page into a dedicated Integrating Into CI page, mirroring the structure
of the Size Analysis docs.

The previous upload page carried an opinionated workflow with a
`<your-snapshot-command>` placeholder. Snapshot generation varies
wildly across platforms (Playwright, Paparazzi, XCUITests, Laravel
Dusk), so a single baked-in template misled readers. The new CI page
gives a skeleton workflow that handles push and pull_request in one
file and defers platform-specific generation to bullets that will be
linked to iOS/Android platform guides.

Also introduces two reusable includes (ci-alert, github-only) modeled
on the size-analysis includes, and cross-links the overview and
reviewing pages back to the new CI page.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 21, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Apr 21, 2026 0:43am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Apr 21, 2026 0:43am

Request Review

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.

1 participant