Publish plugins

Publishing is only an additional configuration of the plugins build. Hence it is the same setup for all approaches. You can publish: - To your own repository. Then you only need the id("maven-publish") plugin and configure your repository - To the Gradle Plugin Portal. Then you additionally need the id("com.gradle.plugin-publish") plugin and configure additional metadata that will be shown on the plugin portal website.
jjohannes · Jul 19, 2022 · 3293cdd · 3293cdd
1 parent 39baa4d
commit 3293cdd
Show file tree

Hide file tree

Showing 7 changed files with 77 additions and 0 deletions.
diff --git a/clojure/gradle-build-logic/java-plugins/build.gradle.kts b/clojure/gradle-build-logic/java-plugins/build.gradle.kts
@@ -1,6 +1,8 @@
 plugins {
     id("java-gradle-plugin")
     id("dev.clojurephant.clojure") version "0.6.0"
+    id("maven-publish") // if you never publish the plugin, you may remove this (but it also does not hurt)
+    id("com.gradle.plugin-publish") version "1.0.0" // if you do not publish to the Gradle Plugin Portal, you may remove this (but it also does not hurt)
 }
 
 // clojurephant plugin specifics
@@ -30,3 +32,12 @@ dependencies {
         because("Provides the 'com.diffplug.spotless' formatting plugin")
     }
 }
+
+// if you do not publish, the following is optional
+version = "1.0"
+publishing.repositories.maven("../../../_gradle-plugins-repository") // own repository to publish to (if needed) - run ':publish' task
+pluginBundle { // Plugin Portal Metadata (only needed if you publish to Gradle Plugin Portal) - run ':publishPlugins' task
+    website = "https://github.com/jjohannes/gradle-plugins-howto"
+    vcsUrl = "https://github.com/jjohannes/gradle-plugins-howto.git"
+    tags = listOf("example")
+}
diff --git a/groovy-dsl/gradle-build-logic/java-plugins/build.gradle.kts b/groovy-dsl/gradle-build-logic/java-plugins/build.gradle.kts
@@ -1,5 +1,7 @@
 plugins {
     id("groovy-gradle-plugin")
+    id("maven-publish") // if you never publish the plugin, you may remove this (but it also does not hurt)
+    id("com.gradle.plugin-publish") version "1.0.0" // if you do not publish to the Gradle Plugin Portal, you may remove this (but it also does not hurt)
 }
 
 group = "software.onepiece.gradle.pluginshowto"
@@ -11,3 +13,12 @@ dependencies {
         because("Provides the 'com.diffplug.spotless' formatting plugin")
     }
 }
+
+// if you do not publish, the following is optional
+version = "1.0"
+publishing.repositories.maven("../../../_gradle-plugins-repository") // own repository to publish to (if needed) - run ':publish' task
+pluginBundle { // Plugin Portal Metadata (only needed if you publish to Gradle Plugin Portal) - run ':publishPlugins' task
+    website = "https://github.com/jjohannes/gradle-plugins-howto"
+    vcsUrl = "https://github.com/jjohannes/gradle-plugins-howto.git"
+    tags = listOf("example")
+}
diff --git a/groovy/gradle-build-logic/java-plugins/build.gradle.kts b/groovy/gradle-build-logic/java-plugins/build.gradle.kts
@@ -1,6 +1,8 @@
 plugins {
     id("java-gradle-plugin")
     id("groovy")
+    id("maven-publish") // if you never publish the plugin, you may remove this (but it also does not hurt)
+    id("com.gradle.plugin-publish") version "1.0.0" // if you do not publish to the Gradle Plugin Portal, you may remove this (but it also does not hurt)
 }
 
 group = "software.onepiece.gradle.pluginshowto"
@@ -26,3 +28,12 @@ dependencies {
         because("Provides the 'com.diffplug.spotless' formatting plugin")
     }
 }
+
+// if you do not publish, the following is optional
+version = "1.0"
+publishing.repositories.maven("../../../_gradle-plugins-repository") // own repository to publish to (if needed) - run ':publish' task
+pluginBundle { // Plugin Portal Metadata (only needed if you publish to Gradle Plugin Portal) - run ':publishPlugins' task
+    website = "https://github.com/jjohannes/gradle-plugins-howto"
+    vcsUrl = "https://github.com/jjohannes/gradle-plugins-howto.git"
+    tags = listOf("example")
+}
diff --git a/java/gradle-build-logic/java-plugins/build.gradle.kts b/java/gradle-build-logic/java-plugins/build.gradle.kts
@@ -1,5 +1,7 @@
 plugins {
     id("java-gradle-plugin")
+    id("maven-publish") // if you never publish the plugin, you may remove this (but it also does not hurt)
+    id("com.gradle.plugin-publish") version "1.0.0" // if you do not publish to the Gradle Plugin Portal, you may remove this (but it also does not hurt)
 }
 
 group = "software.onepiece.gradle.pluginshowto"
@@ -25,3 +27,12 @@ dependencies {
         because("Provides the 'com.diffplug.spotless' formatting plugin")
     }
 }
+
+// if you do not publish, the following is optional
+version = "1.0"
+publishing.repositories.maven("../../../_gradle-plugins-repository") // own repository to publish to (if needed) - run ':publish' task
+pluginBundle { // Plugin Portal Metadata (only needed if you publish to Gradle Plugin Portal) - run ':publishPlugins' task
+    website = "https://github.com/jjohannes/gradle-plugins-howto"
+    vcsUrl = "https://github.com/jjohannes/gradle-plugins-howto.git"
+    tags = listOf("example")
+}
diff --git a/kotlin-dsl/gradle-build-logic/java-plugins/build.gradle.kts b/kotlin-dsl/gradle-build-logic/java-plugins/build.gradle.kts
@@ -1,5 +1,7 @@
 plugins {
     `kotlin-dsl`
+    id("maven-publish") // if you never publish the plugin, you may remove this (but it also does not hurt)
+    id("com.gradle.plugin-publish") version "1.0.0" // if you do not publish to the Gradle Plugin Portal, you may remove this (but it also does not hurt)
 }
 
 group = "software.onepiece.gradle.pluginshowto"
@@ -11,3 +13,12 @@ dependencies {
         because("Provides the 'com.diffplug.spotless' formatting plugin")
     }
 }
+
+// if you do not publish, the following is optional
+version = "1.0"
+publishing.repositories.maven("../../../_gradle-plugins-repository") // own repository to publish to (if needed) - run ':publish' task
+pluginBundle { // Plugin Portal Metadata (only needed if you publish to Gradle Plugin Portal) - run ':publishPlugins' task
+    website = "https://github.com/jjohannes/gradle-plugins-howto"
+    vcsUrl = "https://github.com/jjohannes/gradle-plugins-howto.git"
+    tags = listOf("example")
+}
diff --git a/kotlin/gradle-build-logic/java-plugins/build.gradle.kts b/kotlin/gradle-build-logic/java-plugins/build.gradle.kts
@@ -1,6 +1,8 @@
 plugins {
     id("java-gradle-plugin")
     id("org.jetbrains.kotlin.jvm") version "1.5.21" // caveat: version should match version embedded in Gradle version you are using
+    id("maven-publish") // if you never publish the plugin, you may remove this (but it also does not hurt)
+    id("com.gradle.plugin-publish") version "1.0.0" // if you do not publish to the Gradle Plugin Portal, you may remove this (but it also does not hurt)
 }
 
 group = "software.onepiece.gradle.pluginshowto"
@@ -26,3 +28,12 @@ dependencies {
         because("Provides the 'com.diffplug.spotless' formatting plugin")
     }
 }
+
+// if you do not publish, the following is optional
+version = "1.0"
+publishing.repositories.maven("../../../_gradle-plugins-repository") // own repository to publish to (if needed) - run ':publish' task
+pluginBundle { // Plugin Portal Metadata (only needed if you publish to Gradle Plugin Portal) - run ':publishPlugins' task
+    website = "https://github.com/jjohannes/gradle-plugins-howto"
+    vcsUrl = "https://github.com/jjohannes/gradle-plugins-howto.git"
+    tags = listOf("example")
+}
diff --git a/scala/gradle-build-logic/java-plugins/build.gradle.kts b/scala/gradle-build-logic/java-plugins/build.gradle.kts
@@ -1,6 +1,8 @@
 plugins {
     id("java-gradle-plugin")
     id("scala")
+    id("maven-publish") // if you never publish the plugin, you may remove this (but it also does not hurt)
+    id("com.gradle.plugin-publish") version "1.0.0" // if you do not publish to the Gradle Plugin Portal, you may remove this (but it also does not hurt)
 }
 
 dependencies { implementation("org.scala-lang:scala-library:2.13.6") }
@@ -28,3 +30,12 @@ dependencies {
         because("Provides the 'com.diffplug.spotless' formatting plugin")
     }
 }
+
+// if you do not publish, the following is optional
+version = "1.0"
+publishing.repositories.maven("../../../_gradle-plugins-repository") // own repository to publish to (if needed) - run ':publish' task
+pluginBundle { // Plugin Portal Metadata (only needed if you publish to Gradle Plugin Portal) - run ':publishPlugins' task
+    website = "https://github.com/jjohannes/gradle-plugins-howto"
+    vcsUrl = "https://github.com/jjohannes/gradle-plugins-howto.git"
+    tags = listOf("example")
+}