Moves the Maven publish Gradle configuration into a Gradle convention…

… plugin. This splits the build logic for publication and allows different projects to determine whether they publish to Maven rather than having to track this with conditionals in the root Gradle project. (opensearch-project#4421) Signed-off-by: David Venable <[email protected]>
jcrean · Apr 16, 2024 · a5bdcf2 · a5bdcf2
1 parent a20756c
commit a5bdcf2
Show file tree

Hide file tree

Showing 12 changed files with 89 additions and 53 deletions.
diff --git a/build.gradle b/build.gradle
@@ -20,9 +20,6 @@ allprojects {
     apply plugin: 'checkstyle'
     apply plugin: 'com.diffplug.spotless'
     apply plugin: 'com.github.jk1.dependency-license-report'
-    apply plugin: 'maven-publish'
-
-    group = 'org.opensearch.dataprepper'
 
     ext {
         mavenPublicationRootFile = file("${rootProject.buildDir}/m2")
@@ -42,53 +39,10 @@ allprojects {
         }
     }
 
-    if(project.name.startsWith('data-prepper') || project.parent != null && project.parent.name.equals('data-prepper-plugins')) {
-        project.plugins.withType(JavaPlugin).configureEach {
-            java {
-                withJavadocJar()
-                withSourcesJar()
-            }
-
-            afterEvaluate {
-                project.publishing {
-                    repositories {
-                        maven {
-                            url "file://${mavenPublicationRootFile.absolutePath}"
-                        }
-                    }
-                    publications {
-                        mavenJava(MavenPublication) {
-                            from project.components.findByName("java") ?: project.components.findByName("javaLibrary")
-
-                            groupId = project.group
-                            artifactId = project.name
-                            version = project.version
-
-                            pom {
-                                name = project.name
-                                description = "Data Prepper project: ${project.name}"
-                                url = 'https://github.com/opensearch-project/data-prepper'
-                                licenses {
-                                    license {
-                                        name = 'The Apache Software License, Version 2.0'
-                                        url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
-                                        distribution = 'repo'
-                                    }
-                                }
-                                developers {
-                                    developer {
-                                        name = 'OpenSearch'
-                                        url = 'https://github.com/opensearch-project'
-                                    }
-                                }
-                                scm {
-                                    url = 'https://github.com/opensearch-project/data-prepper'
-                                }
-                            }
-                        }
-                    }
-                }
-            }
+    project.plugins.withType(JavaPlugin).configureEach {
+        java {
+            withJavadocJar()
+            withSourcesJar()
         }
     }
 
@@ -99,7 +53,6 @@ allprojects {
 
 subprojects {
     apply plugin: 'java'
-    apply plugin: 'maven-publish'
     apply plugin: 'jacoco'
 
     java {

diff --git a/buildSrc/build.gradle b/buildSrc/build.gradle
@@ -6,4 +6,5 @@
 plugins {
     id 'java-gradle-plugin'
     id 'java'
+    id 'groovy-gradle-plugin'
 }
diff --git a/buildSrc/src/main/groovy/data-prepper.publish.gradle b/buildSrc/src/main/groovy/data-prepper.publish.gradle
@@ -0,0 +1,52 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+plugins {
+    id 'maven-publish'
+}
+
+group = 'org.opensearch.dataprepper'
+
+afterEvaluate {
+    project.publishing {
+        repositories {
+            maven {
+                url "file://${mavenPublicationRootFile.absolutePath}"
+            }
+        }
+        publications {
+            mavenJava(MavenPublication) {
+                from project.components.findByName('java') ?: project.components.findByName('javaLibrary')
+
+                groupId = project.group
+                artifactId = project.name
+                version = project.version
+
+                pom {
+                    name = project.name
+                    description = "Data Prepper project: ${project.name}"
+                    url = 'https://github.com/opensearch-project/data-prepper'
+                    licenses {
+                        license {
+                            name = 'The Apache Software License, Version 2.0'
+                            url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+                            distribution = 'repo'
+                        }
+                    }
+                    developers {
+                        developer {
+                            name = 'OpenSearch'
+                            url = 'https://github.com/opensearch-project'
+                        }
+                    }
+                    scm {
+                        url = 'https://github.com/opensearch-project/data-prepper'
+                    }
+                }
+            }
+        }
+    }
+}
+
diff --git a/data-prepper-api/build.gradle b/data-prepper-api/build.gradle
@@ -3,6 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+plugins {
+    id 'data-prepper.publish'
+}
+
 dependencies {
     implementation 'io.micrometer:micrometer-core'
     implementation 'com.fasterxml.jackson.core:jackson-databind'

diff --git a/data-prepper-core/build.gradle b/data-prepper-core/build.gradle
@@ -3,6 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+plugins {
+    id 'data-prepper.publish'
+}
+
 sourceSets {
     main {
         resources {

diff --git a/data-prepper-event/build.gradle b/data-prepper-event/build.gradle
@@ -3,6 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+plugins {
+    id 'data-prepper.publish'
+}
+
 group = 'org.opensearch.dataprepper.core'
 
 dependencies {

diff --git a/data-prepper-main/build.gradle b/data-prepper-main/build.gradle
@@ -3,6 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+plugins {
+    id 'data-prepper.publish'
+}
+
 sourceSets {
     main {
         resources {

diff --git a/data-prepper-pipeline-parser/build.gradle b/data-prepper-pipeline-parser/build.gradle
@@ -3,6 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+plugins {
+    id 'data-prepper.publish'
+}
+
 group = 'org.opensearch.dataprepper.core'
 
 dependencies {

diff --git a/data-prepper-plugin-framework/build.gradle b/data-prepper-plugin-framework/build.gradle
@@ -3,6 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+plugins {
+    id 'data-prepper.publish'
+}
+
 group = 'org.opensearch.dataprepper.core'
 
 dependencies {

diff --git a/data-prepper-plugins/build.gradle b/data-prepper-plugins/build.gradle
@@ -7,10 +7,11 @@ plugins {
     id 'java-library'
 }
 
-allprojects {
+subprojects {
+    apply plugin: 'data-prepper.publish'
     group = 'org.opensearch.dataprepper.plugins'
 }
 
 dependencies {
     subprojects.forEach { api project(':data-prepper-plugins:' + it.name) }
-}
+}
diff --git a/data-prepper-test-common/build.gradle b/data-prepper-test-common/build.gradle
@@ -5,6 +5,7 @@
 
 plugins {
     id 'java'
+    id 'data-prepper.publish'
 }
 
 group = 'org.opensearch.dataprepper.test'

diff --git a/data-prepper-test-event/build.gradle b/data-prepper-test-event/build.gradle
@@ -3,6 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+plugins {
+    id 'data-prepper.publish'
+}
+
 group = 'org.opensearch.dataprepper.test'
 
 dependencies {