Skip to content

Conversation

@antonis
Copy link
Contributor

@antonis antonis commented Oct 3, 2024

DESCRIBE YOUR PR

Fixes getsentry/sentry-react-native#3743

This PR adds a note highlighting that source maps are not uploaded for debug mode in Expo. Note that there is a similar note in the React Native section.

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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel
Copy link

vercel bot commented Oct 3, 2024

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

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 8, 2024 7:29am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 8, 2024 7:29am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Oct 8, 2024 7:29am

@codecov
Copy link

codecov bot commented Oct 3, 2024

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 7.45MB 6 bytes (-0.0%) ⬇️
sentry-docs-edge-server-array-push 257.07kB 3 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 6.42MB 6 bytes (-0.0%) ⬇️

@krystofwoldrich
Copy link
Contributor

krystofwoldrich commented Oct 4, 2024

I think we should include the information also on the main source maps page. Maybe by adding a section similar to disabling the auto upload. And add explanation why it's not needed in Debug mode. As the symbolication is done by the Metro dev server.

https://docs.sentry.io/platforms/react-native/sourcemaps/


- `dist` is the default output directory of `eas update`.
- Uploaded source maps have no associated releases. This is expected as updates can apply to multiple releases.
- Uploading of source maps for debug or simulator builds is disabled.
Copy link
Contributor

@krystofwoldrich krystofwoldrich Oct 4, 2024

Choose a reason for hiding this comment

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

These are notes for EAS Updates, meaning for situation when a user creates a JS bundle to distribute as ota update.

This note is relevant for the previous section [Automatic Upload for Release](https://docs.sentry.io/platforms/react-native/sourcemaps/uploading/expo/#automatic-upload-for-release)

I would also include one sentence why, we do not auto upload for Debug.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch @krystofwoldrich 🙇 I've moved the note to the correct section adding a short sentence for the why with 6d154f7.

I think we should include the information also on the main source maps page.

Also added a separate a bit more extended section on the main source maps page with e339fd8

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you. I suggest removing the sim builds as release for sim will upload the source maps.

I also added @lizokm to review the docs style.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you @krystofwoldrich! Makes sense. I've committed your suggestions 🙇

@krystofwoldrich krystofwoldrich requested a review from lizokm October 7, 2024 08:43
antonis and others added 2 commits October 7, 2024 11:45
Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Thanks for adding! I made some wording suggestions.

@antonis
Copy link
Contributor Author

antonis commented Oct 8, 2024

Thank you for the better wording and the typo fix @lizokm 🙇 I've committed your suggestions.

@antonis antonis merged commit f51a974 into master Oct 8, 2024
10 checks passed
@antonis antonis deleted the antonis/expo-debug-source-maps branch October 8, 2024 07:33
@github-actions github-actions bot locked and limited conversation to collaborators Oct 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add note to docs: Source Maps are not uploaded for dev/debug builds

4 participants