Skip to content

build: Add Java 8 API compatibility checks #5745

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

Open
adinauer wants to merge 6 commits into
base: main
Choose a base branch
from
Open

build: Add Java 8 API compatibility checks #5745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
305dafe
build: Add Java 8 API compatibility checks
adinauer Jul 8, 2026
5b45502
build: Extract Animal Sniffer convention plugins
adinauer Jul 9, 2026
2c8712b
build: Use catalog aliases for Animal Sniffer signatures
adinauer Jul 9, 2026
555d74a
build: Remove Animal Sniffer reflection
adinauer Jul 9, 2026
e53d673
build: Avoid afterEvaluate for Animal Sniffer config
adinauer Jul 9, 2026
de9fc0f
build: Make Animal Sniffer extension config-only
runningcode Jul 10, 2026
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
14 changes: 14 additions & 0 deletions build-logic/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,19 @@ repositories {
}

dependencies {
implementation(libs.animalsniffer.gradle.plugin)
implementation(libs.spotlessLib)
}

gradlePlugin {
plugins {
register("sentryAnimalSniffer") {
id = "io.sentry.animalsniffer"
implementationClass = "io.sentry.gradle.SentryAnimalSnifferPlugin"
}
register("sentryAnimalSnifferAndroid") {
id = "io.sentry.animalsniffer.android"
implementationClass = "io.sentry.gradle.SentryAnimalSnifferAndroidPlugin"
}
}
}
57 changes: 57 additions & 0 deletions build-logic/src/main/kotlin/io/sentry/gradle/SentryAnimalSnifferPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package io.sentry.gradle

import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.artifacts.MinimalExternalModuleDependency
import org.gradle.api.artifacts.VersionCatalogsExtension
import org.gradle.api.provider.ListProperty
import ru.vyarus.gradle.plugin.animalsniffer.AnimalSniffer

abstract class SentryAnimalSnifferExtension {
abstract val ignoredClasses: ListProperty<String>
abstract val excludedClasses: ListProperty<String>

fun ignoreClasses(vararg classes: String) {
ignoredClasses.addAll(*classes)
}

fun mainExcludes(vararg excludes: String) {
excludedClasses.addAll(*excludes)
}
}

class SentryAnimalSnifferPlugin : Plugin<Project> {
override fun apply(project: Project) {
project.pluginManager.apply("ru.vyarus.animalsniffer")

val extension =
project.extensions.create("sentryAnimalSniffer", SentryAnimalSnifferExtension::class.java)

project.addSignatureDependency("java18-signature")

project.tasks.named("animalsnifferMain", AnimalSniffer::class.java).configure {
ignoreClasses = ignoreClasses + extension.ignoredClasses.get()
exclude(extension.excludedClasses.get())
}

project.tasks.named("check").configure { dependsOn("animalsnifferMain") }
}
}

class SentryAnimalSnifferAndroidPlugin : Plugin<Project> {
override fun apply(project: Project) {
project.pluginManager.apply(SentryAnimalSnifferPlugin::class.java)

project.addSignatureDependency("gummy-bears-api21")
}
}

private fun Project.addSignatureDependency(libraryName: String) {
val libs = extensions.getByType(VersionCatalogsExtension::class.java).named("libs")
dependencies.add("signature", signatureNotation(libs.findLibrary(libraryName).get().get()))
}

private fun signatureNotation(dependency: MinimalExternalModuleDependency): String {
val module = "${dependency.module.group}:${dependency.module.name}"
return "$module:${dependency.versionConstraint.requiredVersion}@signature"
}
6 changes: 5 additions & 1 deletion gradle/libs.versions.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[versions]
animalsniffer = "2.0.1"
apollo = "2.5.9"
androidxLifecycle = "2.2.0"
androidxNavigation = "2.4.2"
Expand All @@ -11,6 +12,7 @@ coroutines = "1.6.1"
espresso = "3.7.0"
feign = "11.6"
gummyBears = "0.12.0"
java18Signature = "1.0"

@runningcode runningcode Jul 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: is this java 1.8 or java 18? it is hard to tell. we should add a comment or some other way to distinguish

jackson = "2.18.3"
jetbrainsCompose = "1.6.11"
kotlin = "2.2.0"
Expand Down Expand Up @@ -72,11 +74,12 @@ springboot4 = { id = "org.springframework.boot", version.ref = "springboot4" }
spring-dependency-management = { id = "io.spring.dependency-management", version = "1.1.7" }
sqldelight = { id = "app.cash.sqldelight", version.ref = "sqldelight" }
gretty = { id = "org.gretty", version = "4.0.0" }
animalsniffer = { id = "ru.vyarus.animalsniffer", version = "2.0.1" }
animalsniffer = { id = "ru.vyarus.animalsniffer", version.ref = "animalsniffer" }
sentry = { id = "io.sentry.android.gradle", version.ref = "sagp"}
shadow = { id = "com.gradleup.shadow", version = "9.4.1" }

[libraries]
animalsniffer-gradle-plugin = { module = "ru.vyarus:gradle-animalsniffer-plugin", version.ref = "animalsniffer" }
apache-httpclient = { module = "org.apache.httpcomponents.client5:httpclient5", version = "5.0.4" }
apollo2-coroutines = { module = "com.apollographql.apollo:apollo-coroutines-support", version.ref = "apollo" }
apollo2-runtime = { module = "com.apollographql.apollo:apollo-runtime", version.ref = "apollo" }
Expand Down Expand Up @@ -226,6 +229,7 @@ timber = { module = "com.jakewharton.timber:timber", version = "4.7.1" }

# Animalsniffer signature
gummy-bears-api21 = { module = "com.toasttab.android:gummy-bears-api-21", version.ref = "gummyBears" }
java18-signature = { module = "org.codehaus.mojo.signature:java18", version.ref = "java18Signature" }

# tomcat libraries
tomcat-catalina = { module = "org.apache.tomcat:tomcat-catalina", version = "9.0.108" }
Expand Down
1 change: 1 addition & 0 deletions sentry-apache-http-client-5/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

plugins {
`java-library`
id("io.sentry.animalsniffer")
id("io.sentry.javadoc")
alias(libs.plugins.kotlin.jvm)
alias(libs.plugins.errorprone)
Expand Down
7 changes: 1 addition & 6 deletions sentry-apollo-3/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
alias(libs.plugins.animalsniffer)
id("io.sentry.animalsniffer.android")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down Expand Up @@ -37,13 +37,8 @@ dependencies {
testImplementation(libs.mockito.kotlin)
testImplementation(libs.mockito.inline)
testImplementation(libs.okhttp.mockwebserver)

val gummyBearsModule = libs.gummy.bears.api21.get().module
signature("${gummyBearsModule}:${libs.versions.gummyBears.get()}@signature")
}

tasks { check { dependsOn(animalsnifferMain) } }

tasks.withType<JavaCompile>().configureEach {
options.errorprone {
check("NullAway", net.ltgt.gradle.errorprone.CheckSeverity.ERROR)
Expand Down
7 changes: 1 addition & 6 deletions sentry-apollo-4/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
alias(libs.plugins.animalsniffer)
id("io.sentry.animalsniffer.android")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down Expand Up @@ -39,13 +39,8 @@ dependencies {
testImplementation(libs.mockito.inline)
testImplementation(libs.okhttp.mockwebserver)
testImplementation("org.jetbrains.kotlin:kotlin-reflect:2.0.0")

val gummyBearsModule = libs.gummy.bears.api21.get().module
signature("${gummyBearsModule}:${libs.versions.gummyBears.get()}@signature")
}

tasks { check { dependsOn(animalsnifferMain) } }

tasks.withType<JavaCompile>().configureEach {
options.errorprone {
check("NullAway", net.ltgt.gradle.errorprone.CheckSeverity.ERROR)
Expand Down
7 changes: 1 addition & 6 deletions sentry-apollo/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
alias(libs.plugins.animalsniffer)
id("io.sentry.animalsniffer.android")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down Expand Up @@ -38,13 +38,8 @@ dependencies {
testImplementation(libs.mockito.kotlin)
testImplementation(libs.mockito.inline)
testImplementation(libs.okhttp.mockwebserver)

val gummyBearsModule = libs.gummy.bears.api21.get().module
signature("${gummyBearsModule}:${libs.versions.gummyBears.get()}@signature")
}

tasks { check { dependsOn(animalsnifferMain) } }

tasks.withType<JavaCompile>().configureEach {
options.errorprone {
check("NullAway", net.ltgt.gradle.errorprone.CheckSeverity.ERROR)
Expand Down
1 change: 1 addition & 0 deletions sentry-async-profiler/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
1 change: 1 addition & 0 deletions sentry-graphql-22/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
1 change: 1 addition & 0 deletions sentry-graphql-core/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
1 change: 1 addition & 0 deletions sentry-graphql/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
1 change: 1 addition & 0 deletions sentry-jcache/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
1 change: 1 addition & 0 deletions sentry-jdbc/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
1 change: 1 addition & 0 deletions sentry-jul/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
1 change: 1 addition & 0 deletions sentry-kafka/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
7 changes: 1 addition & 6 deletions sentry-kotlin-extensions/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.detekt)
alias(libs.plugins.animalsniffer)
id("io.sentry.animalsniffer.android")
}

tasks.withType<KotlinCompile>().configureEach {
Expand All @@ -32,13 +32,8 @@ dependencies {
testImplementation(libs.kotlinx.coroutines)
testImplementation(libs.kotlinx.coroutines.test)
testImplementation(libs.mockito.kotlin)

val gummyBearsModule = libs.gummy.bears.api21.get().module
signature("${gummyBearsModule}:${libs.versions.gummyBears.get()}@signature")
}

tasks { check { dependsOn(animalsnifferMain) } }

tasks.withType<Detekt>().configureEach {
// Target version of the generated JVM bytecode. It is used for type resolution.
jvmTarget = JavaVersion.VERSION_1_8.toString()
Expand Down
7 changes: 1 addition & 6 deletions sentry-ktor-client/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
alias(libs.plugins.animalsniffer)
id("io.sentry.animalsniffer.android")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down Expand Up @@ -39,13 +39,8 @@ dependencies {
testImplementation(libs.ktor.client.core)
testImplementation(libs.ktor.client.java)
testImplementation(libs.okhttp.mockwebserver)

val gummyBearsModule = libs.gummy.bears.api21.get().module
signature("${gummyBearsModule}:${libs.versions.gummyBears.get()}@signature")
}

tasks { check { dependsOn(animalsnifferMain) } }

buildConfig {
useJavaOutput()
packageName("io.sentry.ktorClient")
Expand Down
1 change: 1 addition & 0 deletions sentry-launchdarkly-server/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
1 change: 1 addition & 0 deletions sentry-log4j2/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
1 change: 1 addition & 0 deletions sentry-logback/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
7 changes: 1 addition & 6 deletions sentry-okhttp/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
alias(libs.plugins.animalsniffer)
id("io.sentry.animalsniffer.android")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down Expand Up @@ -38,13 +38,8 @@ dependencies {
testImplementation(libs.mockito.inline)
testImplementation(libs.okhttp)
testImplementation(libs.okhttp.mockwebserver)

val gummyBearsModule = libs.gummy.bears.api21.get().module
signature("${gummyBearsModule}:${libs.versions.gummyBears.get()}@signature")
}

tasks { check { dependsOn(animalsnifferMain) } }

buildConfig {
useJavaOutput()
packageName("io.sentry.okhttp")
Expand Down
1 change: 1 addition & 0 deletions sentry-openfeature/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
1 change: 1 addition & 0 deletions sentry-openfeign/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ plugins {
alias(libs.plugins.errorprone)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

tasks.withType<KotlinCompile>().configureEach {
Expand Down
1 change: 1 addition & 0 deletions sentry-opentelemetry/sentry-opentelemetry-agent/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar

plugins {
`java-library`
id("io.sentry.animalsniffer")
id("io.sentry.javadoc")
alias(libs.plugins.shadow)
}
Expand Down
1 change: 1 addition & 0 deletions sentry-opentelemetry/sentry-opentelemetry-agentcustomization/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

plugins {
`java-library`
id("io.sentry.animalsniffer")
id("io.sentry.javadoc")
alias(libs.plugins.kotlin.jvm)
alias(libs.plugins.errorprone)
Expand Down
1 change: 1 addition & 0 deletions sentry-opentelemetry/sentry-opentelemetry-agentless-spring/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ plugins {
`java-library`
id("io.sentry.javadoc")
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

dependencies {
Expand Down
1 change: 1 addition & 0 deletions sentry-opentelemetry/sentry-opentelemetry-agentless/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ plugins {
`java-library`
id("io.sentry.javadoc")
alias(libs.plugins.buildconfig)
id("io.sentry.animalsniffer")
}

dependencies {
Expand Down
Loading
Loading