Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(feat)Update and reorganize Flutter dSYM Docs #12976

Merged
merged 28 commits into from
Mar 18, 2025
Merged

(feat)Update and reorganize Flutter dSYM Docs #12976

merged 28 commits into from
Mar 18, 2025

Conversation

smeubank
Copy link
Member

@smeubank smeubank commented Mar 11, 2025 •
edited
Loading

  • Moved Dart Native into "common" similar to JavaScript and other paltforms
  • Created platform includes for debug symbols, which now are reused by Dart and Flutter
  • Dart now has Debug Symbols Docs
  • Split one big page into 3:
  1. Overview
  2. Sentry Dart Plugin (preferred)
  3. Manual Upload

image

  • Sentry Dart Plugin:

    • Configure Step

    • extended the onboarding component to include debug symbols options screenshot below

    • converted the 3 variants of config options to one code block with toggles

    • saves space, and make it more obvious that it is one config, with multiple options.

    • Build Your Application step:

      • merged the 3 bash snippet with examples of how to build your application into one with tabs
      • obfuscated is the first option, as preferred
      • saves, space and make it more obvious that all are not needed

image

  • Configuration Reference
    • converted into a table to make it easier to consume an save space

image

@vercel Vercel
Copy link

vercel bot commented Mar 11, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs 🛑 Canceled (Inspect) Mar 17, 2025 3:37pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Mar 17, 2025 3:37pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Mar 17, 2025 3:37pm

@smeubank smeubank changed the title sloppy draft (flutter)Reorg dSYM Docs Mar 11, 2025
@codecov Codecov
Copy link

codecov bot commented Mar 11, 2025 •
edited
Loading

Bundle Report

Changes will increase total bundle size by 3.58kB (0.02%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.53MB 3.14kB (0.03%) ⬆️
sentry-docs-client-array-push 9.39MB 439 bytes (0.0%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 868.16kB -0.0%
static/chunks/3319-*.js -3 bytes 393.41kB -0.0%
static/chunks/app/[[...path]]/page-*.js 445 bytes 74.83kB 0.6%
static/bR5uY8fYLRJjoutl1dwhm/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/bR5uY8fYLRJjoutl1dwhm/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/41DLYX_I7P7vsr5HfTF8T/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/41DLYX_I7P7vsr5HfTF8T/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.57MB -0.0%
../instrumentation.js -3 bytes 904.32kB -0.0%
9523.js -3 bytes 880.37kB -0.0%
../app/[[...path]]/page.js 445 bytes 534.24kB 0.08%
../app/[[...path]]/page.js.nft.json 900 bytes 379.32kB 0.24%
../app/platform-redirect/page.js.nft.json 900 bytes 379.24kB 0.24%
../app/sitemap.xml/route.js.nft.json 900 bytes 377.21kB 0.24%

App Routes Affected:

App Route Size Change Total Size Change (%)
/[[...path]] 445 bytes 3.08MB 0.01%

smeubank added 2 commits March 11, 2025 23:40
@smeubank
dart to common
5c0d6fc 
dart to common and add dsym pages to dart and flutter
@smeubank
remove changes
6816bdc
@smeubank
config radio buttons
5c635c9 
add radio buttons to update the config snippets.

Remaining portions of the page can further be controlled by the radio buttons, web build options for example
@smeubank smeubank mentioned this pull request Mar 12, 2025
Open
34 tasks
smeubank and others added 3 commits March 12, 2025 11:12
@smeubank
Update debugSymbolConfig.tsx
ca161e6 
attempt to re-use existing code block styling

still blocked on the slugs and token being populatied correctly.
@smeubank
Merge branch '(feat)flutter-dbsym-rework' of https://github.com/getse…
4fd4308 
…ntry/sentry-docs into (feat)flutter-dbsym-rework
@getsantry
[getsentry/action-github-commit] Auto commit
dfd0a8e
smeubank and others added 2 commits March 13, 2025 13:16
@smeubank
extend onboarding component
27c162e 
- extend onboarding component
- remove custom impl for debug symbols
- combine bash scripts for building flutter app, with tabs for variation
@getsantry
[getsentry/action-github-commit] Auto commit
8818594
@smeubank smeubank requested review from kahest and buenaflor March 13, 2025 13:59
buenaflor
buenaflor reviewed Mar 13, 2025
View reviewed changes
Copy link
Contributor

@buenaflor buenaflor left a comment

Choose a reason for hiding this comment

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

made a quick pass, will have a look later again

but awesome changes so far 🥳

kahest
kahest reviewed Mar 13, 2025
View reviewed changes
Copy link
Member

@kahest kahest left a comment

Choose a reason for hiding this comment

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

looked through the docs, compared with current pages - this is a huge improvement. left a few notes, will re-review when the other suggestions are resolved

smeubank and others added 3 commits March 17, 2025 12:39
@smeubank @coolguyzone
Update platform-includes/debug-symbols/dart-plugin/flutter.mdx
e2a2d4c 
Co-authored-by: Alex Krawiec <[email protected]>
@smeubank
resolving feedback
4bec4d2 
- remove repetitive info from index
- remove standard build bash scripts
- clarify source context constraints
- remove duplicated manual upload instructions from dart-plugin instructions
@smeubank
Merge branch '(feat)flutter-dbsym-rework' of https://github.com/getse…
30eccfa 
…ntry/sentry-docs into (feat)flutter-dbsym-rework
@buenaflor
Copy link
Contributor

nice! 🚀

kahest
kahest approved these changes Mar 17, 2025
View reviewed changes
Copy link
Member

@kahest kahest left a comment

Choose a reason for hiding this comment

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

very nice 💯

coolguyzone
coolguyzone approved these changes Mar 17, 2025
View reviewed changes
Copy link
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!

@smeubank smeubank merged commit e209a4e into master Mar 18, 2025
13 checks passed
@smeubank smeubank deleted the (feat)flutter-dbsym-rework branch March 18, 2025 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kahest kahest kahest approved these changes

@coolguyzone coolguyzone coolguyzone approved these changes

@buenaflor buenaflor buenaflor approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@smeubank @buenaflor @kahest @coolguyzone