Use human readable project description for module name in POMs

marcphilipp · marcphilipp · commit 9f197e967d97 · 2018-04-14T19:29:06.000+02:00
diff --git a/build.gradle b/build.gradle
@@ -292,6 +292,8 @@ subprojects { subproj ->
 
 	if (subproj.name in mavenizedProjects) {
 
+		apply from: "$rootDir/gradle/maven.gradle"
+
 		subproj.ext.baseline = null
 
 		if (subproj.name in jupiterProjects) {
@@ -309,9 +311,6 @@ subprojects { subproj ->
 			subproj.baseline = vintageBaseline
 		}
 
-		// apply after `project.group`, etc. have been set
-		apply from: "$rootDir/gradle/maven.gradle"
-
 		configurations {
 			base
 		}
diff --git a/gradle/maven.gradle b/gradle/maven.gradle
@@ -45,7 +45,6 @@ def mavenDeployer = uploadArchives.repositories.mavenDeployer
 
 [mavenInstaller, mavenDeployer]*.pom {
 	project {
-		name "${project.group}:${project.name}"
 		packaging 'jar'
 		description "Module \"${project.name}\" of JUnit 5."
 		url 'http://junit.org/junit5/'
@@ -97,6 +96,8 @@ def mavenDeployer = uploadArchives.repositories.mavenDeployer
 		}
 	}
 	whenConfigured {
+		// set name lazily to get access to description from subprojects
+		name = project.description ?: "${project.group}:${project.name}"
 		dependencies = dependencies.findAll { dep -> dep.scope != 'test' }
 	}
 }
diff --git a/junit-bom/junit-bom.gradle b/junit-bom/junit-bom.gradle
@@ -15,7 +15,6 @@ def mavenDeployer = uploadArchives.repositories.mavenDeployer
 [mavenInstaller, mavenDeployer]*.pom {
 	project {
 		artifactId = project.name
-		name = project.description
 		description = project.description
 	}
 	whenConfigured {
diff --git a/junit-jupiter-api/junit-jupiter-api.gradle b/junit-jupiter-api/junit-jupiter-api.gradle
@@ -1,3 +1,5 @@
+description = 'JUnit Jupiter API'
+
 dependencies {
 	api("org.opentest4j:opentest4j:${ota4jVersion}")
 	api(project(":junit-platform-commons"))
diff --git a/junit-jupiter-engine/junit-jupiter-engine.gradle b/junit-jupiter-engine/junit-jupiter-engine.gradle
@@ -1,5 +1,7 @@
 apply plugin: 'org.junit.platform.gradle.plugin'
 
+description = 'JUnit Jupiter Engine'
+
 junitPlatform {
 	filters {
 		engines {
diff --git a/junit-jupiter-migrationsupport/junit-jupiter-migrationsupport.gradle b/junit-jupiter-migrationsupport/junit-jupiter-migrationsupport.gradle
@@ -1,5 +1,7 @@
 apply plugin: 'org.junit.platform.gradle.plugin'
 
+description = 'JUnit Jupiter Migration Support'
+
 junitPlatform {
 	filters {
 		engines {
diff --git a/junit-jupiter-params/junit-jupiter-params.gradle b/junit-jupiter-params/junit-jupiter-params.gradle
@@ -1,6 +1,8 @@
 apply plugin: 'org.junit.platform.gradle.plugin'
 apply plugin: 'com.github.johnrengelman.shadow'
 
+description = 'JUnit Jupiter Params'
+
 buildscript {
 	repositories {
 		jcenter()
diff --git a/junit-platform-commons/junit-platform-commons.gradle b/junit-platform-commons/junit-platform-commons.gradle
@@ -1,3 +1,5 @@
+description = 'JUnit Platform Commons'
+
 jar {
 	manifest {
 		attributes(
diff --git a/junit-platform-console-standalone/junit-platform-console-standalone.gradle b/junit-platform-console-standalone/junit-platform-console-standalone.gradle
@@ -1,6 +1,8 @@
 apply plugin: 'java-library'
 apply plugin: 'com.github.johnrengelman.shadow'
 
+description = 'JUnit Platform Console Standalone'
+
 buildscript {
 	repositories {
 		jcenter()
diff --git a/junit-platform-console/junit-platform-console.gradle b/junit-platform-console/junit-platform-console.gradle
@@ -1,5 +1,7 @@
 apply plugin: 'com.github.johnrengelman.shadow'
 
+description = 'JUnit Platform Console'
+
 buildscript {
 	repositories {
 		jcenter()
diff --git a/junit-platform-engine/junit-platform-engine.gradle b/junit-platform-engine/junit-platform-engine.gradle
@@ -1,3 +1,5 @@
+description = 'JUnit Platform Engine API'
+
 configurations {
 	testArtifacts.extendsFrom testRuntime
 }
diff --git a/junit-platform-gradle-plugin/junit-platform-gradle-plugin.gradle b/junit-platform-gradle-plugin/junit-platform-gradle-plugin.gradle
@@ -5,6 +5,8 @@ plugins {
 
 apply from: 'gradle/functional-test.gradle'
 
+description = 'JUnit Platform Gradle Plugin (deprecated)'
+
 generateJacocoTestKitProperties {
 	destinationFile = file("$buildDir/jacoco/testkit.exec")
 	onlyIf { project.hasProperty('enableJaCoCo') }
diff --git a/junit-platform-launcher/junit-platform-launcher.gradle b/junit-platform-launcher/junit-platform-launcher.gradle
@@ -1,3 +1,5 @@
+description = 'JUnit Platform Launcher'
+
 dependencies {
 	api(project(':junit-platform-engine'))
 }
diff --git a/junit-platform-runner/junit-platform-runner.gradle b/junit-platform-runner/junit-platform-runner.gradle
@@ -1,3 +1,5 @@
+description = 'JUnit Platform Runner'
+
 dependencies {
 	api(project(':junit-platform-launcher'))
 	api(project(':junit-platform-suite-api'))
diff --git a/junit-platform-suite-api/junit-platform-suite-api.gradle b/junit-platform-suite-api/junit-platform-suite-api.gradle
@@ -1,3 +1,5 @@
+description = 'JUnit Platform Suite API'
+
 dependencies {
 	api(project(':junit-platform-commons'))
 }
diff --git a/junit-platform-surefire-provider/junit-platform-surefire-provider.gradle b/junit-platform-surefire-provider/junit-platform-surefire-provider.gradle
@@ -1,5 +1,7 @@
 apply plugin: 'org.junit.platform.gradle.plugin'
 
+description = "JUnit Platform Surefire Provider"
+
 junitPlatform {
 	filters {
 		engines {
diff --git a/junit-vintage-engine/junit-vintage-engine.gradle b/junit-vintage-engine/junit-vintage-engine.gradle
@@ -1,5 +1,7 @@
 apply plugin: 'org.junit.platform.gradle.plugin'
 
+description = 'JUnit Vintage Engine'
+
 junitPlatform {
 	filters {
 		engines {

Original file line number	Diff line number	Diff line change
`@@ -292,6 +292,8 @@ subprojects { subproj ->`
`292`	`292`
`293`	`293`	`if (subproj.name in mavenizedProjects) {`
`294`	`294`
	`295`	`+ apply from: "$rootDir/gradle/maven.gradle"`
	`296`	`+`
`295`	`297`	`subproj.ext.baseline = null`
`296`	`298`
`297`	`299`	`if (subproj.name in jupiterProjects) {`
`@@ -309,9 +311,6 @@ subprojects { subproj ->`
`309`	`311`	`subproj.baseline = vintageBaseline`
`310`	`312`	`}`
`311`	`313`
`312`		- // apply after `project.group`, etc. have been set
`313`		`- apply from: "$rootDir/gradle/maven.gradle"`
`314`		`-`
`315`	`314`	`configurations {`
`316`	`315`	`base`
`317`	`316`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,6 @@ def mavenDeployer = uploadArchives.repositories.mavenDeployer`
`45`	`45`
`46`	`46`	`[mavenInstaller, mavenDeployer]*.pom {`
`47`	`47`	`project {`
`48`		`- name "${project.group}:${project.name}"`
`49`	`48`	`packaging 'jar'`
`50`	`49`	`description "Module \"${project.name}\" of JUnit 5."`
`51`	`50`	`url 'http://junit.org/junit5/'`
`@@ -97,6 +96,8 @@ def mavenDeployer = uploadArchives.repositories.mavenDeployer`
`97`	`96`	`}`
`98`	`97`	`}`
`99`	`98`	`whenConfigured {`
	`99`	`+ // set name lazily to get access to description from subprojects`
	`100`	`+ name = project.description ?: "${project.group}:${project.name}"`
`100`	`101`	`dependencies = dependencies.findAll { dep -> dep.scope != 'test' }`
`101`	`102`	`}`
`102`	`103`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,6 @@ def mavenDeployer = uploadArchives.repositories.mavenDeployer`
`15`	`15`	`[mavenInstaller, mavenDeployer]*.pom {`
`16`	`16`	`project {`
`17`	`17`	`artifactId = project.name`
`18`		`- name = project.description`
`19`	`18`	`description = project.description`
`20`	`19`	`}`
`21`	`20`	`whenConfigured {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+description = 'JUnit Jupiter API'`
	`2`	`+`
`1`	`3`	`dependencies {`
`2`	`4`	`api("org.opentest4j:opentest4j:${ota4jVersion}")`
`3`	`5`	`api(project(":junit-platform-commons"))`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+description = 'JUnit Platform Commons'`
	`2`	`+`
`1`	`3`	`jar {`
`2`	`4`	`manifest {`
`3`	`5`	`attributes(`