Reduce scope of API Guardian for downstream Gradle projects

marcphilipp · marcphilipp · commit c5ee49d1347b · 2021-06-20T11:03:04.000+02:00
diff --git a/documentation/documentation.gradle.kts b/documentation/documentation.gradle.kts
@@ -44,6 +44,9 @@ dependencies {
 
 	testImplementation(projects.junitVintageEngine)
 	testRuntimeOnly(libs.bundles.log4j)
+	testRuntimeOnly(libs.apiguardian) {
+		because("it's required to generate API tables")
+	}
 
 	testImplementation(libs.classgraph) {
 		because("ApiReportGenerator needs it")
diff --git a/documentation/src/docs/asciidoc/release-notes/release-notes-5.8.0-M2.adoc b/documentation/src/docs/asciidoc/release-notes/release-notes-5.8.0-M2.adoc
@@ -10,6 +10,13 @@ link:{junit5-repo}+/milestone/55?closed=1+[5.8 M2] milestone page in the JUnit r
 on GitHub.
 
 
+[[release-notes-5.8.0-M2-general-improvements]]
+=== General improvements
+
+* The API Guardian dependency is now exported as a compile-only dependency for consuming
+  Gradle projects.
+
+
 [[release-notes-5.8.0-M2-junit-platform]]
 === JUnit Platform
 
diff --git a/junit-jupiter-api/junit-jupiter-api.gradle.kts b/junit-jupiter-api/junit-jupiter-api.gradle.kts
@@ -7,9 +7,10 @@ description = "JUnit Jupiter API"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(libs.opentest4j)
 	api(projects.junitPlatformCommons)
 
+	compileOnlyApi(libs.apiguardian)
+
 	compileOnly(kotlin("stdlib"))
 }
diff --git a/junit-jupiter-engine/junit-jupiter-engine.gradle.kts b/junit-jupiter-engine/junit-jupiter-engine.gradle.kts
@@ -11,10 +11,11 @@ description = "JUnit Jupiter Engine"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(projects.junitPlatformEngine)
 	api(projects.junitJupiterApi)
 
+	compileOnlyApi(libs.apiguardian)
+
 	testImplementation(projects.junitPlatformLauncher)
 	testImplementation(projects.junitPlatformRunner)
 	testImplementation(projects.junitPlatformTestkit)
diff --git a/junit-jupiter-migrationsupport/junit-jupiter-migrationsupport.gradle.kts b/junit-jupiter-migrationsupport/junit-jupiter-migrationsupport.gradle.kts
@@ -11,9 +11,10 @@ description = "JUnit Jupiter Migration Support"
 dependencies {
 	api(platform(projects.junitBom))
 	api(libs.junit4)
-	api(libs.apiguardian)
 	api(projects.junitJupiterApi)
 
+	compileOnlyApi(libs.apiguardian)
+
 	testImplementation(projects.junitJupiterEngine)
 	testImplementation(projects.junitPlatformLauncher)
 	testImplementation(projects.junitPlatformRunner)
diff --git a/junit-jupiter-params/junit-jupiter-params.gradle.kts b/junit-jupiter-params/junit-jupiter-params.gradle.kts
@@ -8,9 +8,10 @@ description = "JUnit Jupiter Params"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(projects.junitJupiterApi)
 
+	compileOnlyApi(libs.apiguardian)
+
 	shadowed(libs.univocity.parsers)
 
 	testImplementation(projects.junitPlatformTestkit)
diff --git a/junit-platform-commons/junit-platform-commons.gradle.kts b/junit-platform-commons/junit-platform-commons.gradle.kts
@@ -9,7 +9,8 @@ description = "JUnit Platform Commons"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
+
+	compileOnlyApi(libs.apiguardian)
 }
 
 tasks.jar {
diff --git a/junit-platform-console-standalone/junit-platform-console-standalone.gradle.kts b/junit-platform-console-standalone/junit-platform-console-standalone.gradle.kts
@@ -13,6 +13,9 @@ dependencies {
 	shadowed(projects.junitJupiterEngine)
 	shadowed(projects.junitJupiterParams)
 	shadowed(projects.junitVintageEngine)
+	shadowed(libs.apiguardian) {
+		because("downstream projects need it to avoid compiler warnings")
+	}
 }
 
 val jupiterVersion = rootProject.version
diff --git a/junit-platform-console/junit-platform-console.gradle.kts b/junit-platform-console/junit-platform-console.gradle.kts
@@ -9,9 +9,10 @@ description = "JUnit Platform Console"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(projects.junitPlatformReporting)
 
+	compileOnlyApi(libs.apiguardian)
+
 	shadowed(libs.picocli)
 }
 
diff --git a/junit-platform-engine/junit-platform-engine.gradle.kts b/junit-platform-engine/junit-platform-engine.gradle.kts
@@ -7,9 +7,10 @@ description = "JUnit Platform Engine API"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(libs.opentest4j)
 	api(projects.junitPlatformCommons)
 
+	compileOnlyApi(libs.apiguardian)
+
 	testImplementation(libs.assertj)
 }
diff --git a/junit-platform-jfr/junit-platform-jfr.gradle.kts b/junit-platform-jfr/junit-platform-jfr.gradle.kts
@@ -6,8 +6,9 @@ description = "JUnit Platform Flight Recorder Support"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(projects.junitPlatformLauncher)
+
+	compileOnlyApi(libs.apiguardian)
 }
 
 javaLibrary {
diff --git a/junit-platform-launcher/junit-platform-launcher.gradle.kts b/junit-platform-launcher/junit-platform-launcher.gradle.kts
@@ -7,6 +7,7 @@ description = "JUnit Platform Launcher"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(projects.junitPlatformEngine)
+
+	compileOnlyApi(libs.apiguardian)
 }
diff --git a/junit-platform-reporting/junit-platform-reporting.gradle.kts b/junit-platform-reporting/junit-platform-reporting.gradle.kts
@@ -6,6 +6,7 @@ description = "JUnit Platform Reporting"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(projects.junitPlatformLauncher)
+
+	compileOnlyApi(libs.apiguardian)
 }
diff --git a/junit-platform-runner/junit-platform-runner.gradle.kts b/junit-platform-runner/junit-platform-runner.gradle.kts
@@ -10,10 +10,11 @@ description = "JUnit Platform Runner"
 dependencies {
 	api(platform(projects.junitBom))
 	api(libs.junit4)
-	api(libs.apiguardian)
 	api(projects.junitPlatformLauncher)
 	api(projects.junitPlatformSuiteApi)
 
+	compileOnlyApi(libs.apiguardian)
+
 	implementation(projects.junitPlatformSuiteCommons)
 
 	testImplementation(testFixtures(projects.junitPlatformEngine))
diff --git a/junit-platform-suite-api/junit-platform-suite-api.gradle.kts b/junit-platform-suite-api/junit-platform-suite-api.gradle.kts
@@ -6,8 +6,9 @@ description = "JUnit Platform Suite API"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(projects.junitPlatformCommons)
 
+	compileOnlyApi(libs.apiguardian)
+
 	osgiVerification(projects.junitPlatformCommons)
 }
diff --git a/junit-platform-suite-commons/junit-platform-suite-commons.gradle.kts b/junit-platform-suite-commons/junit-platform-suite-commons.gradle.kts
@@ -6,9 +6,10 @@ description = "JUnit Platform Suite Commons"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(projects.junitPlatformLauncher)
 
+	compileOnlyApi(libs.apiguardian)
+
 	implementation(projects.junitPlatformEngine)
 	implementation(projects.junitPlatformSuiteApi)
 }
diff --git a/junit-platform-suite-engine/junit-platform-suite-engine.gradle.kts b/junit-platform-suite-engine/junit-platform-suite-engine.gradle.kts
@@ -6,9 +6,10 @@ description = "JUnit Platform Suite Engine"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(projects.junitPlatformEngine)
 	api(projects.junitPlatformSuiteApi)
 
+	compileOnlyApi(libs.apiguardian)
+
 	implementation(projects.junitPlatformSuiteCommons)
 }
diff --git a/junit-platform-testkit/junit-platform-testkit.gradle.kts b/junit-platform-testkit/junit-platform-testkit.gradle.kts
@@ -6,8 +6,9 @@ description = "JUnit Platform Test Kit"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(libs.assertj)
 	api(libs.opentest4j)
 	api(projects.junitPlatformLauncher)
+
+	compileOnlyApi(libs.apiguardian)
 }
diff --git a/junit-vintage-engine/junit-vintage-engine.gradle.kts b/junit-vintage-engine/junit-vintage-engine.gradle.kts
@@ -12,10 +12,11 @@ description = "JUnit Vintage Engine"
 
 dependencies {
 	api(platform(projects.junitBom))
-	api(libs.apiguardian)
 	api(projects.junitPlatformEngine)
 	api(libs.junit4)
 
+	compileOnlyApi(libs.apiguardian)
+
 	testFixturesApi(platform(libs.groovy2.bom))
 	testFixturesApi(libs.spock1)
 	testFixturesImplementation(projects.junitPlatformRunner)

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,8 @@ description = "JUnit Platform Commons"`
`9`	`9`
`10`	`10`	`dependencies {`
`11`	`11`	`api(platform(projects.junitBom))`
`12`		`- api(libs.apiguardian)`
	`12`	`+`
	`13`	`+ compileOnlyApi(libs.apiguardian)`
`13`	`14`	`}`
`14`	`15`
`15`	`16`	`tasks.jar {`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,9 @@ dependencies {`
`13`	`13`	`shadowed(projects.junitJupiterEngine)`
`14`	`14`	`shadowed(projects.junitJupiterParams)`
`15`	`15`	`shadowed(projects.junitVintageEngine)`
	`16`	`+ shadowed(libs.apiguardian) {`
	`17`	`+ because("downstream projects need it to avoid compiler warnings")`
	`18`	`+ }`
`16`	`19`	`}`
`17`	`20`
`18`	`21`	`val jupiterVersion = rootProject.version`
Original file line number	Diff line number	Diff line change
`@@ -9,9 +9,10 @@ description = "JUnit Platform Console"`
`9`	`9`
`10`	`10`	`dependencies {`
`11`	`11`	`api(platform(projects.junitBom))`
`12`		`- api(libs.apiguardian)`
`13`	`12`	`api(projects.junitPlatformReporting)`
`14`	`13`
	`14`	`+ compileOnlyApi(libs.apiguardian)`
	`15`	`+`
`15`	`16`	`shadowed(libs.picocli)`
`16`	`17`	`}`
`17`	`18`