Move buildSrc to build-logic

damianmalczewski · damianmalczewski · commit 01757e78d9dc · 2026-06-07T20:13:46.000+02:00
diff --git a/.github/workflows/gradle-build.yml b/.github/workflows/gradle-build.yml
@@ -8,7 +8,6 @@ on:
       - "release-*"
     paths:
       - ".github/workflows/gradle-build.yml"
-      - "buildSrc/**"
       - "gradle/**"
       - "**/src/**"
       - "**/*.gradle.kts"
diff --git a/.github/workflows/gradle-dependency-submission.yml b/.github/workflows/gradle-dependency-submission.yml
@@ -8,7 +8,6 @@ on:
       - "release-*"
     paths:
       - ".github/workflows/gradle-dependency-submission.yml"
-      - "buildSrc/**"
       - "gradle/**"
       - "**/*.gradle.kts"
       - "gradle.properties"
diff --git a/AGENTS.md b/AGENTS.md
@@ -16,7 +16,7 @@ Prioritize changes in the module matching the Spring integration in context.
 
 ## Build & Validate
 
-Requires **JDK 17+**. Dependencies managed in `gradle/libs.versions.toml`. Custom Gradle plugins live in `buildSrc`.
+Requires **JDK 17+**. Dependencies managed in `gradle/libs.versions.toml`. Custom Gradle plugins live in `build-logic`.
 
 ```shell
 ./gradlew                  # default: spotlessApply build (preferred)
diff --git a/build-logic/build.gradle.kts b/build-logic/build.gradle.kts
@@ -1,17 +1,10 @@
-// Note that usage of version catalogs in buildSrc is not as straightforward as in regular modules.
+// Note that usage of version catalogs in build-logic is not as straightforward as in regular modules.
 // For more information, see:
 // https://docs.gradle.org/current/userguide/version_catalogs.html#sec:buildsrc-version-catalog
 plugins {
     `kotlin-dsl`
 }
 
-version = "current"
-
-repositories {
-    gradlePluginPortal()
-    mavenCentral()
-}
-
 dependencies {
     implementation(plugin(libs.plugins.idea.ext))
 }
diff --git a/build-logic/gradle.properties b/build-logic/gradle.properties
@@ -0,0 +1,3 @@
+# Project Settings
+group=io.github.problem4j
+version=latest
diff --git a/build-logic/settings.gradle.kts b/build-logic/settings.gradle.kts
@@ -1,18 +1,24 @@
-// Note that usage of version catalogs in buildSrc is not as straightforward as in regular modules.
+// Note that usage of version catalogs in build-logic is not as straightforward as in regular modules.
 // For more information, see:
 // https://docs.gradle.org/current/userguide/version_catalogs.html#sec:buildsrc-version-catalog
 pluginManagement {
     repositories {
         gradlePluginPortal()
+        mavenCentral()
     }
 }
 
 dependencyResolutionManagement {
+    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+    repositories {
+        gradlePluginPortal()
+        mavenCentral()
+    }
     versionCatalogs {
         create("libs") {
             from(files("../gradle/libs.versions.toml"))
         }
     }
 }
 
-rootProject.name = "buildSrc"
+rootProject.name = "build-logic"
diff --git a/build-logic/src/main/kotlin/internal.idea-convention.gradle.kts b/build-logic/src/main/kotlin/internal.idea-convention.gradle.kts
@@ -1,4 +1,3 @@
-import org.jetbrains.gradle.ext.Application
 import org.jetbrains.gradle.ext.Gradle
 import org.jetbrains.gradle.ext.JUnit
 import org.jetbrains.gradle.ext.runConfigurations
diff --git a/build-logic/src/main/kotlin/internal.jacoco-convention.gradle.kts b/build-logic/src/main/kotlin/internal.jacoco-convention.gradle.kts
diff --git a/build-logic/src/main/kotlin/internal.java-library-convention.gradle.kts b/build-logic/src/main/kotlin/internal.java-library-convention.gradle.kts
@@ -1,7 +1,7 @@
 import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+import org.gradle.api.tasks.testing.logging.TestLogEvent
 
 plugins {
-    id("internal.common-convention")
     id("java-library")
 }
 
@@ -33,7 +33,7 @@ tasks.withType<Test>().configureEach {
     useJUnitPlatform()
 
     testLogging {
-        events("passed", "skipped", "failed", "standardOut", "standardError")
+        events(TestLogEvent.FAILED, TestLogEvent.PASSED, TestLogEvent.SKIPPED)
         exceptionFormat = TestExceptionFormat.SHORT
         showStandardStreams = true
     }
@@ -45,7 +45,20 @@ tasks.withType<Test>().configureEach {
     systemProperty("user.country", "US")
 }
 
-// buildSrc/src/main/kotlin/internal.common-convention.gradle.kts - "printVersion" task definition
+// Usage:
+//   ./gradlew printVersion
+tasks.register<DefaultTask>("printVersion") {
+    description = "Prints the current project version to the console."
+    group = "help"
+
+    val projectName = project.name
+    val projectVersion = project.version.toString()
+
+    doLast {
+        println("$projectName version: $projectVersion")
+    }
+}
+
 tasks.withType<PublishToMavenLocal>().configureEach {
     finalizedBy("printVersion")
 }
diff --git a/build-logic/src/main/kotlin/internal.publishing-convention.gradle.kts b/build-logic/src/main/kotlin/internal.publishing-convention.gradle.kts
@@ -4,7 +4,6 @@ import internal.findLicenses
 import internal.getBooleanProperty
 
 plugins {
-    id("internal.common-convention")
     id("maven-publish")
     id("signing")
 }
@@ -32,8 +31,8 @@ publishing {
             pom {
                 name = internalPublishing.displayName
                 description = internalPublishing.description
-                url = property("internal.pom.url") as String
-                inceptionYear = property("internal.pom.inception-year") as String
+                url = findProperty("internal.pom.url") as? String
+                inceptionYear = findProperty("internal.pom.inception-year") as? String
                 licenses {
                     project.findLicenses().forEach {
                         license {
@@ -57,13 +56,13 @@ publishing {
                     }
                 }
                 scm {
-                    connection = property("internal.pom.scm.connection") as String
-                    developerConnection = property("internal.pom.scm.developer-connection") as String
-                    url = property("internal.pom.scm.url") as String
+                    connection = findProperty("internal.pom.scm.connection") as? String
+                    developerConnection = findProperty("internal.pom.scm.developer-connection") as? String
+                    url = findProperty("internal.pom.scm.url") as? String
                 }
                 issueManagement {
-                    system = property("internal.pom.issue-management.system") as String
-                    url = property("internal.pom.issue-management.url") as String
+                    system = findProperty("internal.pom.issue-management.system") as? String
+                    url = findProperty("internal.pom.issue-management.url") as? String
                 }
             }
         }
diff --git a/build-logic/src/main/kotlin/internal/InternalExtensions.kt b/build-logic/src/main/kotlin/internal/InternalExtensions.kt
@@ -1,9 +1,47 @@
 package internal
 
-// This file contains extension functions for Gradle's Project API.
+// This file contains internal extensions for Gradle API.
 
 import org.gradle.api.Project
 
+/**
+ * Represents a single developer entry used in publishing metadata (e.g. POM developers section).
+ *
+ * All fields except [id] are optional to allow partial definitions in `gradle.properties`. Missing
+ * optional values are simply omitted from the generated publication metadata.
+ *
+ * @property id Unique developer identifier (required).
+ * @property name Human-readable developer name.
+ * @property email Contact email address.
+ * @property url Developer personal or profile URL.
+ * @property organization Organization the developer belongs to.
+ * @property organizationUrl URL of the organization.
+ */
+data class Developer(
+    val id: String,
+    val name: String?,
+    val email: String?,
+    val url: String?,
+    val organization: String?,
+    val organizationUrl: String?,
+)
+
+/**
+ * Represents a single license entry used in publishing metadata (e.g. POM licenses section).
+ *
+ * All fields except [name] are optional to allow partial definitions in `gradle.properties`.
+ * Missing optional values are simply omitted from the generated publication metadata.
+ *
+ * @property name Human-readable license name.
+ * @property url URL to the full license details.
+ */
+data class License(
+    val name: String?,
+    val url: String?,
+    val distribution: String?,
+    val comments: String?,
+)
+
 /**
  * Evaluates a structured list of developers defined in `gradle.properties`.
  *
diff --git a/build-logic/src/main/kotlin/internal/InternalPublishingExtension.kt b/build-logic/src/main/kotlin/internal/InternalPublishingExtension.kt
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -2,7 +2,6 @@ import com.diffplug.spotless.LineEnding
 import internal.getBooleanProperty
 
 plugins {
-    id("internal.common-convention")
     id("internal.idea-convention")
     id("jacoco-report-aggregation")
     alias(libs.plugins.nmcp).apply(false)
@@ -67,13 +66,14 @@ spotless {
     kotlin {
         target("**/src/**/*.kt")
 
-        ktfmt("0.61").metaStyle()
+        ktfmt("0.63").metaStyle()
         endWithNewline()
         lineEndings = LineEnding.UNIX
     }
 
     kotlinGradle {
-        target("*.gradle.kts", "problem4j-*/*.gradle.kts", "buildSrc/*.gradle.kts", "buildSrc/src/**/*.gradle.kts")
+        target("**/*.gradle.kts")
+        targetExclude("**/build/**")
 
         ktlint("1.8.0").editorConfigOverride(mapOf("max_line_length" to "120"))
         endWithNewline()
diff --git a/buildSrc/src/main/kotlin/internal.common-convention.gradle.kts b/buildSrc/src/main/kotlin/internal.common-convention.gradle.kts
diff --git a/buildSrc/src/main/kotlin/internal.java-platform-convention.gradle.kts b/buildSrc/src/main/kotlin/internal.java-platform-convention.gradle.kts
diff --git a/buildSrc/src/main/kotlin/internal/Developer.kt b/buildSrc/src/main/kotlin/internal/Developer.kt
diff --git a/buildSrc/src/main/kotlin/internal/License.kt b/buildSrc/src/main/kotlin/internal/License.kt
diff --git a/problem4j-spring-bom/build.gradle.kts b/problem4j-spring-bom/build.gradle.kts
@@ -1,5 +1,5 @@
 plugins {
-    id("internal.java-platform-convention")
+    id("java-platform")
     id("internal.publishing-convention")
     alias(libs.plugins.nmcp)
 }
@@ -14,7 +14,7 @@ dependencies {
     }
 }
 
-// see buildSrc/src/main/kotlin/internal.publishing-convention.gradle.kts
+// see build-logic/src/main/kotlin/internal.publishing-convention.gradle.kts
 internalPublishing {
     displayName = "Problem4J Spring BOM"
     description = "BOM of Spring integration for library implementing RFC7807 (aka RFC9457)."
diff --git a/problem4j-spring-web/build.gradle.kts b/problem4j-spring-web/build.gradle.kts
@@ -32,7 +32,7 @@ dependencies {
     testRuntimeOnly(libs.junit.platform.launcher)
 }
 
-// see buildSrc/src/main/kotlin/internal.publishing-convention.gradle.kts
+// see build-logic/src/main/kotlin/internal.publishing-convention.gradle.kts
 internalPublishing {
     displayName = "Problem4J Spring Web"
     description = "Spring Web integration for library implementing RFC7807 (aka RFC9457)."
diff --git a/problem4j-spring-webflux/build.gradle.kts b/problem4j-spring-webflux/build.gradle.kts
@@ -30,7 +30,7 @@ dependencies {
     testRuntimeOnly(libs.junit.platform.launcher)
 }
 
-// see buildSrc/src/main/kotlin/internal.publishing-convention.gradle.kts
+// see build-logic/src/main/kotlin/internal.publishing-convention.gradle.kts
 internalPublishing {
     displayName = "Problem4J Spring WebFlux"
     description = "Spring WebFlux integration for library implementing RFC7807 (aka RFC9457)."
diff --git a/problem4j-spring-webmvc/build.gradle.kts b/problem4j-spring-webmvc/build.gradle.kts
@@ -31,7 +31,7 @@ dependencies {
     testRuntimeOnly(libs.junit.platform.launcher)
 }
 
-// see buildSrc/src/main/kotlin/internal.publishing-convention.gradle.kts
+// see build-logic/src/main/kotlin/internal.publishing-convention.gradle.kts
 internalPublishing {
     displayName = "Problem4J Spring WebMVC"
     description = "Spring WebMVC integration for library implementing RFC7807 (aka RFC9457)."
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,6 +1,15 @@
 pluginManagement {
+    includeBuild("build-logic")
     repositories {
         gradlePluginPortal()
+        mavenCentral()
+    }
+}
+
+dependencyResolutionManagement {
+    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+    repositories {
+        mavenCentral()
     }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Project Settings`
	`2`	`+group=io.github.problem4j`
	`3`	`+version=latest`
Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,24 @@`
`1`		`-// Note that usage of version catalogs in buildSrc is not as straightforward as in regular modules.`
	`1`	`+// Note that usage of version catalogs in build-logic is not as straightforward as in regular modules.`
`2`	`2`	`// For more information, see:`
`3`	`3`	`// https://docs.gradle.org/current/userguide/version_catalogs.html#sec:buildsrc-version-catalog`
`4`	`4`	`pluginManagement {`
`5`	`5`	`repositories {`
`6`	`6`	`gradlePluginPortal()`
	`7`	`+ mavenCentral()`
`7`	`8`	`}`
`8`	`9`	`}`
`9`	`10`
`10`	`11`	`dependencyResolutionManagement {`
	`12`	`+ repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)`
	`13`	`+ repositories {`
	`14`	`+ gradlePluginPortal()`
	`15`	`+ mavenCentral()`
	`16`	`+ }`
`11`	`17`	`versionCatalogs {`
`12`	`18`	`create("libs") {`
`13`	`19`	`from(files("../gradle/libs.versions.toml"))`
`14`	`20`	`}`
`15`	`21`	`}`
`16`	`22`	`}`
`17`	`23`
`18`		`-rootProject.name = "buildSrc"`
	`24`	`+rootProject.name = "build-logic"`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import org.jetbrains.gradle.ext.Application`
`2`	`1`	`import org.jetbrains.gradle.ext.Gradle`
`3`	`2`	`import org.jetbrains.gradle.ext.JUnit`
`4`	`3`	`import org.jetbrains.gradle.ext.runConfigurations`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@ import internal.findLicenses`
`4`	`4`	`import internal.getBooleanProperty`
`5`	`5`
`6`	`6`	`plugins {`
`7`		`- id("internal.common-convention")`
`8`	`7`	`id("maven-publish")`
`9`	`8`	`id("signing")`
`10`	`9`	`}`
`@@ -32,8 +31,8 @@ publishing {`
`32`	`31`	`pom {`
`33`	`32`	`name = internalPublishing.displayName`
`34`	`33`	`description = internalPublishing.description`
`35`		`- url = property("internal.pom.url") as String`
`36`		`- inceptionYear = property("internal.pom.inception-year") as String`
	`34`	`+ url = findProperty("internal.pom.url") as? String`
	`35`	`+ inceptionYear = findProperty("internal.pom.inception-year") as? String`
`37`	`36`	`licenses {`
`38`	`37`	`project.findLicenses().forEach {`
`39`	`38`	`license {`
`@@ -57,13 +56,13 @@ publishing {`
`57`	`56`	`}`
`58`	`57`	`}`
`59`	`58`	`scm {`
`60`		`- connection = property("internal.pom.scm.connection") as String`
`61`		`- developerConnection = property("internal.pom.scm.developer-connection") as String`
`62`		`- url = property("internal.pom.scm.url") as String`
	`59`	`+ connection = findProperty("internal.pom.scm.connection") as? String`
	`60`	`+ developerConnection = findProperty("internal.pom.scm.developer-connection") as? String`
	`61`	`+ url = findProperty("internal.pom.scm.url") as? String`
`63`	`62`	`}`
`64`	`63`	`issueManagement {`
`65`		`- system = property("internal.pom.issue-management.system") as String`
`66`		`- url = property("internal.pom.issue-management.url") as String`
	`64`	`+ system = findProperty("internal.pom.issue-management.system") as? String`
	`65`	`+ url = findProperty("internal.pom.issue-management.url") as? String`
`67`	`66`	`}`
`68`	`67`	`}`
`69`	`68`	`}`