Apply kotlinx-atomicfu plugin by id (#443)

Co-authored-by: Dmitrii Krasnov <[email protected]>

.gitignore

@@ -2,4 +2,5 @@
 *.iml
 */target/*
 build
-.gradle
+.gradle
+.kotlin

atomicfu-gradle-plugin/build.gradle.kts

@@ -3,6 +3,7 @@
  */
 
 plugins {
+    alias(libs.plugins.gradle.pluginPublish)
     id("kotlin-jvm-conventions")
     id("java-gradle-plugin")
 }
@@ -40,3 +41,22 @@ tasks.processResources {
         expand("atomicfuVersion" to project.version)
     }
 }
+
+signing {
+    // disable signing if private key isn't passed
+    isRequired = findProperty("libs.sign.key.private") != null
+}
+
+gradlePlugin {
+    website.set("https://github.com/Kotlin/kotlinx-atomicfu")
+    vcsUrl.set("https://github.com/Kotlin/kotlinx-atomicfu.git")
+
+    plugins {
+        create("Atomicfu") {
+            id = "kotlinx-atomicfu"
+            implementationClass = "kotlinx.atomicfu.plugin.gradle.AtomicFUGradlePlugin"
+            displayName = "Gradle plugin for kotlinx-atomicfu library"
+            description = "Enables efficient use of atomic operations in Kotlin multiplatform projects."
+        }
+    }
+}

atomicfu-maven-plugin/build.gradle.kts

@@ -4,7 +4,7 @@
 
 plugins {
     `maven-publish`
-    id("kotlin-jvm-conventions")
+    id("kotlin-jvm-publish-conventions")
 }
 
 dependencies {

atomicfu-transformer/build.gradle.kts

@@ -3,7 +3,7 @@
  */
 
 plugins {
-    id("kotlin-jvm-conventions")
+    id("kotlin-jvm-publish-conventions")
 }
 
 dependencies {

buildSrc/src/main/kotlin/publish-conventions.gradle.kts → buildSrc/src/main/kotlin/base-publish-conventions.gradle.kts

@@ -3,12 +3,6 @@ plugins {
     signing
 }
 
-val javadocJar by tasks.register<Jar>("javadocJar") {
-    description = "Create a Javadoc JAR. Empty by default."
-    // Create an empty Javadoc JAR to satisfy Maven Central requirements.
-    archiveClassifier.set("javadoc")
-}
-
 publishing {
     repositories {
         maven {
@@ -52,15 +46,6 @@ publishing {
 
 
         signPublicationIfKeyPresent(project, this)
-        // TODO(Dmitrii Krasnov): https://github.com/Kotlin/kotlinx-atomicfu/issues/421
-        //      Figure out if there's an alternative to string-based config
-        //      (if the name changes this config will silently stop working).
-        //      Maybe the Javadoc JAR can always be added?
-        // add empty javadocs
-
-        if (name != "kotlinMultiplatform") { // The root module gets the JVM's javadoc JAR
-            artifact(javadocJar)
-        }
     }
 
     tasks.withType<AbstractPublishToMaven>().configureEach {

buildSrc/src/main/kotlin/kotlin-jvm-conventions.gradle.kts

@@ -2,27 +2,11 @@ plugins {
 //     Regular java modules need 'java-library' plugin for proper publication
     `java-library`
     kotlin("jvm")
-    id("publish-conventions")
+    id("base-publish-conventions")
     id("common-conventions")
     id("kotlin-base-conventions")
 }
 
-// MPP projects pack their sources automatically, java libraries need to explicitly pack them
-val sourcesJar by tasks.registering(Jar::class) {
-    archiveClassifier.set("sources")
-    from("src/main/kotlin")
-}
-
-publishing {
-    // Configure java publications for non-MPP projects
-    publications {
-        create<MavenPublication>("maven") {
-            from(components["java"])
-            artifact(sourcesJar)
-        }
-    }
-}
-
 kotlin {
     jvmToolchain(8)
 }

buildSrc/src/main/kotlin/kotlin-jvm-publish-conventions.gradle.kts

@@ -0,0 +1,20 @@
+plugins {
+    id("kotlin-jvm-conventions")
+    id("publish-with-javadoc-conventions")
+}
+
+// MPP projects pack their sources automatically, java libraries need to explicitly pack them
+val sourcesJar by tasks.registering(Jar::class) {
+    archiveClassifier.set("sources")
+    from("src/main/kotlin")
+}
+
+publishing {
+    // Configure java publications for non-MPP projects
+    publications {
+        create<MavenPublication>("maven") {
+            from(components["java"])
+            artifact(sourcesJar)
+        }
+    }
+}

buildSrc/src/main/kotlin/kotlin-multiplatform-publish-conventions.gradle.kts

@@ -2,7 +2,7 @@ import groovy.util.Node
 import groovy.util.NodeList
 
 plugins {
-    id("publish-conventions")
+    id("publish-with-javadoc-conventions")
 }
 
 afterEvaluate {

buildSrc/src/main/kotlin/publish-with-javadoc-conventions.gradle.kts

@@ -0,0 +1,17 @@
+plugins {
+    id("base-publish-conventions")
+}
+
+val javadocJar by tasks.register<Jar>("javadocJar") {
+    description = "Create a Javadoc JAR. Empty by default."
+    // Create an empty Javadoc JAR to satisfy Maven Central requirements.
+    archiveClassifier.set("javadoc")
+}
+
+publishing {
+    publications.withType<MavenPublication>().configureEach {
+        if (name != "kotlinMultiplatform") { // The root module gets the JVM's javadoc JAR
+            artifact(javadocJar)
+        }
+    }
+}

gradle/libs.versions.toml

@@ -8,6 +8,7 @@ maven = "3.5.3"
 maven-pluginTools = "3.5"
 node-gradle = "3.1.1"
 rhino = "1.7.10"
+gradle-plugin-publish = "1.2.1"
 
 [libraries]
 
@@ -50,4 +51,5 @@ maven = ["maven-core", "maven-pluginApi", "maven-pluginAnnotations"]
 gradle-nodePlugin = { id = "com.github.node-gradle.node", version.ref = "node-gradle" }
 kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 kotlinx-binaryCompatibilityValidator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version.ref = "kotlinx-binaryCompatibilityValidator"}
+gradle-pluginPublish =  { id = "com.gradle.plugin-publish", version.ref = "gradle-plugin-publish" }
 

integration-testing/build.gradle.kts

@@ -5,7 +5,7 @@
 import org.jetbrains.kotlin.gradle.utils.NativeCompilerDownloader
 
 plugins {
-    id("kotlin-jvm-conventions")
+    id("kotlin-jvm-publish-conventions")
 }
 
 java {

integration-testing/examples/jdk-compatibility/build.gradle.kts

@@ -1,29 +1,14 @@
 import org.jetbrains.kotlin.config.JvmTarget
 
-buildscript {
-    repositories {
-        mavenLocal()
-        mavenCentral()
-    }
-
-    dependencies {
-        val atomicfuVersion = libs.versions.atomicfuVersion.get()
-        val kotlinVersion = libs.versions.kotlinVersion.get()
-        classpath("org.jetbrains.kotlinx:atomicfu-gradle-plugin:$atomicfuVersion")
-        classpath("org.jetbrains.kotlin:atomicfu:$kotlinVersion")
-    }
-}
-
 group = "kotlinx.atomicfu.examples"
 version = "DUMMY_VERSION"
 
 plugins {
     kotlin("jvm") version libs.versions.kotlinVersion.get()
+    id("kotlinx-atomicfu") version libs.versions.atomicfuVersion.get()
     `maven-publish`
 }
 
-apply(plugin = "kotlinx-atomicfu")
-
 repositories {
     mavenCentral()
     maven("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/dev")

integration-testing/examples/jvm-sample/build.gradle.kts

@@ -1,21 +1,10 @@
-buildscript {
-    repositories {
-        mavenLocal()
-        mavenCentral()
-    }
-
-    dependencies {
-        val atomicfuVersion = libs.versions.atomicfuVersion.get()
-        classpath("org.jetbrains.kotlinx:atomicfu-gradle-plugin:$atomicfuVersion")
-    }
-}
-
 group = "kotlinx.atomicfu.examples"
 version = "DUMMY_VERSION"
 
 plugins {
     application
     kotlin("jvm") version libs.versions.kotlinVersion.get()
+    id("kotlinx-atomicfu") version libs.versions.atomicfuVersion.get()
     `maven-publish`
 }
 

integration-testing/examples/mpp-sample/build.gradle.kts

@@ -4,28 +4,15 @@
 
 import org.jetbrains.kotlin.gradle.dsl.KotlinCompile
 
-buildscript {
-    repositories {
-        mavenLocal()
-        mavenCentral()
-    }
-
-    dependencies {
-        val atomicfuVersion = libs.versions.atomicfuVersion.get()
-        classpath("org.jetbrains.kotlinx:atomicfu-gradle-plugin:$atomicfuVersion")
-    }
-}
-
 group = "kotlinx.atomicfu.examples"
 version = "DUMMY_VERSION"
 
 plugins {
     kotlin("multiplatform") version libs.versions.kotlinVersion.get()
     `maven-publish`
+    id("kotlinx-atomicfu") version libs.versions.atomicfuVersion.get()
 }
 
-apply(plugin = "kotlinx-atomicfu")
-
 repositories {
     mavenCentral()
     maven("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/dev")

integration-testing/examples/mpp-version-catalog/shared/build.gradle.kts

@@ -4,12 +4,6 @@
 
 import org.jetbrains.kotlin.gradle.dsl.KotlinCompile
 
-buildscript {
-    dependencies {
-        classpath(libs.atomicfuGradlePlugin)
-    }
-}
-
 repositories {
     mavenCentral()
     maven("https://maven.pkg.jetbrains.space/kotlin/p/kotlin/dev")
@@ -18,10 +12,9 @@ repositories {
 
 plugins {
     alias(libs.plugins.kotlinMultiplatform)
+    id("kotlinx-atomicfu") version libs.versions.atomicfu.get()
 }
 
-apply (plugin = "kotlinx-atomicfu")
-
 kotlin {
 
     jvm()

integration-testing/examples/multi-module-test/producer/build.gradle.kts

@@ -1,21 +1,8 @@
-buildscript {
-    repositories {
-        mavenLocal()
-        mavenCentral()
-    }
-
-    dependencies {
-        val atomicfuVersion = libs.versions.atomicfuVersion.get()
-        classpath("org.jetbrains.kotlinx:atomicfu-gradle-plugin:$atomicfuVersion")
-    }
-}
-
 plugins {
     kotlin("multiplatform") version libs.versions.kotlinVersion.get()
+    id("kotlinx-atomicfu") version libs.versions.atomicfuVersion.get()
 }
 
-apply(plugin = "kotlinx-atomicfu")
-
 repositories {
     mavenLocal()
     mavenCentral()