From e8d680743e06693b5cb4786723fea369c380590e Mon Sep 17 00:00:00 2001 From: Alex Sohn Date: Fri, 19 Sep 2025 13:49:49 -0400 Subject: [PATCH 1/6] fix(docs): Add ProGuard related properties to MAUI MSBuild page --- .../dotnet/common/configuration/msbuild.mdx | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/platforms/dotnet/common/configuration/msbuild.mdx b/docs/platforms/dotnet/common/configuration/msbuild.mdx index 14f8861da89ed0..4da8b78dd52b30 100644 --- a/docs/platforms/dotnet/common/configuration/msbuild.mdx +++ b/docs/platforms/dotnet/common/configuration/msbuild.mdx @@ -174,6 +174,13 @@ Sentry will try to determine the release version automatically by checking the f + + +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. + + + Enable `SentrySetCommits` to automatically [associate commits with the release](/cli/releases/#commit-integration). @@ -186,6 +193,25 @@ By default, when `SentrySetCommits` is enabled, the SDK will set commits with th + + +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: + +```xml + +``` + +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. + + + Controls uploading symbols to Sentry during the build. Defaults to `false` (disabled). From ed973869894ce079a5d1b9ac70f56a8a4206d310 Mon Sep 17 00:00:00 2001 From: Alex Sohn <44201357+alexsohn1126@users.noreply.github.com> Date: Mon, 22 Sep 2025 10:06:02 -0400 Subject: [PATCH 2/6] Update docs/platforms/dotnet/common/configuration/msbuild.mdx Co-authored-by: James Crosswell --- docs/platforms/dotnet/common/configuration/msbuild.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/dotnet/common/configuration/msbuild.mdx b/docs/platforms/dotnet/common/configuration/msbuild.mdx index 4da8b78dd52b30..1afd5ac02f1c1c 100644 --- a/docs/platforms/dotnet/common/configuration/msbuild.mdx +++ b/docs/platforms/dotnet/common/configuration/msbuild.mdx @@ -176,7 +176,7 @@ Sentry will try to determine the release version automatically by checking the f -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. +Manually set your ProGuard UUID. This UUID will be used to [upload the ProGuard mapping to Sentry](cli/dif/#proguard-mapping-upload), and set the APK's metadata. If not defined, Sentry will [generate a UUID](../../data-management/debug-files/identifiers/#proguard-uuids) for you. From 9bee8a64653a1f9dede005cdd7f60e381e6a8108 Mon Sep 17 00:00:00 2001 From: Alex Sohn <44201357+alexsohn1126@users.noreply.github.com> Date: Mon, 22 Sep 2025 10:06:11 -0400 Subject: [PATCH 3/6] Update docs/platforms/dotnet/common/configuration/msbuild.mdx Co-authored-by: James Crosswell --- docs/platforms/dotnet/common/configuration/msbuild.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/platforms/dotnet/common/configuration/msbuild.mdx b/docs/platforms/dotnet/common/configuration/msbuild.mdx index 1afd5ac02f1c1c..db7b61edc558f0 100644 --- a/docs/platforms/dotnet/common/configuration/msbuild.mdx +++ b/docs/platforms/dotnet/common/configuration/msbuild.mdx @@ -195,7 +195,9 @@ By default, when `SentrySetCommits` is enabled, the SDK will set commits with th -Controls uploading ProGuard mapping file to Sentry after the build. Defaults to `false` (disabled). +Controls whether ProGuard mapping files get uploaded 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: From 2270e06962a9e79a7316acc345b77cbdadae9fcc Mon Sep 17 00:00:00 2001 From: Alex Sohn <44201357+alexsohn1126@users.noreply.github.com> Date: Mon, 22 Sep 2025 10:07:55 -0400 Subject: [PATCH 4/6] Update msbuild.mdx --- docs/platforms/dotnet/common/configuration/msbuild.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/platforms/dotnet/common/configuration/msbuild.mdx b/docs/platforms/dotnet/common/configuration/msbuild.mdx index db7b61edc558f0..ef6131e29e63da 100644 --- a/docs/platforms/dotnet/common/configuration/msbuild.mdx +++ b/docs/platforms/dotnet/common/configuration/msbuild.mdx @@ -210,8 +210,6 @@ Your resulting APK will be injected with the metadata `io.sentry.proguard-uuid`. 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. - From 9cea97aa379e3952d91060e06a88154e17ad027d Mon Sep 17 00:00:00 2001 From: Alex Sohn Date: Mon, 22 Sep 2025 11:30:36 -0400 Subject: [PATCH 5/6] Improve wording and layout --- .../dotnet/common/configuration/msbuild.mdx | 23 ++++++++++--------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/platforms/dotnet/common/configuration/msbuild.mdx b/docs/platforms/dotnet/common/configuration/msbuild.mdx index ef6131e29e63da..abc5e95fc12b23 100644 --- a/docs/platforms/dotnet/common/configuration/msbuild.mdx +++ b/docs/platforms/dotnet/common/configuration/msbuild.mdx @@ -176,8 +176,9 @@ Sentry will try to determine the release version automatically by checking the f -Manually set your ProGuard UUID. This UUID will be used to [upload the ProGuard mapping to Sentry](cli/dif/#proguard-mapping-upload), and set the APK's metadata. -If not defined, Sentry will [generate a UUID](../../data-management/debug-files/identifiers/#proguard-uuids) for you. +Define the UUID used to link an APK and its ProGuard mapping file. + +If not defined, Sentry will [generate a UUID](#SentryUploadAndroidProGuardMapping) for you. @@ -195,20 +196,20 @@ By default, when `SentrySetCommits` is enabled, the SDK will set commits with th -Controls whether ProGuard mapping files get uploaded to Sentry after the build. +Controls whether a ProGuard mapping file is uploaded to Sentry. 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: +When set to `true`: +- A ProGuard UUID is generated automatically, unless you configure your own via [SentryProGuardUUID](#SentryProGuardUUID). +- This UUID is injected into the APK as manifest metadata under the key `io.sentry.proguard-uuid`. +- The same UUID is used to associate the uploaded ProGuard mapping file with the build in Sentry. -```xml - -``` +This ensures that obfuscated stack traces from your Android app can be correctly de-obfuscated in Sentry. -Do not overwrite `io.sentry.proguard-uuid` metadata directly. See [SentryProGuardUUID](#SentryProGuardUUID) to set your own ProGuard UUID. + +Do not overwrite the `io.sentry.proguard-uuid` metadata directly. Use [SentryProGuardUUID](#SentryProGuardUUID) if you need to provide a custom UUID. + From 90276e3db489cf67041c409c268c0299fcd343d6 Mon Sep 17 00:00:00 2001 From: Alex Sohn Date: Mon, 22 Sep 2025 11:32:21 -0400 Subject: [PATCH 6/6] Change Proguard to ProGuard in msbuild example --- docs/platforms/dotnet/common/configuration/msbuild.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/dotnet/common/configuration/msbuild.mdx b/docs/platforms/dotnet/common/configuration/msbuild.mdx index abc5e95fc12b23..d9b0868c088feb 100644 --- a/docs/platforms/dotnet/common/configuration/msbuild.mdx +++ b/docs/platforms/dotnet/common/configuration/msbuild.mdx @@ -115,7 +115,7 @@ if you only want these features enabled in a GitHub Actions CI workflow, you cou true - true + true