feat: publish maven central plugin (#358)

ndr-brt · web-flow · commit d83c9534df69 · 2025-07-30T17:28:55.000+02:00
* feat: add publishToMavenRepo plugin

* apply publishToMavenCentral only when project is meant to be published

* add task dependency

* avoid duplicated publication
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -35,9 +35,4 @@ allprojects {
         }
     }
 
-    // FIXME - workaround for https://github.com/gradle/gradle/issues/26091
-    val signingTasks = tasks.withType<Sign>()
-    tasks.withType<AbstractPublishToMaven>().configureEach {
-        mustRunAfter(signingTasks)
-    }
 }
diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts
@@ -21,8 +21,8 @@ repositories {
 
 dependencies {
 
-    implementation(libs.plugin.nexus.publish)
     implementation(libs.plugin.checksum)
+    implementation(libs.plugin.publish)
     implementation(libs.plugin.swagger)
     implementation(libs.plugin.openapi.merger) {
         constraints {
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -27,8 +27,8 @@ jetbrains-annotations = { module = "org.jetbrains:annotations", version.ref = "j
 jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "jupiter" }
 markdown-gen = { module = "net.steppschuh.markdowngenerator:markdowngenerator", version = "1.3.1.1" }
 mockito-core = { module = "org.mockito:mockito-core", version.ref = "mockito" }
+plugin-publish = { module = "com.vanniktech:gradle-maven-publish-plugin", version = "0.34.0" }
 plugin-checksum = { module = "gradle.plugin.org.gradle.crypto:checksum", version = "1.4.0" }
-plugin-nexus-publish = { module = "io.github.gradle-nexus:publish-plugin", version = "2.0.0" }
 plugin-openapi-merger = { module = "com.rameshkp:openapi-merger-gradle-plugin", version.ref = "openapi-merger" }
 plugin-openapi-merger-app = { module = "com.rameshkp:openapi-merger-app", version.ref = "openapi-merger" }
 plugin-swagger = { module = "io.swagger.core.v3:swagger-gradle-plugin", version.ref = "swagger" }
diff --git a/plugins/edc-build/build.gradle.kts b/plugins/edc-build/build.gradle.kts
@@ -10,8 +10,8 @@ repositories {
 }
 
 dependencies {
-    implementation(libs.plugin.nexus.publish)
     implementation(libs.plugin.checksum)
+    implementation(libs.plugin.publish)
     implementation(libs.plugin.swagger)
     implementation(libs.plugin.openapi.merger.app)
     implementation(libs.plugin.openapi.merger) {
diff --git a/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/EdcBuildBasePlugin.java b/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/EdcBuildBasePlugin.java
@@ -14,7 +14,6 @@
 
 package org.eclipse.edc.plugins.edcbuild;
 
-import io.github.gradlenexus.publishplugin.NexusPublishPlugin;
 import org.eclipse.edc.plugins.edcbuild.plugins.ModuleNamesPlugin;
 import org.eclipse.edc.plugins.edcbuild.plugins.OpenApiMergerPlugin;
 import org.eclipse.edc.plugins.edcbuild.plugins.TestSummaryPlugin;
@@ -32,26 +31,22 @@
  * @see <a href="https://docs.gradle.org/current/userguide/designing_gradle_plugins.html">Gradle Documentation</a>
  */
 public class EdcBuildBasePlugin implements Plugin<Project> {
-    private static void defineCapabilities(Project target) {
 
-        target.getPlugins().apply(JavaLibraryPlugin.class);
-        target.getPlugins().apply(CheckstylePlugin.class);
-        target.getPlugins().apply(MavenPublishPlugin.class);
-        target.getPlugins().apply(JavaPlugin.class);
-        target.getPlugins().apply(TestSummaryPlugin.class);
+    @Override
+    public void apply(Project target) {
+        var plugins = target.getPlugins();
+
+        plugins.apply(CheckstylePlugin.class);
+        plugins.apply(JavaLibraryPlugin.class);
+        plugins.apply(JavaPlugin.class);
+        plugins.apply(MavenPublishPlugin.class);
+        plugins.apply(TestSummaryPlugin.class);
 
-        // The nexus publish plugin MUST be applied to the root project only, it'll throw an exception otherwise
         if (target == target.getRootProject()) {
-            target.getPlugins().apply(ChecksumPlugin.class);
-            target.getPlugins().apply(NexusPublishPlugin.class);
-            target.getPlugins().apply(OpenApiMergerPlugin.class);
-            target.getPlugins().apply(ModuleNamesPlugin.class);
+            plugins.apply(ChecksumPlugin.class);
+            plugins.apply(OpenApiMergerPlugin.class);
+            plugins.apply(ModuleNamesPlugin.class);
         }
     }
 
-    @Override
-    public void apply(Project target) {
-        defineCapabilities(target);
-    }
-
 }
diff --git a/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/EdcBuildPlugin.java b/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/EdcBuildPlugin.java
@@ -18,6 +18,8 @@
 import org.eclipse.edc.plugins.edcbuild.extensions.BuildExtension;
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
+import org.gradle.api.publish.maven.tasks.AbstractPublishToMaven;
+import org.gradle.plugins.signing.Sign;
 
 import static java.util.List.of;
 import static org.eclipse.edc.plugins.edcbuild.conventions.Conventions.allDependencies;
@@ -28,7 +30,6 @@
 import static org.eclipse.edc.plugins.edcbuild.conventions.Conventions.mavenPom;
 import static org.eclipse.edc.plugins.edcbuild.conventions.Conventions.mavenPublication;
 import static org.eclipse.edc.plugins.edcbuild.conventions.Conventions.mavenPublishing;
-import static org.eclipse.edc.plugins.edcbuild.conventions.Conventions.nexusPublishing;
 import static org.eclipse.edc.plugins.edcbuild.conventions.Conventions.printClasspath;
 import static org.eclipse.edc.plugins.edcbuild.conventions.Conventions.repositories;
 import static org.eclipse.edc.plugins.edcbuild.conventions.Conventions.rootBuildScript;
@@ -49,8 +50,10 @@ public void apply(Project target) {
         // apply all plugins
         target.getPlugins().apply(EdcBuildBasePlugin.class);
 
-        //this one must run in the configuration phase
-        nexusPublishing().apply(target);
+        target.getTasks().withType(AbstractPublishToMaven.class).configureEach(task -> {
+            var signTasks = target.getTasks().withType(Sign.class);
+            task.mustRunAfter(signTasks);
+        });
 
         // configuration values are only guaranteed to be set after the project has been evaluated
         // https://docs.gradle.org/current/userguide/build_lifecycle.html
diff --git a/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/Conventions.java b/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/Conventions.java
@@ -59,10 +59,6 @@ public static EdcConvention jar() {
         return new JarConvention();
     }
 
-    public static EdcConvention nexusPublishing() {
-        return new NexusPublishingConvention();
-    }
-
     public static EdcConvention rootBuildScript() {
         return new RootBuildScriptConvention();
     }
diff --git a/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/JavaConvention.java b/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/JavaConvention.java
@@ -47,11 +47,6 @@ public void apply(Project target) {
             options.setFork(true);
             options.setIncremental(true);
         });
-
-
-        // needed for publishing to maven central
-        javaPluginExt.withJavadocJar();
-        javaPluginExt.withSourcesJar();
     }
 
 }
diff --git a/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/MavenArtifactConvention.java b/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/MavenArtifactConvention.java
@@ -43,7 +43,8 @@ class MavenArtifactConvention implements EdcConvention {
     public void apply(Project target) {
         target.afterEvaluate(project -> {
             var pubExt = requireExtension(project, PublishingExtension.class);
-            var pomExt = requireExtension(project, BuildExtension.class).getPom();
+            var buildExtension = requireExtension(project, BuildExtension.class);
+            var pomExt = buildExtension.getPom();
 
             pubExt.getPublications().stream()
                     .filter(p -> p instanceof MavenPublication)
diff --git a/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/MavenPublicationConvention.java b/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/MavenPublicationConvention.java
@@ -14,53 +14,37 @@
 
 package org.eclipse.edc.plugins.edcbuild.conventions;
 
+import com.vanniktech.maven.publish.MavenPublishBaseExtension;
+import com.vanniktech.maven.publish.MavenPublishPlugin;
 import org.eclipse.edc.plugins.edcbuild.extensions.BuildExtension;
 import org.gradle.api.Project;
-import org.gradle.api.publish.PublishingExtension;
-import org.gradle.api.publish.maven.MavenPublication;
 
 import static org.eclipse.edc.plugins.edcbuild.conventions.ConventionFunctions.requireExtension;
 
-/**
- * Adds a Maven publication to a project.
- */
 public class MavenPublicationConvention implements EdcConvention {
 
-    /**
-     * Default setting for publication of a project.
-     */
     private static final boolean DEFAULT_SHOULD_PUBLISH = true;
 
-    /**
-     * Checks whether publishing is explicitly set to false for the target project and, if it is
-     * not, adds a Maven publication to the project, if none exists. This only applies for
-     * sub-projects that contain a build.gradle.kts file.
-     *
-     * @param target The project to which the convention applies
-     */
     @Override
     public void apply(Project target) {
         // do not publish the root project or modules without a build.gradle.kts
         if (target.getRootProject() == target || !target.file("build.gradle.kts").exists()) {
             return;
         }
 
-        var buildExt = requireExtension(target, BuildExtension.class);
-        var shouldPublish = buildExt.getPublish().getOrElse(DEFAULT_SHOULD_PUBLISH);
+        var buildExtension = requireExtension(target, BuildExtension.class);
+        var shouldPublish = buildExtension.getPublish().getOrElse(DEFAULT_SHOULD_PUBLISH);
 
         if (shouldPublish) {
-            var pe = requireExtension(target, PublishingExtension.class);
+            target.getPlugins().apply(MavenPublishPlugin.class);
+
+            target.getExtensions().configure(MavenPublishBaseExtension.class, extension -> {
+                extension.publishToMavenCentral(true);
 
-            if (pe.getPublications().findByName(target.getName()) == null) {
-                pe.publications(publications -> publications.create(target.getName(), MavenPublication.class,
-                        mavenPublication -> {
-                            mavenPublication.from(target.getComponents().getByName("java"));
-                            mavenPublication.setGroupId(buildExt.getPom().getGroupId());
-                            mavenPublication.suppressPomMetadataWarningsFor("testFixturesApiElements");
-                            mavenPublication.suppressPomMetadataWarningsFor("testFixturesRuntimeElements");
-                        }));
-            }
+                extension.signAllPublications();
+            });
         }
+
     }
 
 }
diff --git a/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/NexusPublishingConvention.java b/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/NexusPublishingConvention.java
diff --git a/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/extensions/MavenPomExtension.java b/plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/extensions/MavenPomExtension.java
@@ -39,10 +39,12 @@ public abstract class MavenPomExtension {
 
     public abstract Property<String> getScmUrl();
 
+    @Deprecated(since = "edc-build-0.1.0")
     public String getGroupId() {
         return groupId;
     }
 
+    @Deprecated(since = "edc-build-0.1.0")
     public void setGroupId(String groupId) {
         this.groupId = groupId;
     }

Original file line number	Diff line number	Diff line change
`@@ -35,9 +35,4 @@ allprojects {`
`35`	`35`	`}`
`36`	`36`	`}`
`37`	`37`
`38`		`- // FIXME - workaround for https://github.com/gradle/gradle/issues/26091`
`39`		`- val signingTasks = tasks.withType<Sign>()`
`40`		`- tasks.withType<AbstractPublishToMaven>().configureEach {`
`41`		`- mustRunAfter(signingTasks)`
`42`		`- }`
`43`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,8 @@ repositories {`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`dependencies {`
`13`		`- implementation(libs.plugin.nexus.publish)`
`14`	`13`	`implementation(libs.plugin.checksum)`
	`14`	`+ implementation(libs.plugin.publish)`
`15`	`15`	`implementation(libs.plugin.swagger)`
`16`	`16`	`implementation(libs.plugin.openapi.merger.app)`
`17`	`17`	`implementation(libs.plugin.openapi.merger) {`
Original file line number	Diff line number	Diff line change
`@@ -59,10 +59,6 @@ public static EdcConvention jar() {`
`59`	`59`	`return new JarConvention();`
`60`	`60`	`}`
`61`	`61`
`62`		`- public static EdcConvention nexusPublishing() {`
`63`		`- return new NexusPublishingConvention();`
`64`		`- }`
`65`		`-`
`66`	`62`	`public static EdcConvention rootBuildScript() {`
`67`	`63`	`return new RootBuildScriptConvention();`
`68`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,11 +47,6 @@ public void apply(Project target) {`
`47`	`47`	`options.setFork(true);`
`48`	`48`	`options.setIncremental(true);`
`49`	`49`	`});`
`50`		`-`
`51`		`-`
`52`		`- // needed for publishing to maven central`
`53`		`- javaPluginExt.withJavadocJar();`
`54`		`- javaPluginExt.withSourcesJar();`
`55`	`50`	`}`
`56`	`51`
`57`	`52`	`}`