chore: major refactor to Maven publishing plugin

sureshg · sureshg · commit 6e068ae99cbf · 2025-04-26T19:14:04.000-07:00
diff --git a/gradle/build-logic/src/main/kotlin/settings.repo.settings.gradle.kts b/gradle/build-logic/src/main/kotlin/settings.repo.settings.gradle.kts
@@ -5,7 +5,7 @@ import org.gradle.toolchains.foojay.FoojayToolchainResolver
 import org.tomlj.Toml
 
 val versionCatalog by lazy {
-  // A hack to read version catalog from settings
+  // A hack to read version-catalog from settings
   runCatching {
         Toml.parse(file("$rootDir/gradle/libs.versions.toml").readText()).getTable("versions")
       }
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -218,7 +218,7 @@ swagger-style                  = "https://unpkg.com/swagger-ui-themes@3.0.1/them
 benmanes                       = "0.52.0"
 foojay-resolver                = "0.10.0"
 gradle-develocity              = "4.0.1"
-nmcp                           = "0.1.1"
+nmcp                           = "0.1.2"
 nexus-publish                  = "2.0.0"
 vanniktech-publish             = "0.31.0"
 gradle-publish                 = "1.3.1"
@@ -714,7 +714,8 @@ sigstore                             = { id = "dev.sigstore.sign"
 sigstore-base                        = { id = "dev.sigstore.sign-base"                                         , version.ref = "sigstore" }
 buildkonfig                          = { id = "com.codingfeline.buildkonfig"                                   , version.ref = "buildkonfig"}
 detekt                               = { id = "io.github.detekt.gradle.compiler-plugin"                        , version.ref = "detekt"}
-nmcp                                 = { id = "com.gradleup.nmcp"                                              , version.ref = "nmcp"}
+nmcp-project                         = { id = "com.gradleup.nmcp"                                              , version.ref = "nmcp"}
+nmcp-aggregation                     = { id = "com.gradleup.nmcp.aggregation"                                  , version.ref = "nmcp"}
 vanniktech-publish                   = { id = "com.vanniktech.maven.publish"                                   , version.ref = "vanniktech-publish" }
 gradle-publish                       = { id = "com.gradle.plugin-publish"                                      , version.ref = "gradle-publish" }
 kobweb-application                   = { id = "com.varabyte.kobweb.application"                                , version.ref = "kobweb" }
diff --git a/plugins/project/build.gradle.kts b/plugins/project/build.gradle.kts
@@ -99,7 +99,6 @@ dependencies {
   implementation(libs.plugins.jetbrains.dokka.dep)
   implementation(libs.plugins.graalvm.nativeimage.dep)
   implementation(libs.plugins.redacted.dep)
-  implementation(libs.plugins.nmcp.dep)
   implementation(libs.plugins.spotless.dep)
   implementation(libs.plugins.shadow.dep)
   implementation(libs.plugins.mrjar.dep)
@@ -111,8 +110,9 @@ dependencies {
   implementation(libs.plugins.jib.dep)
   implementation(libs.plugins.modulegraph.dep)
   implementation(libs.plugins.kopy.dep)
-  implementation(libs.jib.nativeimage.extn)
   implementation(libs.plugins.github.changelog.dep)
+  implementation(libs.plugins.vanniktech.publish.dep)
+  implementation(libs.jib.nativeimage.extn)
   implementation(libs.kmpmt)
   implementation(files(libs.javaClass.superclass.protectionDomain.codeSource.location))
   // implementation(libs.plugins.nexus.publish.dep)
diff --git a/plugins/project/src/main/kotlin/common/ProjectExtns.kt b/plugins/project/src/main/kotlin/common/ProjectExtns.kt
@@ -85,6 +85,18 @@ val Project.isNativeTargetEnabled: Boolean
 val Project.isWinTargetEnabled: Boolean
   get() = gradleBooleanProp("kotlin.target.win.enabled").get()
 
+val Project.isComposeModuleEnabled: Boolean
+  get() = gradleBooleanProp("module.compose.enabled").get()
+
+val Project.isBootModuleEnabled: Boolean
+  get() = gradleBooleanProp("module.boot.enabled").get()
+
+val Project.isMvnSnapshotRepoEnabled: Boolean
+  get() = gradleBooleanProp("maven.snapshot.repo.enabled").get()
+
+val Project.isAutomaticModuleEnabled
+  get() = gradleBooleanProp("java.automatic.module.enabled").get()
+
 /** Java version properties. */
 val Project.javaVersion
   get() = libs.versions.java.asProvider().map { JavaVersion.toVersion(it) }
@@ -101,9 +113,6 @@ val Project.toolchainVendor
 val Project.addModules
   get() = libs.versions.java.addModules.get()
 
-val Project.isAutomaticModuleEnabled
-  get() = gradleBooleanProp("java.automatic.module.enabled").get()
-
 val Project.defaultJarManifest
   get() = buildMap {
     put("Enable-Native-Access", "ALL-UNNAMED")
diff --git a/plugins/project/src/main/kotlin/dev.suresh.plugin.publishing.gradle.kts b/plugins/project/src/main/kotlin/dev.suresh.plugin.publishing.gradle.kts
@@ -1,13 +1,10 @@
 import com.google.cloud.tools.jib.gradle.JibExtension
+import com.vanniktech.maven.publish.SonatypeHost
 import common.*
 import java.time.Year
 import org.jetbrains.kotlin.gradle.tasks.KotlinNativeLink
 
-plugins {
-  `maven-publish`
-  signing
-  com.gradleup.nmcp
-}
+plugins { com.vanniktech.maven.publish }
 
 group = libs.versions.group.get()
 
@@ -31,99 +28,55 @@ publishing {
   publications {
     // Kotlin Multiplatform
     pluginManager.withPlugin("org.jetbrains.kotlin.multiplatform") {
-      val javadocJar by
-          tasks.registering(Jar::class) {
-            archiveClassifier = "javadoc"
-            duplicatesStrategy = DuplicatesStrategy.WARN
-            // Contents are deliberately left empty
-            // from(tasks.named("dokkaJavadoc"))
-          }
-
-      // KMP will automatically create the publications
-      withType<MavenPublication>().configureEach {
-        artifact(javadocJar)
-        configurePom()
-      }
+      // withType<MavenPublication>().configureEach { artifact(taskName..) }
     }
 
     // Kotlin JVM ("org.jetbrains.kotlin.jvm")
     pluginManager.withPlugin("java") {
-      register<MavenPublication>("maven") {
-        from(components["java"])
-        configurePom()
-      }
+      register<MavenPublication>("maven") { from(components["java"]) }
 
-      // Add an executable artifact if exists
       withType<MavenPublication>().configureEach {
         // configurations.findByName("customFile")?.artifacts?.forEach { artifact(it) }
 
+        // Add an executable artifact if exists
         // val execJar = tasks.findByName("buildExecutable") as? ReallyExecJar
-        // if (execJar != null) {
-        //   artifact(execJar.execJarFile)
-        // }
+        // if (execJar != null) { artifact(execJar.execJarFile) }
       }
     }
 
     // Java Platform (BOM)
     pluginManager.withPlugin("java-platform") {
-      register<MavenPublication>("maven") {
-        from(components["javaPlatform"])
-        configurePom()
-      }
+      register<MavenPublication>("maven") { from(components["javaPlatform"]) }
     }
 
     // Gradle version catalog
     pluginManager.withPlugin("version-catalog") {
-      register<MavenPublication>("maven") {
-        from(components["versionCatalog"])
-        configurePom()
-      }
+      register<MavenPublication>("maven") { from(components["versionCatalog"]) }
     }
 
-    // Add Dokka html doc to all publications
-    pluginManager.withPlugin("org.jetbrains.dokka") {
-      val dokkaGenerateJar by
-          tasks.registering(Jar::class) {
-            from(tasks.named("dokkaGenerate"))
-            archiveClassifier = "html-docs"
+    // Configures GHCR credentials for Jib
+    pluginManager.withPlugin("com.google.cloud.tools.jib") {
+      configure<JibExtension> {
+        to {
+          if (image.orEmpty().startsWith("ghcr.io", ignoreCase = true)) {
+            auth {
+              username = githubPackagesUsername.orNull
+              password = githubPackagesPassword.orNull
+            }
           }
-
-      withType<MavenPublication>().configureEach { artifact(dokkaGenerateJar) }
-    }
-  }
-}
-
-// Configures GHCR credentials for Jib
-pluginManager.withPlugin("com.google.cloud.tools.jib") {
-  configure<JibExtension> {
-    to {
-      if (image.orEmpty().startsWith("ghcr.io", ignoreCase = true)) {
-        auth {
-          username = githubPackagesUsername.orNull
-          password = githubPackagesPassword.orNull
         }
       }
     }
   }
 }
 
-signing {
-  setRequired { hasSigningKey }
-  if (hasSigningKey) {
-    useInMemoryPgpKeys(
-        signingInMemoryKeyId.orNull, signingInMemoryKey.orNull, signingInMemoryKeyPassword.orNull)
-    sign(publishing.publications)
-  }
-}
+mavenPublishing {
+  publishToMavenCentral(host = SonatypeHost.CENTRAL_PORTAL, automaticRelease = true)
 
-nmcp {
-  centralPortal {
-    username = mavenCentralUsername
-    password = mavenCentralPassword
+  if (hasSigningKey) {
+    signAllPublications()
   }
-}
 
-fun MavenPublication.configurePom() {
   pom {
     name = provider { "${project.group}:${project.name}" }
     description = provider { project.description }
diff --git a/plugins/settings/src/main/kotlin/common/SettingsExtns.kt b/plugins/settings/src/main/kotlin/common/SettingsExtns.kt
@@ -12,8 +12,14 @@ val Settings.isNativeTargetEnabled: Boolean
 val Settings.isWinTargetEnabled: Boolean
   get() = gradleBooleanProp("kotlin.target.win.enabled").get()
 
-val Settings.isComposeEnabled: Boolean
-  get() = gradleBooleanProp("compose.enabled").get()
+val Settings.isComposeModuleEnabled: Boolean
+  get() = gradleBooleanProp("module.compose.enabled").get()
 
-val Settings.isSpringBootEnabled: Boolean
-  get() = gradleBooleanProp("springboot.enabled").get()
+val Settings.isBootModuleEnabled: Boolean
+  get() = gradleBooleanProp("module.boot.enabled").get()
+
+val Settings.isMvnSnapshotRepoEnabled: Boolean
+  get() = gradleBooleanProp("maven.snapshot.repo.enabled").get()
+
+val Settings.isAutomaticModuleEnabled: Boolean
+  get() = gradleBooleanProp("java.automatic.module.enabled").get()

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import org.gradle.toolchains.foojay.FoojayToolchainResolver`
`5`	`5`	`import org.tomlj.Toml`
`6`	`6`
`7`	`7`	`val versionCatalog by lazy {`
`8`		`- // A hack to read version catalog from settings`
	`8`	`+ // A hack to read version-catalog from settings`
`9`	`9`	`runCatching {`
`10`	`10`	`Toml.parse(file("$rootDir/gradle/libs.versions.toml").readText()).getTable("versions")`
`11`	`11`	`}`