wip implementation of bcv 0.15, supporting klibs

Author: aSemy

.github/workflows/run_publish_maven.yml

@@ -40,5 +40,5 @@ jobs:
     with:
       runs-on: macos-latest # only macOS supports building all Kotlin targets
       gradle-task: >-
-        publishAllPublicationsToSonatypeReleaseRepository --stacktrace --no-configuration-cache --no-parallel
+        publishAllPublicationsToSonatypeReleaseRepository --stacktrace --no-parallel
       checkout-ref: ${{ inputs.checkout-ref }}

README.md

@@ -32,9 +32,9 @@ or (**experimentally**) [as a Settings plugin](#settings-plugin) in `settings.gr
 
 #### Requirements
 
-The minimal supported Gradle version is 7.6.
+The minimal supported Gradle version is 7.6.4.
 
-By default, BCV-MU uses BCV version `0.14.0`, which can be overridden, but may introduce runtime
+By default, BCV-MU uses BCV version `0.15.0-Beta.2`, which can be overridden, but may introduce runtime
 errors.
 
 ### Build plugin
@@ -49,7 +49,7 @@ plugins {
 }
 ```
 
-To initialise the API declarations, run the Gradle task
+To initialize the API declarations, run the Gradle task
 
 ```shell
 ./gradlew apiDump
@@ -74,7 +74,7 @@ BCV-MU can be configured in a similar manner to BCV:
 // build.gradle.kts
 
 plugins {
-  kotlin("jvm") version "1.8.10"
+  kotlin("jvm") version "1.9.22"
   id("dev.adamko.kotlin.binary-compatibility-validator") version "$bcvMuVersion"
 }
 
@@ -100,7 +100,7 @@ binaryCompatibilityValidator {
   bcvEnabled.set(true)
 
   // Override the default BCV version
-  kotlinxBinaryCompatibilityValidatorVersion.set("0.14.0")
+  kotlinxBinaryCompatibilityValidatorVersion.set("0.15.0-Beta.2")
 }
 ```
 
@@ -113,7 +113,7 @@ these `BCVTarget`s can be specifically modified, or manually defined, for fine-g
 // build.gradle.kts
 
 plugins {
-  kotlin("jvm") version "1.8.10"
+  kotlin("jvm") version "1.9.22"
   id("dev.adamko.kotlin.binary-compatibility-validator") version "$bcvMuVersion"
   `java-test-fixtures`
 }
@@ -214,7 +214,7 @@ All subprojects are included by default, and can be excluded using BCV-MU config
 buildscript {
   dependencies {
     // BCV-MU requires the Kotlin Gradle Plugin classes are present
-    classpath("org.jetbrains.kotlin:kotlin-gradle-plugin-api:1.8.10")
+    classpath("org.jetbrains.kotlin:kotlin-gradle-plugin-api:1.9.22")
   }
 }
 

build.gradle.kts

@@ -1,4 +1,5 @@
-import buildsrc.utils.generatedKotlinDslAccessorDirs
+import buildsrc.utils.excludeProjectConfigurationDirs
+import buildsrc.utils.filterContains
 
 plugins {
   buildsrc.conventions.base
@@ -13,20 +14,17 @@ project.version = object {
 
 idea {
   module {
-    excludeDirs = excludeDirs +
-        layout.generatedKotlinDslAccessorDirs() +
-        layout.files(
-          ".idea",
-          "gradle/wrapper",
-        )
+    excludeProjectConfigurationDirs(layout, providers)
   }
 }
 
+
 val readmeCheck by tasks.registering {
   group = LifecycleBasePlugin.VERIFICATION_GROUP
   val readme = providers.fileContents(layout.projectDirectory.file("README.md")).asText
   val supportedGradleVersion = libs.versions.supportedGradleVersion
   val kotlinBcvVersion = libs.versions.kotlinx.bcv
+  val kgpVersion = embeddedKotlinVersion
 
   doLast {
     readme.get().let { readme ->
@@ -39,6 +37,20 @@ val readmeCheck by tasks.registering {
       require("The minimal supported Gradle version is ${supportedGradleVersion.get()}" in readme) {
         "Incorrect Gradle version in README"
       }
+      readme.lines()
+        .filterContains("kotlin(\"jvm\") version ")
+        .forEach { line ->
+          require("kotlin(\"jvm\") version \"$kgpVersion\"" in line) {
+            "Incorrect Kotlin JVM plugin (expected $kgpVersion) version in README\n  $line"
+          }
+        }
+      readme.lines()
+        .filterContains("""org.jetbrains.kotlin:kotlin-gradle-plugin-api:""")
+        .forEach { line ->
+          require("""classpath("org.jetbrains.kotlin:kotlin-gradle-plugin-api:$kgpVersion")""" in line) {
+            "Incorrect kotlin-gradle-plugin-api version (expected $kgpVersion) version in README\n  $line"
+          }
+        }
     }
   }
 }
@@ -50,7 +62,7 @@ tasks.check {
 val projectVersion by tasks.registering {
   description = "prints the project version"
   group = "help"
-  val version = providers.provider { project.version }
+  val version = providers.provider { project.version.toString() }
   inputs.property("version", version)
   outputs.cacheIf("logging task, it should always run") { false }
   doLast {

buildSrc/src/main/kotlin/buildsrc/conventions/gradle-plugin-variants.gradle.kts

@@ -2,6 +2,7 @@ package buildsrc.conventions
 
 import buildsrc.settings.MavenPublishingSettings
 
+
 plugins {
   `maven-publish`
   signing
@@ -16,7 +17,7 @@ publishing {
   publications.withType<MavenPublication>().configureEach {
     pom {
       name.convention("Binary Compatibility Validator MU")
-      description.convention("BCV-MU is a Gradle Plugin that validates the public JVM binary API of libraries, to make sure that breaking changes are tracked.")
+      description.convention("BCV-MU is a Gradle Plugin that validates the public API of libraries, to make sure that breaking changes are tracked.")
       url.convention("https://github.com/adamko-dev/kotlin-binary-compatibility-validator-mu")
 
       scm {
@@ -89,23 +90,35 @@ signing {
 //endregion
 
 
-//region Fix Gradle warning about signing tasks using publishing task outputs without explicit dependencies
-// https://youtrack.jetbrains.com/issue/KT-46466 https://github.com/gradle/gradle/issues/26091
 tasks.withType<AbstractPublishToMaven>().configureEach {
+
+  //region Fix Gradle warning about signing tasks using publishing task outputs without explicit dependencies
+  // https://youtrack.jetbrains.com/issue/KT-46466 https://github.com/gradle/gradle/issues/26091
   val signingTasks = tasks.withType<Sign>()
   mustRunAfter(signingTasks)
-}
-//endregion
-
+  //endregion
 
-//region publishing logging
-tasks.withType<AbstractPublishToMaven>().configureEach {
+  //region publishing logging
   val publicationGAV = provider { publication?.run { "$group:$artifactId:$version" } }
   doLast("log publication GAV") {
     if (publicationGAV.isPresent) {
       logger.info("[task: ${path}] ${publicationGAV.get()}")
     }
   }
+  //endregion
+}
+
+
+//region Maven Central can't handle parallel uploads, so limit parallel uploads with a service.
+abstract class MavenPublishLimiter : BuildService<BuildServiceParameters.None>
+
+val mavenPublishLimiter =
+  gradle.sharedServices.registerIfAbsent("mavenPublishLimiter", MavenPublishLimiter::class) {
+    maxParallelUsages = 1
+  }
+
+tasks.withType<PublishToMavenRepository>().configureEach {
+  usesService(mavenPublishLimiter)
 }
 //endregion
 

buildSrc/src/main/kotlin/buildsrc/conventions/maven-publishing.gradle.kts

@@ -1,10 +1,8 @@
 package buildsrc.utils
 
-import java.io.File
 import org.gradle.api.Project
 import org.gradle.api.artifacts.Configuration
 import org.gradle.api.component.AdhocComponentWithVariants
-import org.gradle.api.file.ProjectLayout
 import org.gradle.api.file.RelativePath
 import org.gradle.api.tasks.SourceSet
 import org.gradle.kotlin.dsl.*
@@ -142,19 +140,3 @@ fun SourceSet.configurationNames() =
     javadocElementsConfigurationName,
     sourcesElementsConfigurationName,
   )
-
-/** exclude generated Gradle code, so it doesn't clog up search results */
-fun ProjectLayout.generatedKotlinDslAccessorDirs(): Set<File> {
-
-  val generatedSrcDirs = listOf(
-    "kotlin-dsl-accessors",
-    "kotlin-dsl-external-plugin-spec-builders",
-    "kotlin-dsl-plugins",
-  )
-
-  return projectDirectory.asFile.walk()
-    .filter { it.isDirectory && it.parentFile.name in generatedSrcDirs }
-    .flatMap { file ->
-      file.walk().maxDepth(1).filter { it.isDirectory }.toList()
-    }.toSet()
-}

buildSrc/src/main/kotlin/buildsrc/utils/gradle.kt

@@ -1,4 +1,74 @@
 package buildsrc.utils
 
 import java.io.File
+import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.file.ProjectLayout
+import org.gradle.api.provider.ProviderFactory
+import org.gradle.api.provider.ValueSource
+import org.gradle.api.provider.ValueSourceParameters
+import org.gradle.kotlin.dsl.*
+import org.gradle.plugins.ide.idea.model.IdeaModule
+
+/**
+ * Exclude directories containing
+ *
+ * - generated Gradle code,
+ * - IDE files,
+ * - Gradle config,
+ *
+ * so they don't clog up search results.
+ */
+fun IdeaModule.excludeProjectConfigurationDirs(
+  layout: ProjectLayout,
+  providers: ProviderFactory,
+) {
+  val excludedDirs = providers.of(IdeaExcludedDirectoriesSource::class) {
+    parameters.projectDir.set(layout.projectDirectory)
+  }
+
+  excludeDirs.addAll(excludedDirs.get())
+}
+
+// We have to use a ValueSource to find the files, otherwise Gradle
+// considers _all files_ an input for configuration cache 🙄
+internal abstract class IdeaExcludedDirectoriesSource
+  : ValueSource<Set<File>, IdeaExcludedDirectoriesSource.Parameters> {
+
+  interface Parameters : ValueSourceParameters {
+    val projectDir: DirectoryProperty
+  }
+
+  override fun obtain(): Set<File> {
+    val projectDir = parameters.projectDir.get().asFile
+
+    val excludedDirs = setOf(
+      ".git",
+      ".gradle",
+      ".idea",
+      ".kotlin",
+    )
+
+    val generatedSrcDirs = listOf(
+      "kotlin-dsl-accessors",
+      "kotlin-dsl-external-plugin-spec-builders",
+      "kotlin-dsl-plugins",
+    )
+
+    val generatedDirs = projectDir
+      .walk()
+      .onEnter { it.name !in excludedDirs && it.parentFile.name !in generatedSrcDirs }
+      .filter { it.isDirectory }
+      .filter { it.parentFile.name in generatedSrcDirs }
+      .flatMap { file ->
+        file.walk().maxDepth(1).filter { it.isDirectory }.toList()
+      }
+      .toSet()
+
+    // can't use buildSet {} https://github.com/gradle/gradle/issues/28325
+    return mutableSetOf<File>().apply {
+      addAll(generatedDirs)
+      add(projectDir.resolve(".idea"))
+      add(projectDir.resolve("gradle/wrapper"))
+    }
+  }
+}

buildSrc/src/main/kotlin/buildsrc/utils/intellij.kt

@@ -7,3 +7,6 @@ fun String.titlecaseFirstChar(): String =
       else             -> it.toString()
     }
   }
+
+fun List<String>.filterContains(substring: String): List<String> =
+  filter { substring in it }

buildSrc/src/main/kotlin/buildsrc/utils/kotlinStdlib.kt

@@ -1,9 +1,9 @@
-org.gradle.jvmargs=-Dfile.encoding=UTF-8 -XX:+HeapDumpOnOutOfMemoryError
+org.gradle.jvmargs=-Dfile.encoding=UTF-8 -XX:+HeapDumpOnOutOfMemoryError -Xmx2g -XX:MaxMetaspaceSize=512m
 
 org.gradle.caching=true
 
-org.gradle.unsafe.configuration-cache=true
-org.gradle.unsafe.configuration-cache-problems=warn
+org.gradle.configuration-cache=true
+org.gradle.configuration-cache-problems=warn
 
 org.gradle.parallel=true
 org.gradle.welcome=never

gradle.properties

@@ -1,18 +1,18 @@
 [versions]
 
-kotlinGradle = "1.9.22"
+kotlinGradle = "1.9.23"
 
 javaDiffUtils = "4.12"
-junit = "5.10.1"
-kotest = "5.8.0"
-kotlinx-bcv = "0.14.0"
+junit = "5.10.2"
+kotest = "5.8.1"
+kotlinx-bcv = "0.15.0-Beta.2"
 
 gradlePluginPublishPlugin = "1.2.1"
 shadowPlugin = "8.1.1"
 devPublish = "0.2.0"
 bcvMu = "main-SNAPSHOT"
 
-supportedGradleVersion = "7.6" # the minimal supported Gradle plugin version, used in functional tests
+supportedGradleVersion = "7.6.4" # the minimal supported Gradle plugin version, used in functional tests
 
 [libraries]