Skip to content

Conversation

alexsohn1126
Copy link
Member

DESCRIBE YOUR PR

Adds more information about Proguard mapping file upload feature we have in .NET MAUI app.

Should be merged after this change is merged:

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

Copy link

vercel bot commented Sep 19, 2025

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

Project Deployment Preview Comments Updated (UTC)
sentry-docs Ready Ready Preview Comment Sep 22, 2025 4:29pm
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
develop-docs Ignored Ignored Preview Sep 22, 2025 4:29pm

@codeowner-assignment codeowner-assignment bot requested a review from a team September 19, 2025 17:52
Copy link

codecov bot commented Sep 19, 2025

Bundle Report

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

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 10.12MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.85MB 9.14kB (0.07%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.78MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%
../app/[[...path]]/page.js.nft.json 3.05kB 823.89kB 0.37%
../app/platform-redirect/page.js.nft.json 3.05kB 823.8kB 0.37%
../app/sitemap.xml/route.js.nft.json 3.05kB 821.03kB 0.37%
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 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
static/yB6WbrW3Nb0NbrKvs2vWm/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/yB6WbrW3Nb0NbrKvs2vWm/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/XNb0ryQLyyw3w6s_WOPZw/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/XNb0ryQLyyw3w6s_WOPZw/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Controls uploading ProGuard mapping file to Sentry after the build. Defaults to `false` (disabled).

Set to `true` to upload ProGuard mapping file to Sentry.
Your resulting APK will be injected with the metadata `io.sentry.proguard-uuid`. `AndroidManifest.xml` will contain a metadata entry such as the following:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wasn't quite sure, reading this, what happens if I set it to true.

I think (correct me if I'm wrong) when this is set to true, a ProGuard mapping file is uploaded to Sentry after the build (and the mapping file contains the GUID from the AndroidManifest.xml right)?

Isn't injecting the GUID into the APK controlled separately by the SentryProGuardUUID build property (or doesn't automatically if that property isn't set)?

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree the phrasing is quite bad here.

Yes, the mapping file will be associated with the GUID from the AndroidManifest.xml, though I don't think the mapping file "contains" the GUID, it is just named with the GUID:

Image

We do inject the GUID into the APK separately, and it's controlled by SentryProguardUUID (user-defined or generated during build-time).

I think I'll just rephrase this, and maybe get rid of that xml code snippet because it may be even more confusing to those who are not interested in the inner-workings.

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!

@alexsohn1126
Copy link
Member Author

@jamescrosswell I'd say we hold off on merging this until we release the ProGuard related changes. Thoughts?

@jamescrosswell
Copy link
Collaborator

@jamescrosswell I'd say we hold off on merging this until we release the ProGuard related changes. Thoughts?

Yes although it looks like those have already been merged. Let me know if/when you want me to take another look at this.

@alexsohn1126
Copy link
Member Author

@jamescrosswell Yes, please review again!

Copy link
Collaborator

@jamescrosswell jamescrosswell left a comment

Choose a reason for hiding this comment

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

LGTM - thanks @alexsohn1126 !

@alexsohn1126 alexsohn1126 merged commit aff12de into master Sep 24, 2025
13 checks passed
@alexsohn1126 alexsohn1126 deleted the alexsohn/fix/add-proguard-related-info-to-maui-msbuild-page branch September 24, 2025 13:34
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.

3 participants