Gradle: Replace legacy buildSrc mechanism with included build (#1524)

Motivation: buildSrc is a special-case legacy mechanism. Gradle recommends using an included build named build-logic instead: https://docs.gradle.org/current/userguide/best_practices_structuring_builds.html#favor_composite_builds Changes: - Rename buildSrc/ to build-logic/ - triggers reformatting - Replace occurrences of "buildSrc" with "build-logic" - Include the build-logic build in the main build (via settings.gradle.kts) - Apply convention plugins via plugin IDs instead of type-safe accessors - small tradeoff compared to buildSrc Result: - Faster and more isolated builds - Build logic behaves like a normal build, making it easier to evolve and reason about --------- Co-authored-by: Daniel Chao <dan.chao@apple.com>
2026-05-25 16:19:20 +02:00 · 2026-04-16 05:37:10 +01:00
parent 04a9cc90d2
commit 4faf35a66a
56 changed files with 343 additions and 350 deletions
@@ -0,0 +1,113 @@
+/*
+ * Copyright © 2024-2026 Apple Inc. and the Pkl project authors. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+plugins { java }
+
+val gradlePluginTests = extensions.create<GradlePluginTests>("gradlePluginTests")
+
+tasks.addRule("Pattern: compatibilityTest[All|Releases|Latest|Candidate|Nightly|<GradleVersion>]") {
+  val taskName = this
+  val matchResult = Regex("compatibilityTest(.+)").matchEntire(taskName) ?: return@addRule
+
+  // https://github.com/gradle/gradle/issues/32599
+  @Suppress("DEPRECATION")
+  when (val taskNameSuffix = matchResult.groupValues[1]) {
+    "All" ->
+      task("compatibilityTestAll") {
+        dependsOn(
+          "compatibilityTestReleases",
+          "compatibilityTestCandidate",
+          "compatibilityTestNightly",
+        )
+      }
+    // releases in configured range
+    "Releases" ->
+      task("compatibilityTestReleases") {
+        val versionInfos = GradleVersionInfo.fetchReleases()
+        val allVersions =
+          versionInfos
+            .filter { versionInfo ->
+              val v = versionInfo.gradleVersion
+              !versionInfo.broken &&
+                v in gradlePluginTests.minGradleVersion..gradlePluginTests.maxGradleVersion &&
+                v !in gradlePluginTests.skippedGradleVersions
+            }
+            .sortedBy { it.gradleVersion }
+        val versionsToTestAgainst = listOf(allVersions.first(), allVersions.last())
+
+        dependsOn(versionsToTestAgainst.map { createCompatibilityTestTask(it) })
+      }
+    // latest release (if not developing against latest)
+    "Latest" ->
+      task("compatibilityTestLatest") {
+        val versionInfo = GradleVersionInfo.fetchCurrent()
+        if (versionInfo.version == gradle.gradleVersion) {
+          doLast {
+            println(
+              "No new Gradle release available. " +
+                "(Run `gradlew test` to test against ${versionInfo.version}.)"
+            )
+          }
+        } else {
+          dependsOn(createCompatibilityTestTask(versionInfo))
+        }
+      }
+    // active release candidate (if any)
+    "Candidate" ->
+      task("compatibilityTestCandidate") {
+        val versionInfo = GradleVersionInfo.fetchRc()
+        if (versionInfo?.activeRc == true) {
+          dependsOn(createCompatibilityTestTask(versionInfo))
+        } else {
+          doLast { println("No active Gradle release candidate available.") }
+        }
+      }
+    // latest nightly
+    "Nightly" ->
+      task("compatibilityTestNightly") {
+        val versionInfo = GradleVersionInfo.fetchNightly()
+        dependsOn(createCompatibilityTestTask(versionInfo))
+      }
+    // explicit version
+    else ->
+      createCompatibilityTestTask(
+        taskNameSuffix,
+        "https://services.gradle.org/distributions-snapshots/gradle-$taskNameSuffix-bin.zip",
+      )
+  }
+}
+
+fun createCompatibilityTestTask(versionInfo: GradleVersionInfo): TaskProvider<Test> =
+  createCompatibilityTestTask(versionInfo.version, versionInfo.downloadUrl)
+
+fun createCompatibilityTestTask(version: String, downloadUrl: String): TaskProvider<Test> {
+  return tasks.register("compatibilityTest$version", Test::class.java) {
+    mustRunAfter(tasks.test)
+
+    maxHeapSize = tasks.test.get().maxHeapSize
+    jvmArgs = tasks.test.get().jvmArgs
+    classpath = tasks.test.get().classpath
+    systemProperty("testGradleVersion", version)
+    systemProperty("testGradleDistributionUrl", downloadUrl)
+
+    doFirst {
+      if (version == gradle.gradleVersion && gradle.taskGraph.hasTask(tasks.test.get())) {
+        // don't test same version twice
+        println("This version has already been tested by the `test` task.")
+        throw StopExecutionException()
+      }
+    }
+  }
+}