Skip to content

fix(docs): Add ProGuard related properties to MAUI MSBuild page #14995

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

Merged
merged 7 commits into from
Sep 24, 2025
Merged

fix(docs): Add ProGuard related properties to MAUI MSBuild page #14995

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e8d6807
fix(docs): Add ProGuard related properties to MAUI MSBuild page
alexsohn1126 Sep 19, 2025
c9011be
Merge branch 'master' into alexsohn/fix/add-proguard-related-info-to-…
jamescrosswell Sep 19, 2025
ed97386
Update docs/platforms/dotnet/common/configuration/msbuild.mdx
alexsohn1126 Sep 22, 2025
9bee8a6
Update docs/platforms/dotnet/common/configuration/msbuild.mdx
alexsohn1126 Sep 22, 2025
2270e06
Update msbuild.mdx
alexsohn1126 Sep 22, 2025
9cea97a
Improve wording and layout
alexsohn1126 Sep 22, 2025
90276e3
Change Proguard to ProGuard in msbuild example
alexsohn1126 Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/platforms/dotnet/common/configuration/msbuild.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,13 @@ Sentry will try to determine the release version automatically by checking the f

</ConfigKey>

<ConfigKey name="SentryProGuardUUID" supported={["dotnet.maui"]}>

Manually set your ProGuard UUID. This UUID will be used to [upload ProGuard mapping to Sentry](cli/dif/#proguard-mapping-upload), and setting APK's metadata.
If not defined, Sentry will [generate a UUID](../../data-management/debug-files/identifiers/#proguard-uuids) for you.

</ConfigKey>

<ConfigKey name="SentrySetCommits">

Enable `SentrySetCommits` to automatically [associate commits with the release](/cli/releases/#commit-integration).
Expand All @@ -186,6 +193,25 @@ By default, when `SentrySetCommits` is enabled, the SDK will set commits with th

</ConfigKey>

<ConfigKey name="SentryUploadAndroidProGuardMapping" supported={["dotnet.maui"]}>

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.


```xml
<meta-data
android:name="io.sentry.proguard-uuid"
android:value="YOUR-UUID-HERE" />
```

Do not overwrite `io.sentry.proguard-uuid` metadata directly. See [SentryProGuardUUID](#SentryProGuardUUID) to set your own ProGuard UUID.

`UseSentryCLI` must be set to `true` for the ProGuard mapping upload to work.

</ConfigKey>

<ConfigKey name="SentryUploadSymbols">

Controls uploading symbols to Sentry during the build. Defaults to `false` (disabled).
Expand Down
Loading