fix(android): Generate sentry.options.json into build folder instead of source tree by antonis · Pull Request #6751 · getsentry/sentry-react-native

antonis · 2026-09-18T07:37:01Z

📢 Type of change

Bugfix
New feature
Enhancement
Refactoring

📜 Description

This PR replaces the copy + cleanup tasks with a typed generateSentryOptions task that:

Writes into build/generated/sentry/options/ — never into src/main/assets.
Declares the source file and the SENTRY_ENVIRONMENT / SENTRY_RELEASE / SENTRY_DIST overrides as task inputs and the output dir as an output, so it participates correctly in up-to-date checks and the build cache.
Is registered as a generated assets source via the AGP Variant API (variant.sources.assets.addGeneratedSourceDirectory, reached reflectively since a script plugin can't depend on AGP types), so AGP wires it into merge*Assets with correct ordering. A classic sourceSets["main"].assets.srcDir + merge*Assets dependsOn fallback covers older AGP.
Stays Configuration Cache compatible (the action reads only captured inputs and does plain file I/O; onlyIf references only the task).

💡 Motivation and Context

Fixes #6750.

💚 How did you test it?

Manually, on samples/react-native (AGP 9.x / Gradle 9.4.1, JDK 17), since there is no Gradle test harness for the script plugin:

📝 Checklist

I added tests to verify changes test(android): Add GradleTestKit tests for sentry.gradle.kts asset tasks #6754
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
I updated the docs if needed.
I updated the wizard if needed.
All tests passing.
Public API changes reviewed by another Mobile SDK team member or implemented according to the develop docs spec.
No breaking changes.

🔮 Next steps

…of source tree The Android Gradle plugin copied `sentry.options.json` into the version-controlled `src/main/assets` during builds via a task with no declared inputs/outputs. That broke Gradle's up-to-date checks and build caching for the asset-merge tasks and required a cleanup task to remove the file afterward, which could leave the file behind on a failed build. Replace it with a typed `generateSentryOptions` task that writes into `build/generated/sentry/options` with declared inputs/outputs (source file plus the SENTRY_ENVIRONMENT/RELEASE/DIST overrides), registered as a generated assets source via the AGP Variant API, with a classic sourceSets fallback for older AGP. Nothing is written into the source tree anymore, and asset merging is now correctly cached. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

github-actions · 2026-09-18T07:37:24Z

Semver Impact of This PR

⚪ None (no version bump detected)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).

fix(android): Generate sentry.options.json into build folder instead of source tree by antonis in #6751

fix(ios): Fix Mac Catalyst linking the wrong Sentry.xcframework slice by antonis in #6758
chore(deps): bump the codeql-action group across 1 directory with 3 updates by dependabot in #6756
chore(deps): bump ruby/setup-ruby from 1.321.0 to 1.324.0 by dependabot in #6757
fix(core): Declare optional peer dependencies to resolve phantom imports under strict package managers by antonis in #6729
Add missing exports and update public API report by antonis in #6731
test(ios): Reenable Session Replay E2E test by antonis in #6737
fix(ios): Honor shutdownTimeout on iOS by antonis in #6749

_{🤖 This preview updates automatically when you update the PR.}

cursor

Stale Bugbot comment from a previous run.

sentry · 2026-09-18T08:03:23Z

📲 Install Builds

Android

🔗 App Name	App ID	Version	Configuration
Sentry RN	io.sentry.reactnative.sample	8.27.0 (107)	Release

⚙️ sentry-react-native Build Distribution Settings

github-actions · 2026-09-18T08:03:42Z

Android (legacy) Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	422.72 ms	448.76 ms	26.03 ms
Size	50.56 MiB	56.49 MiB	5.93 MiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`a2585ce`+dirty	426.36 ms	483.26 ms	56.90 ms
`882f8ae`+dirty	399.98 ms	427.06 ms	27.08 ms
`af33f3b`+dirty	434.90 ms	506.14 ms	71.24 ms
`ecf47a2`+dirty	420.40 ms	458.02 ms	37.62 ms
`acd838e`+dirty	422.63 ms	462.39 ms	39.76 ms
`7fd0012`+dirty	444.73 ms	470.08 ms	25.35 ms
`580fb5c`+dirty	436.34 ms	471.63 ms	35.28 ms
`5ca03f9`+dirty	423.30 ms	467.00 ms	43.70 ms
`5c1e987`+dirty	423.52 ms	471.64 ms	48.12 ms
`822d35b`+dirty	429.31 ms	498.04 ms	68.73 ms

App size

Revision	Plain	With Sentry	Diff
`a2585ce`+dirty	49.74 MiB	55.36 MiB	5.61 MiB
`882f8ae`+dirty	48.30 MiB	53.60 MiB	5.29 MiB
`af33f3b`+dirty	49.74 MiB	55.09 MiB	5.35 MiB
`ecf47a2`+dirty	49.74 MiB	54.82 MiB	5.07 MiB
`acd838e`+dirty	48.30 MiB	53.60 MiB	5.30 MiB
`7fd0012`+dirty	50.56 MiB	56.46 MiB	5.90 MiB
`580fb5c`+dirty	49.74 MiB	54.79 MiB	5.05 MiB
`5ca03f9`+dirty	49.74 MiB	55.26 MiB	5.52 MiB
`5c1e987`+dirty	43.75 MiB	48.08 MiB	4.33 MiB
`822d35b`+dirty	49.74 MiB	54.84 MiB	5.10 MiB

Previous results on branch: al/fix-gradle-sentry-options-generated-assets

Startup times

Revision	Plain	With Sentry	Diff
`6dc72d4`+dirty	468.91 ms	547.58 ms	78.67 ms

App size

Revision	Plain	With Sentry	Diff
`6dc72d4`+dirty	50.56 MiB	56.49 MiB	5.93 MiB

github-actions · 2026-09-18T08:16:02Z

Android (new) Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	428.37 ms	440.90 ms	12.52 ms
Size	50.56 MiB	56.49 MiB	5.93 MiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`f3215d3`+dirty	396.53 ms	436.66 ms	40.13 ms
`d0e3b3e`+dirty	443.19 ms	480.00 ms	36.81 ms
`a5d243c`+dirty	499.20 ms	525.62 ms	26.42 ms
`7fd0012`+dirty	422.41 ms	445.57 ms	23.17 ms
`0a147b2`+dirty	442.80 ms	522.24 ms	79.44 ms
`d7d54c6`+dirty	423.54 ms	498.56 ms	75.02 ms
`c823bb5`+dirty	468.26 ms	516.16 ms	47.90 ms
`5789645`+dirty	502.66 ms	594.19 ms	91.53 ms
`40c9884`+dirty	453.76 ms	478.98 ms	25.22 ms
`d771cd5`+dirty	432.29 ms	464.38 ms	32.09 ms

App size

Revision	Plain	With Sentry	Diff
`f3215d3`+dirty	48.30 MiB	53.49 MiB	5.19 MiB
`d0e3b3e`+dirty	49.74 MiB	55.09 MiB	5.34 MiB
`a5d243c`+dirty	48.30 MiB	53.54 MiB	5.23 MiB
`7fd0012`+dirty	50.56 MiB	56.46 MiB	5.90 MiB
`0a147b2`+dirty	49.74 MiB	55.08 MiB	5.34 MiB
`d7d54c6`+dirty	49.74 MiB	55.09 MiB	5.34 MiB
`c823bb5`+dirty	48.30 MiB	53.58 MiB	5.28 MiB
`5789645`+dirty	49.74 MiB	54.85 MiB	5.11 MiB
`40c9884`+dirty	49.74 MiB	55.09 MiB	5.34 MiB
`d771cd5`+dirty	49.74 MiB	55.36 MiB	5.62 MiB

Previous results on branch: al/fix-gradle-sentry-options-generated-assets

Startup times

Revision	Plain	With Sentry	Diff
`6dc72d4`+dirty	471.48 ms	552.45 ms	80.97 ms

App size

Revision	Plain	With Sentry	Diff
`6dc72d4`+dirty	50.56 MiB	56.49 MiB	5.93 MiB

@input

…out output The lint model/analysis tasks read the generated assets dir without a declared dependency on generateSentryOptions, which Gradle 9 fails as an implicit dependency error. Declare it explicitly. Also make the SENTRY_COPY_OPTIONS_FILE opt-out an @input instead of onlyIf, so disabling it re-runs the task and clears the output dir rather than leaving a stale generated file to be packaged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

cursor

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

^{Reviewed by Cursor Bugbot for commit e855733. Configure here.}

Older plugin versions copied the file into src/main/assets; a crashed build could leave it behind, where it now shadows or conflicts with the generated copy. Emit a configuration-time warning pointing the user to remove it. Never delete it automatically — the file may be intentional. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Cover the generated-asset tasks introduced for issue #6750 (PRs #6751/#6753) with functional tests that apply the real sentry.gradle.kts script plugin to a minimal AGP fixture and drive the tasks through GradleTestKit: - SentryOptionsTaskTest: plain copy, SENTRY_RELEASE override, opt-out via SENTRY_COPY_OPTIONS_FILE=false, and missing-source fallback. - SentryModulesTaskTest: modules.json generated into build/ (never src/main/ assets), UP-TO-DATE on rebuild, skipCollectModules opt-out, and missing source map fallback. Runs on the existing RNSentryAndroidTester testDebugUnitTest job, so no new CI infrastructure is required. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

antonis and others added 2 commits September 18, 2026 09:36

docs(changelog): Reference PR #6751

4d7e879

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

antonis added the ready-to-merge Triggers the full CI test suite label Sep 18, 2026

cursor Bot reviewed Sep 18, 2026

View reviewed changes

Comment thread packages/core/sentry.gradle.kts Outdated

antonis added ready-to-merge Triggers the full CI test suite and removed ready-to-merge Triggers the full CI test suite labels Sep 18, 2026

sentry-warden Bot reviewed Sep 18, 2026

View reviewed changes

Comment thread packages/core/sentry.gradle.kts

sentry-warden Bot reviewed Sep 18, 2026

View reviewed changes

Comment thread packages/core/sentry.gradle.kts

cursor Bot reviewed Sep 18, 2026

View reviewed changes

antonis mentioned this pull request Sep 18, 2026

test(android): Add automated coverage for GenerateSentryOptionsTask (Gradle asset generation) #6752

Open

6 tasks

sentry-warden Bot reviewed Sep 18, 2026

View reviewed changes

Comment thread packages/core/sentry.gradle.kts

antonis marked this pull request as ready for review September 18, 2026 10:00

antonis requested review from alwx and lucas-zimerman as code owners September 18, 2026 10:00

antonis requested a review from runningcode September 18, 2026 10:17

Merge branch 'main' into al/fix-gradle-sentry-options-generated-assets

45a7bba

Uh oh!

Conversation

antonis commented Sep 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📢 Type of change

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

Uh oh!

github-actions Bot commented Sep 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Semver Impact of This PR

Uh oh!

cursor Bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sentry Bot commented Sep 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📲 Install Builds

Android

Uh oh!

github-actions Bot commented Sep 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Android (legacy) Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: al/fix-gradle-sentry-options-generated-assets

Startup times

App size

Uh oh!

github-actions Bot commented Sep 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Android (new) Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: al/fix-gradle-sentry-options-generated-assets

Startup times

App size

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

antonis commented Sep 18, 2026 •

edited

Loading

github-actions Bot commented Sep 18, 2026 •

edited

Loading

cursor Bot left a comment •

edited

Loading

sentry Bot commented Sep 18, 2026 •

edited

Loading

github-actions Bot commented Sep 18, 2026 •

edited

Loading

github-actions Bot commented Sep 18, 2026 •

edited

Loading