Merge pull request #3 from build-extensions-oss/publish-to-maven

Publish to maven

Author: imanushin

.gitignore

@@ -5,3 +5,4 @@ build/
 # IntelliJ IDEA
 .idea/
 *.iml
+.run/

README.md

@@ -1,4 +1,30 @@
 This is the fork of [unbroken-dome/gradle-plugin-utils](https://github.com/unbroken-dome/gradle-plugin-utils) to support
 newer Gradle.
 
-The project has extensions to simplify Gradle plugins build and test.
+The project has extensions to simplify Gradle plugins build and test.
+
+# Publishing
+
+In short - publishing doesn't work well, because of breaking changes in Maven Central, plus Gradle Plugins incompatibilities.
+
+At the time of writing Javadoc isn't published properly.
+
+To run publishing tasks, the following needs to be done:
+
+1. File `~/.gradle/gradle.properties` needs to be updated to:
+```properties
+mavenCentralUsername=???
+mavenCentralPassword=???
+```
+1. And then the following task will work: `./gradlew publishToMavenCentral --stacktrace`
+
+## Signing
+
+Add lines like below into ~/.gradle/gradle.properties:
+```properties
+signing.keyId=F27AB2F4
+signing.password=
+# can be exported via gpg --export-secret-keys -o xxx.gpg
+# see https://stackoverflow.com/a/39573795/185498
+signing.secretKeyRingFile=xxx.gpg
+```

build.gradle.kts

@@ -1,13 +1,11 @@
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
-import java.net.URI
 
 plugins {
+    signing
     kotlin("jvm") apply false
-    id("org.jetbrains.dokka") apply false
-    id("io.github.gradle-nexus.publish-plugin") version "1.3.0"
+    alias(libs.plugins.com.vanniktech.maven.publish) apply false
 }
 
-
 subprojects {
 
     plugins.withId("org.jetbrains.kotlin.jvm") {
@@ -22,34 +20,29 @@ subprojects {
         }
     }
 
-
     plugins.withType<JavaPlugin> {
 
         configure<JavaPluginExtension> {
             withSourcesJar()
-            withJavadocJar()
+            // We don't publish Javadoc, because it is useless in out case. We publish sources, plus it is easy to find
+            // GitHub project and read the source code. We don't have any comprehensive documentation, so let's just publish nothing.
+            // Additionally, JavaDoc task conflicts with publishing plugin, so let's simply delete one of them.
+            // withJavadocJar()
         }
 
         tasks.withType<Test> {
             useJUnitPlatform()
+            // store all temporary results inside the Gradle folder
             systemProperty("java.io.tmpdir", layout.buildDirectory.dir("tmp"))
         }
 
         plugins.withType<MavenPublishPlugin> {
-
-            with(the<PublishingExtension>()) {
-                publications.create<MavenPublication>("mavenJava") {
-                    from(components["java"])
-                }
-            }
+            plugins.apply(com.vanniktech.maven.publish.MavenPublishPlugin::class)
         }
     }
 
 
     plugins.withType<MavenPublishPlugin> {
-
-        plugins.apply(SigningPlugin::class)
-
         val publishing = the<PublishingExtension>()
 
         publishing.publications.withType<MavenPublication> {
@@ -91,43 +84,6 @@ subprojects {
                 url = file(layout.buildDirectory.dir("repos/releases")).toURI()
             }
         }
-
-        with(the<SigningExtension>()) {
-            sign(publishing.publications)
-        }
-    }
-
-
-    plugins.withId("org.jetbrains.dokka") {
-
-        val dokkaVersion: String by extra
-
-        dependencies {
-            "dokkaJavadocPlugin"("org.jetbrains.dokka:kotlin-as-java-plugin:$dokkaVersion")
-        }
-
-        tasks.withType<Jar>().matching { it.name == "javadocJar" }
-            .configureEach {
-                from(tasks.named("dokkaJavadoc"))
-            }
-
-        tasks.withType<org.jetbrains.dokka.gradle.DokkaTask> {
-            dependsOn("classes")
-            dokkaSourceSets {
-                named("main") {
-                    sourceLink {
-                        val githubUrl = project.extra["github.url"] as String
-                        localDirectory.set(project.file("src/main/kotlin"))
-                        remoteUrl.set(URI("$githubUrl/tree/master/").toURL())
-                        remoteLineSuffix.set("#L")
-                    }
-                }
-            }
-        }
     }
 }
 
-
-nexusPublishing.repositories {
-    sonatype()
-}

gradle-plugin-integration-test-utils/build.gradle.kts

@@ -2,7 +2,6 @@ plugins {
     kotlin("jvm")
     `java-library`
     `maven-publish`
-    id("org.jetbrains.dokka")
 }
 
 

gradle-plugin-test-utils/build.gradle.kts

@@ -2,7 +2,6 @@ plugins {
     kotlin("jvm")
     `java-library`
     `maven-publish`
-    id("org.jetbrains.dokka")
 }
 
 

gradle-plugin-utils/build.gradle.kts

@@ -2,7 +2,6 @@ plugins {
     kotlin("jvm")
     `java-library`
     `maven-publish`
-    id("org.jetbrains.dokka")
 }
 
 

gradle.properties

@@ -1,14 +1,17 @@
 kotlin.code.style=official
 
-group=io.github.gradle-cloud.gradle-plugin-utils
+group=io.github.build-extensions-oss
 version=0.5.0
 
 projectName=Gradle Plugin Utilities
 projectDescription=A collection of utilities for developing Gradle plugins
-projectUrl=https://github.com/Gradle-Cloud/gradle-plugin-utils/
+projectUrl=https://github.com/build-extensions-oss/gradle-plugin-utils/
 projectLicenseName=The MIT License (MIT)
 projectLicenseUrl=https://mit-license.org
 
-githubRepo=Gradle-Cloud/gradle-plugin-utils
+githubRepo=build-extensions-oss/gradle-plugin-utils
 
-dokkaVersion=1.8.20
+# Enable publication tasks by default
+mavenCentralPublishing=true
+# Sign everything by default - otherwise Maven Central will reject us
+signAllPublications=true

gradle/libs.versions.toml

@@ -20,3 +20,6 @@ mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
 reflections = { module = "org.reflections:reflections", version.ref = "reflections" }
 
 spek-dsl = { module = "org.spekframework.spek2:spek-dsl", version.ref = "spek2" }
+
+[plugins]
+com-vanniktech-maven-publish = { id = "com.vanniktech.maven.publish", version = "0.34.0" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

settings.gradle.kts

@@ -4,19 +4,12 @@ pluginManagement {
         gradlePluginPortal()
         mavenCentral()
     }
-
-    val dokkaVersion: String by settings
-
     resolutionStrategy.eachPlugin {
         if (requested.id.namespace == "org.jetbrains.kotlin" ||
                 requested.id.namespace.orEmpty().startsWith("org.jetbrains.kotlin.")) {
             useVersion(embeddedKotlinVersion)
         }
     }
-
-    plugins {
-        id("org.jetbrains.dokka") version dokkaVersion apply false
-    }
 }
 
 @Suppress("UnstableApiUsage")