docs(flutter): add Snapshots setup guide#18822
Conversation
Adds a Flutter Snapshots page using flutter_test golden files with sentry-cli, and lists Flutter under the product-level Snapshots recommended platform workflows. Closes getsentry/sentry-dart#3794 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019bTzteNzMhFhA49MvQWp8e
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
| File | Line | Current Link | Should Be |
|---|---|---|---|
docs/platforms/javascript/guides/cloudflare/features/workers-ai.mdx |
117 | /ai/monitoring/conversations/ |
/ai/observability/conversations/ |
Each redirect hop loses ~15% of SEO link equity and adds latency for users.
|
Sample snapshot using the doc: https://sentry-sdks.sentry.io/preprod/snapshots/474212/ |
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Unrelated to this PR, issue already exists on master related to another SDK |
buenaflor
left a comment
buenaflor
left a comment
There was a problem hiding this comment.
nice! overall LGTM, only had one comment
| ## Step 1: Generate Images | ||
|
|
||
| Flutter's `flutter_test` package can render your widgets and save the result as an image using `matchesGoldenFile`. Write a test for each screen or component you want to snapshot: |
There was a problem hiding this comment.
maybe we should say that the user just needs to generate a PNG out of their Flutter screen
users might assume using this method is the only one
There was a problem hiding this comment.
Sounds good to me, added this mention on 6c6c490
Addresses review feedback that readers might assume flutter_test/matchesGoldenFile is the only way to produce snapshot images, when Sentry just needs a PNG or JPEG. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Sq5YUderV4Uj8JiJzhHnCT
2 participants
DESCRIBE YOUR PR
Adds Flutter documentation for Sentry Snapshots, closing getsentry/sentry-dart#3794. Flutter has no dedicated Sentry tooling for snapshots (unlike Paparazzi for Android or SnapshotPreviews for iOS), so this documents the workflow built on Flutter's own golden file testing (
matchesGoldenFile+flutter test --update-goldens) plussentry-clifor upload.docs/platforms/dart/guides/flutter/snapshots/index.mdx— generate images, test locally, integrate into CI, plus notes on the test-font gotcha and cross-host-OS rendering differences (Flutter golden tests are host-OS-dependent for font rendering, so baseline and CI snapshots should be generated on the same OS).docs/product/snapshots/index.mdx— added Flutter to the "Recommended Platform Workflows" list.Validated end-to-end against a real Flutter golden test and a live upload to the
sentry-flutterSentry project.IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
🤖 Generated with Claude Code
https://claude.ai/code/session_019bTzteNzMhFhA49MvQWp8e