chore(samples-android): Support mavenLocal for builds that apply the SAGP (#5539)

chore(samples-android): Support mavenLocal for builds that apply the SAGP

Adds wiring that lets us prefer mavenLocal SAGP artifacts, when present, for Android sample app builds that set -PuseSagp=true. If no local artifact is found, we fall back to libs.versions.toml.

Author: 0xadam-brown

gradle/libs.versions.toml

@@ -29,6 +29,7 @@ otelInstrumentationAlpha = "2.26.0-alpha"
 otelSemanticConventions = "1.40.0"
 otelSemanticConventionsAlpha = "1.40.0-alpha"
 retrofit = "2.9.0"
+sagp = "6.10.0"
 slf4j = "1.7.30"
 springboot2 = "2.7.18"
 springboot3 = "3.5.0"
@@ -66,7 +67,7 @@ springboot4 = { id = "org.springframework.boot", version.ref = "springboot4" }
 spring-dependency-management = { id = "io.spring.dependency-management", version = "1.1.7" }
 gretty = { id = "org.gretty", version = "4.0.0" }
 animalsniffer = { id = "ru.vyarus.animalsniffer", version = "2.0.1" }
-sentry = { id = "io.sentry.android.gradle", version = "6.6.0"}
+sentry = { id = "io.sentry.android.gradle", version.ref = "sagp"}
 shadow = { id = "com.gradleup.shadow", version = "9.4.1" }
 
 [libraries]

sentry-samples/sentry-samples-android/README.md

@@ -16,29 +16,44 @@ or simply open the project in Android Studio and run the `sentry-samples-android
 You can also apply the [Sentry Android Gradle Plugin](https://github.com/getsentry/sentry-android-gradle-plugin) (SAGP) when building (not applied by default):
 
 ```
-./gradlew :sentry-samples:sentry-samples-android:installDebug -PuseSagp=true
+./gradlew :sentry-samples:sentry-samples-android:installDebug -PuseSagp
 ```
 
-In Android Studio, add `useSagp=true` to `gradle.properties` or pass it as a Gradle project property.
+In Android Studio, add `useSagp=` (empty value) to `gradle.properties`, or pass `-PuseSagp` as a Gradle project property.
 
 ## Build modes
 
 ### With or without SAGP
 
 The sample app can be built with or without the SAGP.
 
-| Gradle Property | Required                 | Purpose                                                                                                        |
-|-----------------|--------------------------|----------------------------------------------------------------------------------------------------------------|
-| `useSagp`       | No (defaults to `false`) | When `true`, apply SAGP when building the sample app. When false or absent, build the sample app without SAGP. |
+| Gradle Property | Required | Purpose                                                                                         |
+|-----------------|----------|-------------------------------------------------------------------------------------------------|
+| `useSagp`       | No       | When present, apply SAGP when building the sample app. Omit the property to build without SAGP. |
 
 You can configure SAGP properties via the lambda passed to `extensions.configure<SentryPluginExtension>("sentry")` in the sample app's
 `build.gradle.kts` file.
 
-### Builds against your local sentry-java branch
+### Testing an unpublished SAGP build
 
-Regardless of `useSagp`, the sample always depends on sentry-java modules from this monorepo (e.g., `projects.sentryAndroid`). SAGP's SDK
-auto-installation is disabled, so the sample never pulls a separate SDK version from Maven. Local SDK changes in your branch are picked up
-directly.
+`-PuseSagp` builds check `mavenLocal()` first when resolving SAGP. To test a local SAGP branch:
+
+1. In your `sentry-android-gradle-plugin` checkout, temporarily set a unique local version in `plugin-build/gradle.properties` (e.g.
+   `6.10.0-LOCAL`) and publish to Maven Local:
+
+```
+./gradlew -p plugin-build publishToMavenLocal
+```
+
+Re-run `publishToMavenLocal` after each SAGP change.
+
+2. Temporarily bump the `sagp` pin in `gradle/libs.versions.toml` to match that version.
+
+Then build from sentry-java:
+
+```
+./gradlew :sentry-samples:sentry-samples-android:installDebug -PuseSagp
+```
 
 ## Viewing SDK output
 

sentry-samples/sentry-samples-android/build.gradle.kts

@@ -12,10 +12,7 @@ plugins {
   alias(libs.plugins.sentry) apply false
 }
 
-val useSagp =
-  providers.gradleProperty("useSagp").map { it.equals("true", ignoreCase = true) }.orElse(false)
-
-if (useSagp.get()) {
+if (providers.gradleProperty("useSagp").isPresent) {
   apply(plugin = "io.sentry.android.gradle")
 }
 

settings.gradle.kts

@@ -1,10 +1,19 @@
 enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
 
 pluginManagement {
-    repositories {
-        mavenCentral()
-        gradlePluginPortal()
+  repositories {
+    // Prefer local SAGP artifact if one exists; otherwise fall back to libs.versions.toml.
+    if (providers.gradleProperty("useSagp").isPresent) {
+      mavenLocal {
+        content {
+          includeGroup("io.sentry")
+          includeGroup("io.sentry.android.gradle")
+        }
+      }
     }
+    mavenCentral()
+    gradlePluginPortal()
+  }
 }
 
 plugins {