Extract publishable-library convention plugin, reorganize build-logic structure

radoslaw-panuszewski · radoslaw-panuszewski · commit 4c2f0788c2a6 · 2026-03-24T18:57:38.000+01:00
diff --git a/allwrite-recipes/build.gradle.kts b/allwrite-recipes/build.gradle.kts
@@ -1,11 +1,14 @@
 plugins {
-    `java-library`
-    `maven-publish`
     `java-test-fixtures`
-    signing
     alias(libs.plugins.openrewrite.recipe.library.base)
     id("conventions.kotlin")
     id("conventions.koin")
+    id("conventions.publishable-library")
+}
+
+publishableLibrary {
+    name = "allwrite-recipes"
+    description = "A collection of recipes, filling the gaps in vanilla OpenRewrite"
 }
 
 recipeDependencies {
@@ -51,47 +54,8 @@ dependencies {
     testImplementation(libs.rewrite.test)
 }
 
-publishing {
-    publications {
-        create<MavenPublication>("library") {
-            from(components["java"])
-            pom {
-                name = "allwrite-recipes"
-                description = "A collection of recipes, filling the gaps in vanilla OpenRewrite"
-                url = "https://github.com/allegro/allwrite"
-                licenses {
-                    license {
-                        name = "Apache License, Version 2.0"
-                        url = "https://www.apache.org/licenses/LICENSE-2.0.txt"
-                    }
-                }
-                scm {
-                    url = "https://github.com/allegro/allwrite"
-                    connection = "scm:git@github.com:allegro/allwrite.git"
-                    developerConnection = "scm:git@github.com:allegro/allwrite.git"
-                }
-                developers {
-                    developer {
-                        id = "radoslaw-panuszewski"
-                        name = "Radosław Panuszewski"
-                    }
-                    developer {
-                        id = "aleksandrserbin"
-                        name = "Aleksandr Serbin"
-                    }
-                }
-            }
-        }
-    }
-}
-
-signing {
-    val gpgKeyId = System.getenv("GPG_KEY_ID")
-    val gpgPrivateKey = System.getenv("GPG_PRIVATE_KEY")
-    val gpgPrivateKeyPassword = System.getenv("GPG_PRIVATE_KEY_PASSWORD")
-
-    if (gpgKeyId != null && gpgPrivateKey != null && gpgPrivateKeyPassword != null) {
-        useInMemoryPgpKeys(gpgKeyId, gpgPrivateKey, gpgPrivateKeyPassword)
-        sign(publishing.publications["library"])
+tasks {
+    test {
+        jvmArgs("-Xmx4g")
     }
 }
diff --git a/allwrite-spi/build.gradle.kts b/allwrite-spi/build.gradle.kts
@@ -1,7 +1,12 @@
 plugins {
-    `java-library`
     id("conventions.kotlin")
     id("conventions.koin")
+    id("conventions.publishable-library")
+}
+
+publishableLibrary {
+    name = "allwrite-spi"
+    description = "A service provider interface for implementing recipes aware of allwrite features (e.g. declaring friendly names)"
 }
 
 dependencies {
diff --git a/build-logic/README.md b/build-logic/README.md
@@ -0,0 +1,7 @@
+# build-logic
+
+This included build is split into several subprojects.
+
+The purpose of every subproject is to hold a subset of convention plugins that are mostly applied together.
+
+Ideally, modifying a convention plugin should only change classpath of the projects that apply it. Having all convention plugins in a single project would always change classpath of every project buildscript.
diff --git a/build-logic/cli-app-conventions/README.md b/build-logic/cli-app-conventions/README.md
@@ -0,0 +1,5 @@
+# cli-app-conventions
+
+Contains convention plugins only applied CLI app projects.
+
+Currently, there is only one such project: `allwrite-cli`.
diff --git a/build-logic/cli-app-conventions/build.gradle.kts b/build-logic/cli-app-conventions/build.gradle.kts
@@ -0,0 +1,7 @@
+plugins {
+    `kotlin-dsl`
+}
+
+dependencies {
+    implementation(projects.rootProjectConventions)
+}
diff --git a/build-logic/cli-app-conventions/src/main/kotlin/conventions/cli-distribution.gradle.kts b/build-logic/cli-app-conventions/src/main/kotlin/conventions/cli-distribution.gradle.kts
@@ -2,7 +2,7 @@
 
 package conventions
 
-import pl.allegro.tech.allwrite.buildlogic.jdk.ExtractJdkTask
+import pl.allegro.tech.allwrite.buildlogic.ExtractJdkTask
 import libs
 import org.gradle.internal.jvm.Jvm
 import org.jreleaser.gradle.plugin.tasks.AbstractJReleaserTask
diff --git a/build-logic/cli-distribution/build.gradle.kts b/build-logic/cli-distribution/build.gradle.kts
diff --git a/build-logic/kotlin-conventions/README.md b/build-logic/kotlin-conventions/README.md
@@ -0,0 +1,3 @@
+# kotlin-conventions
+
+Contains convention plugins to be applied in any project using Kotlin.
diff --git a/build-logic/kotlin-conventions/build.gradle.kts b/build-logic/kotlin-conventions/build.gradle.kts
diff --git a/build-logic/kotlin-conventions/src/main/kotlin/conventions/koin.gradle.kts b/build-logic/kotlin-conventions/src/main/kotlin/conventions/koin.gradle.kts
diff --git a/build-logic/kotlin-conventions/src/main/kotlin/conventions/kotlin.gradle.kts b/build-logic/kotlin-conventions/src/main/kotlin/conventions/kotlin.gradle.kts
diff --git a/build-logic/publishable-library-conventions/README.md b/build-logic/publishable-library-conventions/README.md
@@ -0,0 +1,3 @@
+# publishable-library-conventions
+
+Contains convention plugins to be applied in every subproject that we want to publish to Maven Central.
diff --git a/build-logic/publishable-library-conventions/build.gradle.kts b/build-logic/publishable-library-conventions/build.gradle.kts
diff --git a/build-logic/publishable-library-conventions/src/main/kotlin/conventions/publishable-library.gradle.kts b/build-logic/publishable-library-conventions/src/main/kotlin/conventions/publishable-library.gradle.kts
@@ -0,0 +1,57 @@
+package conventions
+
+import pl.allegro.tech.allwrite.buildlogic.PublishableLibraryExtension
+
+plugins {
+    `java-library`
+    `maven-publish`
+    signing
+}
+
+val extension = extensions.create<PublishableLibraryExtension>("publishableLibrary")
+
+publishing {
+    publications {
+        create<MavenPublication>("library") {
+            from(components["java"])
+            pom {
+                name = extension.name
+                description = extension.description
+                url = "https://github.com/allegro/allwrite"
+                licenses {
+                    license {
+                        name = "Apache License, Version 2.0"
+                        url = "https://www.apache.org/licenses/LICENSE-2.0.txt"
+                    }
+                }
+                scm {
+                    url = "https://github.com/allegro/allwrite"
+                    connection = "scm:git@github.com:allegro/allwrite.git"
+                    developerConnection = "scm:git@github.com:allegro/allwrite.git"
+                }
+                developers {
+                    developer {
+                        id = "radoslaw-panuszewski"
+                        name = "Radosław Panuszewski"
+                    }
+                    developer {
+                        id = "aleksandrserbin"
+                        name = "Aleksandr Serbin"
+                    }
+                }
+            }
+        }
+    }
+}
+
+signing {
+    val gpgKeyId = System.getenv("GPG_KEY_ID")
+    val gpgPrivateKey = System.getenv("GPG_PRIVATE_KEY")
+    val gpgPrivateKeyPassword = System.getenv("GPG_PRIVATE_KEY_PASSWORD")
+
+    if (gpgKeyId != null && gpgPrivateKey != null && gpgPrivateKeyPassword != null) {
+        useInMemoryPgpKeys(gpgKeyId, gpgPrivateKey, gpgPrivateKeyPassword)
+        sign(publishing.publications["library"])
+    }
+}
+
diff --git a/build-logic/publishable-library-conventions/src/main/kotlin/pl/allegro/tech/allwrite/buildlogic/PublishableLibraryExtension.kt b/build-logic/publishable-library-conventions/src/main/kotlin/pl/allegro/tech/allwrite/buildlogic/PublishableLibraryExtension.kt
@@ -0,0 +1,8 @@
+package pl.allegro.tech.allwrite.buildlogic
+
+import org.gradle.api.provider.Property
+
+abstract class PublishableLibraryExtension {
+    abstract val name: Property<String>
+    abstract val description: Property<String>
+}
diff --git a/build-logic/root-project-conventions/README.md b/build-logic/root-project-conventions/README.md
@@ -0,0 +1,13 @@
+# root-project-conventions
+
+Contains convention plugins to be applied in root project.
+
+Due to being applied to root project, every source file in `root-project-conventions` will land on every buildscript classpath in the entire build (subprojects inherit classpath from the parent project).
+
+As a result, modifying any file within `root-project-convention` will trigger full build reconfiguration and all tasks will go out of date (except for the built-in ones).
+
+When to put a convention plugin here:
+
+- it changes very rarely,
+- it performs some heavy operation that you want to keep UP-TO-DATE most of the time (like fetching JDKs),
+- it must be applied to root project for technical reasons
diff --git a/build-logic/root-project-conventions/build.gradle.kts b/build-logic/root-project-conventions/build.gradle.kts
@@ -7,3 +7,4 @@ dependencies {
     implementation(libs.bundles.ktor)
     implementation(libs.bundles.pgpainless)
 }
+
diff --git a/build-logic/root-project-conventions/src/main/kotlin/conventions/jdk-provisioning.gradle.kts b/build-logic/root-project-conventions/src/main/kotlin/conventions/jdk-provisioning.gradle.kts
@@ -1,9 +1,9 @@
 package conventions
 
-import pl.allegro.tech.allwrite.buildlogic.jdk.ExtractJdkTask
-import pl.allegro.tech.allwrite.buildlogic.jdk.FetchJdkTask
-import pl.allegro.tech.allwrite.buildlogic.jdk.VerifyJdkTask
-import pl.allegro.tech.allwrite.buildlogic.jdk.JdkDistribution
+import pl.allegro.tech.allwrite.buildlogic.ExtractJdkTask
+import pl.allegro.tech.allwrite.buildlogic.FetchJdkTask
+import pl.allegro.tech.allwrite.buildlogic.JdkDistribution
+import pl.allegro.tech.allwrite.buildlogic.VerifyJdkTask
 import java.nio.file.Path
 
 val provisionJdksTask = tasks.register("provisionJdks")
diff --git a/build-logic/root-project-conventions/src/main/kotlin/conventions/maven-central.gradle.kts b/build-logic/root-project-conventions/src/main/kotlin/conventions/maven-central.gradle.kts
diff --git a/build-logic/root-project-conventions/src/main/kotlin/conventions/versioning.gradle.kts b/build-logic/root-project-conventions/src/main/kotlin/conventions/versioning.gradle.kts
diff --git a/build-logic/root-project-conventions/src/main/kotlin/pl/allegro/tech/allwrite/buildlogic/ExtractJdkTask.kt b/build-logic/root-project-conventions/src/main/kotlin/pl/allegro/tech/allwrite/buildlogic/ExtractJdkTask.kt
@@ -1,4 +1,4 @@
-package pl.allegro.tech.allwrite.buildlogic.jdk
+package pl.allegro.tech.allwrite.buildlogic
 
 import org.apache.commons.compress.archivers.tar.TarArchiveInputStream
 import org.gradle.api.DefaultTask
diff --git a/build-logic/root-project-conventions/src/main/kotlin/pl/allegro/tech/allwrite/buildlogic/FetchJdkTask.kt b/build-logic/root-project-conventions/src/main/kotlin/pl/allegro/tech/allwrite/buildlogic/FetchJdkTask.kt
@@ -1,4 +1,4 @@
-package pl.allegro.tech.allwrite.buildlogic.jdk
+package pl.allegro.tech.allwrite.buildlogic
 
 import io.ktor.client.*
 import io.ktor.client.engine.cio.*
diff --git a/build-logic/root-project-conventions/src/main/kotlin/pl/allegro/tech/allwrite/buildlogic/JdkDistribution.kt b/build-logic/root-project-conventions/src/main/kotlin/pl/allegro/tech/allwrite/buildlogic/JdkDistribution.kt
@@ -1,4 +1,4 @@
-package pl.allegro.tech.allwrite.buildlogic.jdk
+package pl.allegro.tech.allwrite.buildlogic
 
 enum class JdkDistribution(
     /**
diff --git a/build-logic/root-project-conventions/src/main/kotlin/pl/allegro/tech/allwrite/buildlogic/VerifyJdkTask.kt b/build-logic/root-project-conventions/src/main/kotlin/pl/allegro/tech/allwrite/buildlogic/VerifyJdkTask.kt
@@ -1,4 +1,4 @@
-package pl.allegro.tech.allwrite.buildlogic.jdk
+package pl.allegro.tech.allwrite.buildlogic
 
 import org.gradle.api.DefaultTask
 import org.gradle.api.provider.Provider
diff --git a/build-logic/settings.gradle.kts b/build-logic/settings.gradle.kts
@@ -13,12 +13,13 @@ plugins {
 
 rootProject.name = "build-logic"
 
+
 // conventions from this subproject will land on every buildscript classpath (because they are applied to root project)
 // modifying those conventions may be painful, because it will trigger reconfiguration of every buildscript
-include("common")
+include("root-project-conventions")
 
-include("jdk-provisioning")
-include("cli-distribution")
-include("kotlin-compilation")
+include("cli-app-conventions")
+include("publishable-library-conventions")
+include("kotlin-conventions")
 
 enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# kotlin-conventions`
	`2`	`+`
	`3`	`+Contains convention plugins to be applied in any project using Kotlin.`