Skip to content

Commit aff12de

Browse files
authored
fix(docs): Add ProGuard related properties to MAUI MSBuild page (#14995)
Added ProGuard related descriptions for MAUI MSBuild page, and fixed capitalization on mentions of ProGuard
1 parent 685c307 commit aff12de

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

docs/platforms/dotnet/common/configuration/msbuild.mdx

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ if you only want these features enabled in a GitHub Actions CI workflow, you cou
115115
<SentryUploadSources>true</SentryUploadSources>
116116
117117
<!-- If you are targeting Android, sends proguard mapping file to Sentry. -->
118-
<SentryUploadAndroidProguardMapping>true</SentryUploadAndroidProguardMapping>
118+
<SentryUploadAndroidProGuardMapping>true</SentryUploadAndroidProGuardMapping>
119119
120120
</PropertyGroup>
121121
@@ -174,6 +174,14 @@ Sentry will try to determine the release version automatically by checking the f
174174

175175
</ConfigKey>
176176

177+
<ConfigKey name="SentryProGuardUUID" supported={["dotnet.maui"]}>
178+
179+
Define the UUID used to link an APK and its ProGuard mapping file.
180+
181+
If not defined, Sentry will [generate a UUID](#SentryUploadAndroidProGuardMapping) for you.
182+
183+
</ConfigKey>
184+
177185
<ConfigKey name="SentrySetCommits">
178186

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

187195
</ConfigKey>
188196

197+
<ConfigKey name="SentryUploadAndroidProGuardMapping" supported={["dotnet.maui"]}>
198+
199+
Controls whether a ProGuard mapping file is uploaded to Sentry.
200+
201+
Defaults to `false` (disabled).
202+
203+
When set to `true`:
204+
- A ProGuard UUID is generated automatically, unless you configure your own via [SentryProGuardUUID](#SentryProGuardUUID).
205+
- This UUID is injected into the APK as manifest metadata under the key `io.sentry.proguard-uuid`.
206+
- The same UUID is used to associate the uploaded ProGuard mapping file with the build in Sentry.
207+
208+
This ensures that obfuscated stack traces from your Android app can be correctly de-obfuscated in Sentry.
209+
210+
<Alert>
211+
Do not overwrite the `io.sentry.proguard-uuid` metadata directly. Use [SentryProGuardUUID](#SentryProGuardUUID) if you need to provide a custom UUID.
212+
</Alert>
213+
214+
</ConfigKey>
215+
189216
<ConfigKey name="SentryUploadSymbols">
190217

191218
Controls uploading symbols to Sentry during the build. Defaults to `false` (disabled).

0 commit comments

Comments
 (0)