feat: set pom information defaults (#151)

* feat: centralize pom information

* PR remarks

Author: ndr-brt

build.gradle.kts

@@ -10,6 +10,8 @@ plugins {
 
 val group: String by project
 val annotationProcessorVersion: String by project
+val edcScmUrl: String by project
+val edcScmConnection: String by project
 
 allprojects {
     apply(plugin = "${group}.edc-build")
@@ -24,6 +26,13 @@ allprojects {
         apply(plugin = "com.gradle.plugin-publish")
     }
 
+    configure<org.eclipse.edc.plugins.edcbuild.extensions.BuildExtension> {
+        pom {
+            scmUrl.set(edcScmUrl)
+            scmConnection.set(edcScmConnection)
+        }
+    }
+
     tasks.withType<Test> {
         useJUnitPlatform()
         testLogging {

gradle.properties

@@ -1,4 +1,7 @@
 group=org.eclipse.edc
 version=0.0.1-SNAPSHOT
 
+edcScmUrl=https://github.com/eclipse-edc/GradlePlugins
+edcScmConnection=scm:git:[email protected]:eclipse-edc/GradlePlugins.git
+
 annotationProcessorVersion=0.0.1-SNAPSHOT

plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/MavenArtifactConvention.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2022 Microsoft Corporation
+ *  Copyright (c) 2022 - 2023 Microsoft Corporation
  *
  *  This program and the accompanying materials are made available under the
  *  terms of the Apache License, Version 2.0 which is available at
@@ -9,6 +9,7 @@
  *
  *  Contributors:
  *       Microsoft Corporation - initial API and implementation
+ *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
  *
  */
 
@@ -21,6 +22,7 @@
 import org.gradle.api.Project;
 import org.gradle.api.artifacts.ConfigurablePublishArtifact;
 import org.gradle.api.publish.PublishingExtension;
+import org.gradle.api.publish.maven.MavenPom;
 import org.gradle.api.publish.maven.MavenPublication;
 
 import java.nio.file.Path;
@@ -35,6 +37,9 @@
  * </ul>
  */
 class MavenArtifactConvention implements EdcConvention {
+
+    private static final String PROJECT_URL = "https://projects.eclipse.org/projects/technology.edc";
+
     @Override
     public void apply(Project target) {
         target.afterEvaluate(project -> {
@@ -44,7 +49,7 @@ public void apply(Project target) {
             pubExt.getPublications().stream()
                     .filter(p -> p instanceof MavenPublication)
                     .map(p -> (MavenPublication) p)
-                    .peek(mavenPub -> addPomInformation(pomExt, mavenPub))
+                    .peek(mavenPub -> mavenPub.pom(pom -> setPomInformation(pomExt, target, pom)))
                     .forEach(mavenPub -> addManifestArtifact(target, mavenPub));
         });
     }
@@ -68,29 +73,30 @@ private void addManifestArtifact(Project target, MavenPublication mavenPub) {
         }
     }
 
-    private void addPomInformation(MavenPomExtension pomExt, MavenPublication mavenPub) {
-        mavenPub.pom(pom -> {
-            // these properties are mandatory!
-            pom.getName().set(pomExt.getProjectName());
-            pom.getDescription().set(pomExt.getDescription());
-            pom.getUrl().set(pomExt.getProjectUrl());
+    private static void setPomInformation(MavenPomExtension pomExt, Project project, MavenPom pom) {
+        // these properties are mandatory!
+        var projectName = pomExt.getProjectName().getOrElse(project.getName());
+        var description = pomExt.getDescription().getOrElse("edc :: " + project.getName());
+        var projectUrl = pomExt.getProjectUrl().getOrElse(PROJECT_URL);
+        pom.getName().set(projectName);
+        pom.getDescription().set(description);
+        pom.getUrl().set(projectUrl);
 
-            // we'll provide a sane default for these properties
-            pom.licenses(l -> l.license(pl -> {
-                pl.getName().set(pomExt.getLicenseName().getOrElse("The Apache License, Version 2.0"));
-                pl.getUrl().set(pomExt.getLicenseUrl().getOrElse("http://www.apache.org/licenses/LICENSE-2.0.txt"));
-            }));
+        // we'll provide a sane default for these properties
+        pom.licenses(l -> l.license(pl -> {
+            pl.getName().set(pomExt.getLicenseName().getOrElse("The Apache License, Version 2.0"));
+            pl.getUrl().set(pomExt.getLicenseUrl().getOrElse("http://www.apache.org/licenses/LICENSE-2.0.txt"));
+        }));
 
-            pom.developers(d -> d.developer(md -> {
-                md.getId().set(pomExt.getDeveloperId().getOrElse("mspiekermann"));
-                md.getName().set(pomExt.getDeveloperName().getOrElse("Markus Spiekermann"));
-                md.getEmail().set(pomExt.getDeveloperEmail().getOrElse("[email protected]"));
-            }));
+        pom.developers(d -> d.developer(md -> {
+            md.getId().set(pomExt.getDeveloperId().getOrElse("mspiekermann"));
+            md.getName().set(pomExt.getDeveloperName().getOrElse("Markus Spiekermann"));
+            md.getEmail().set(pomExt.getDeveloperEmail().getOrElse("[email protected]"));
+        }));
 
-            pom.scm(scm -> {
-                scm.getUrl().set(pomExt.getScmUrl());
-                scm.getConnection().set(pomExt.getScmConnection());
-            });
+        pom.scm(scm -> {
+            scm.getUrl().set(pomExt.getScmUrl());
+            scm.getConnection().set(pomExt.getScmConnection());
         });
     }
 

plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/extensions/MavenPomExtension.java

@@ -17,7 +17,7 @@
 import org.gradle.api.provider.Property;
 
 public abstract class MavenPomExtension {
-    private String groupId = "org.eclipse.edc";
+    private final String groupId = "org.eclipse.edc";
 
     public abstract Property<String> getProjectName();
 
@@ -43,8 +43,4 @@ public String getGroupId() {
         return groupId;
     }
 
-    public void setGroupId(String groupId) {
-        this.groupId = groupId;
-    }
-
 }