Migrate build to shared convention plugins setup

Author: jjohannes

.github/workflows/dependency-submission.yml

@@ -0,0 +1,19 @@
+name: Dependency Submission
+
+on: [ push ]
+
+permissions:
+  contents: write
+
+jobs:
+  dependency-submission:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v5
+      - name: Generate and submit dependency graph
+        uses: gradle/actions/dependency-submission@v5
+        with:
+          build-scan-publish: true
+          build-scan-terms-of-use-url: "https://gradle.com/terms-of-service"
+          build-scan-terms-of-use-agree: "yes"

.github/workflows/release.yml

@@ -13,9 +13,9 @@ jobs:
           distribution: temurin
           java-version: 17.0.16
       - uses: gradle/actions/setup-gradle@v5
-      - run: "./gradlew publishAggregationToCentralPortal -Psign=true"
+      - run: "./gradlew publishAggregationToCentralPortal"
         env:
           SIGNING_KEY: ${{ secrets.SIGNING_KEY }}
           SIGNING_PASSPHRASE: ${{ secrets.SIGNING_PASSPHRASE }}
-          MAVEN_CENTRAL_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
-          MAVEN_CENTRAL_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
+          MAVENCENTRAL_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
+          MAVENCENTRAL_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}

build.gradle.kts

@@ -1,16 +1,5 @@
-plugins {
-    val nmcpVersion = "1.2.0"
-    val mavenPluginDevVersion = "1.0.3"
+plugins { id("org.gradlex.maven-plugin-development") version "1.0.3" }
 
-    id("com.gradleup.nmcp") version nmcpVersion
-    id("com.gradleup.nmcp.aggregation") version nmcpVersion
-    id("org.gradlex.maven-plugin-development") version mavenPluginDevVersion
-    id("maven-publish")
-    id("signing")
-    id("checkstyle")
-}
-
-group = "org.gradlex"
 version = "1.2"
 
 val mvnVersion = "3.9.11"
@@ -21,98 +10,28 @@ dependencies {
     compileOnly("org.apache.maven:maven-core:$mvnVersion")
     compileOnly("org.apache.maven:maven-plugin-api:$mvnVersion")
     compileOnly("org.apache.maven.plugin-tools:maven-plugin-annotations:3.15.2")
-
-    nmcpAggregation(project(path))
 }
 
-mavenPlugin {
-    name = "Gradle Module Metadata Maven Plugin"
-    description = "A Maven plugin to publish Gradle Module Metadata"
-    helpMojoPackage = "org.gradlex.maven.gmm"
-}
-
-java {
-    toolchain.languageVersion = JavaLanguageVersion.of(17)
-    withSourcesJar()
-    withJavadocJar()
-}
-
-tasks.compileJava {
-    options.release = 8
-    options.compilerArgs.add("-Werror")
+configurations.api {
+    withDependencies { clear() } // remove gradleApi() dependency
 }
 
 tasks.javadoc {
     options {
         this as StandardJavadocDocletOptions
-        addStringOption("Xdoclint:all,-missing", "-Xwerror")
-        tags(
-            "goal:a:Goal:",
-            "requiresProject:a:Requires Project:",
-            "threadSafe:a:Thread Safe:"
-        )
-    }
-}
-
-@Suppress("UnstableApiUsage")
-testing.suites.named<JvmTestSuite>("test") {
-    useJUnitJupiter()
-    dependencies {
-        implementation(gradleTestKit())
-        implementation("org.assertj:assertj-core:3.27.6")
-    }
-}
-
-publishing {
-    publications.register<MavenPublication>("mavenPlugin") {
-        from(components["java"])
-        pom {
-            name = mavenPlugin.name
-            description = mavenPlugin.description
-            url = "https://github.com/gradlex-org/gradle-module-metadata-maven-plugin"
-            licenses {
-                license {
-                    name = "Apache License, Version 2.0"
-                    url = "http://www.apache.org/licenses/LICENSE-2.0.txt"
-                }
-            }
-            scm {
-                connection = "scm:git:git://github.com/gradlex-org/gradle-module-metadata-maven-plugin.git"
-                developerConnection = "scm:git:git://github.com/gradlex-org/gradle-module-metadata-maven-plugin.git"
-                url = "https://github.com/gradlex-org/gradle-module-metadata-maven-plugin"
-            }
-            developers {
-                developer {
-                    name = "Jendrik Johannes"
-                    email = "[email protected]"
-                }
-            }
-        }
+        tags("goal:a:Goal:", "requiresProject:a:Requires Project:", "threadSafe:a:Thread Safe:")
     }
 }
 
-signing {
-    if (providers.gradleProperty("sign").getOrElse("false").toBoolean()) {
-        useInMemoryPgpKeys(
-            providers.environmentVariable("SIGNING_KEY").getOrNull(),
-            providers.environmentVariable("SIGNING_PASSPHRASE").getOrNull()
-        )
-        sign(publishing.publications["mavenPlugin"])
-    }
+mavenPlugin {
+    name = "Gradle Module Metadata Maven Plugin"
+    description = "A Maven plugin to publish Gradle Module Metadata"
+    helpMojoPackage = "org.gradlex.maven.gmm"
 }
 
-nmcpAggregation {
-    centralPortal {
-        username = providers.environmentVariable("MAVEN_CENTRAL_USERNAME")
-        password = providers.environmentVariable("MAVEN_CENTRAL_PASSWORD")
-        publishingType = "AUTOMATIC" // "USER_MANAGED"
+publishingConventions {
+    mavenCentral {
+        displayName = mavenPlugin.name
+        description = mavenPlugin.description
     }
 }
-
-checkstyle {
-    configDirectory = layout.projectDirectory.dir("gradle/checkstyle")
-}
-
-tasks.checkstyleMain {
-    exclude("**/HelpMojo.java")
-}

gradle.properties

@@ -0,0 +1,2 @@
+org.gradle.caching=true
+org.gradle.configuration-cache=true

gradle/checkstyle/checkstyle.xml

@@ -1,22 +1,3 @@
-plugins {
-    id("com.gradle.develocity") version "4.2.2"
-}
+plugins { id("org.gradlex.internal-build-conventions") version "0.8" }
 
 rootProject.name = "gradle-module-metadata-maven-plugin"
-
-@Suppress("UnstableApiUsage")
-dependencyResolutionManagement {
-    repositories.mavenCentral()
-}
-
-develocity {
-    buildScan {
-        val isCi = providers.environmentVariable("CI").getOrElse("false").toBoolean()
-        if (isCi) {
-            termsOfUseUrl = "https://gradle.com/help/legal-terms-of-use"
-            termsOfUseAgree = "yes"
-        } else {
-            publishing.onlyIf { false }
-        }
-    }
-}