use git-tag based versioning, use dev-publish-plugin (replacing maven-publish-test.gradle.kts), tidy up functional tests, exclusive-filter DevMavenRepo, tidy up & update buildscript config

Author: aSemy

build.gradle.kts

@@ -1,20 +1,24 @@
-import buildsrc.utils.excludeGeneratedGradleDsl
+import buildsrc.utils.generatedKotlinDslAccessorDirs
 
 plugins {
   buildsrc.conventions.base
   idea
 }
 
 group = "dev.adamko.kotlin.binary_compatibility_validator"
-version = "0.2.0-SNAPSHOT"
+project.version = object {
+  private val gitVersion = project.gitVersion
+  override fun toString(): String = gitVersion.get()
+}
 
 idea {
   module {
-    excludeGeneratedGradleDsl(layout)
-    excludeDirs = excludeDirs + layout.files(
-      ".idea",
-      "gradle/wrapper",
-    )
+    excludeDirs = excludeDirs +
+        layout.generatedKotlinDslAccessorDirs() +
+        layout.files(
+          ".idea",
+          "gradle/wrapper",
+        )
   }
 }
 
@@ -42,3 +46,14 @@ val readmeCheck by tasks.registering {
 tasks.check {
   dependsOn(readmeCheck)
 }
+
+val projectVersion by tasks.registering {
+  description = "prints the project version"
+  group = "help"
+  val version = providers.provider { project.version }
+  inputs.property("version", version)
+  outputs.cacheIf("logging task, it should always run") { false }
+  doLast {
+    logger.quiet("${version.orNull}")
+  }
+}

buildSrc/build.gradle.kts

@@ -10,6 +10,7 @@ dependencies {
   implementation(libs.gradlePlugin.bcvMu)
   implementation(libs.gradlePlugin.pluginPublishing)
   implementation(libs.gradlePlugin.shadow)
+  implementation(libs.gradlePlugin.devPublish)
 }
 
 java {

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

@@ -1,36 +1,97 @@
 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.get
+import org.gradle.kotlin.dsl.*
+import org.gradle.util.GradleVersion
+
+
+/** The current Gradle version */
+internal val CurrentGradleVersion: GradleVersion
+  get() = GradleVersion.current()
+
+
+/** @see GradleVersion.compareTo */
+internal operator fun GradleVersion.compareTo(version: String): Int =
+  compareTo(GradleVersion.version(version))
+
+
+/**
+ * Mark this [Configuration] as one that should be used to declare dependencies in
+ * [Project.dependencies] block.
+ *
+ * Declarable Configurations should be extended by [resolvable] and [consumable] Configurations.
+ *
+ * ```
+ * isCanBeResolved = false
+ * isCanBeConsumed = false
+ * isCanBeDeclared = true
+ * ```
+ */
+internal fun Configuration.declarable(
+  visible: Boolean = false,
+) {
+  isCanBeResolved = false
+  isCanBeConsumed = false
+  canBeDeclared(true)
+  isVisible = visible
+}
+
 
 /**
  * Mark this [Configuration] as one that will be consumed by other subprojects.
  *
  * ```
  * isCanBeResolved = false
  * isCanBeConsumed = true
+ * isCanBeDeclared = false
  * ```
  */
-fun Configuration.asProvider() {
+internal fun Configuration.consumable(
+  visible: Boolean = true,
+) {
   isCanBeResolved = false
   isCanBeConsumed = true
+  canBeDeclared(false)
+  isVisible = visible
 }
 
+
 /**
  * Mark this [Configuration] as one that will consume artifacts from other subprojects (also known as 'resolving')
  *
  * ```
  * isCanBeResolved = true
  * isCanBeConsumed = false
+ * isCanBeDeclared = false
  * ```
- * */
-fun Configuration.asConsumer() {
+ */
+internal fun Configuration.resolvable(
+  visible: Boolean = false,
+) {
   isCanBeResolved = true
   isCanBeConsumed = false
+  canBeDeclared(false)
+  isVisible = visible
+}
+
+
+/**
+ * Enable/disable [Configuration.isCanBeDeclared] only if it is supported by the
+ * [CurrentGradleVersion]
+ *
+ * This function should be removed when the minimal supported Gradle version is 8.2.
+ */
+@Suppress("UnstableApiUsage")
+private fun Configuration.canBeDeclared(value: Boolean) {
+  if (CurrentGradleVersion >= "8.2") {
+    isCanBeDeclared = value
+  }
 }
 
 
@@ -81,3 +142,19 @@ 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,23 +1,4 @@
 package buildsrc.utils
 
+import java.io.File
 import org.gradle.api.file.ProjectLayout
-import org.gradle.plugins.ide.idea.model.IdeaModule
-
-
-/** exclude generated Gradle code, so it doesn't clog up search results */
-fun IdeaModule.excludeGeneratedGradleDsl(layout: ProjectLayout) {
-
-  val generatedSrcDirs = listOf(
-    "kotlin-dsl-accessors",
-    "kotlin-dsl-external-plugin-spec-builders",
-    "kotlin-dsl-plugins",
-  )
-
-  excludeDirs.addAll(
-    layout.projectDirectory.asFile.walk()
-      .filter { it.isDirectory && it.parentFile.name in generatedSrcDirs }
-      .flatMap { file ->
-        file.walk().maxDepth(1).filter { it.isDirectory }.toList()
-      }
-  )
-}

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

@@ -9,7 +9,9 @@ kotlinx-bcv = "0.13.2"
 
 gradlePluginPublishPlugin = "1.2.0"
 shadowPlugin = "8.1.0"
+devPublish = "0.2.0"
 bcvMu = "0.0.3"
+#bcvMu = "0.2.0-SNAPSHOT"
 
 supportedGradleVersion = "7.6" # the minimal supported Gradle plugin version, used in functional tests
 
@@ -35,4 +37,5 @@ junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "jun
 gradlePlugin-bcvMu = { module = "dev.adamko.kotlin.binary_compatibility_validator:bcv-gradle-plugin", version.ref = "bcvMu" }
 gradlePlugin-pluginPublishing = { module = "com.gradle.publish:plugin-publish-plugin", version.ref = "gradlePluginPublishPlugin" }
 gradlePlugin-shadow = { module = "com.github.johnrengelman:shadow", version.ref = "shadowPlugin" }
+gradlePlugin-devPublish = { module = "dev.adamko.gradle:dev-publish-plugin", version.ref = "devPublish" }
 ## endregion

gradle/libs.versions.toml

@@ -1,14 +1,14 @@
 plugins {
   buildsrc.conventions.`kotlin-gradle-plugin-tests`
-  buildsrc.conventions.`maven-publish-test`
+  id("dev.adamko.dev-publish")
   `java-test-fixtures`
   `jvm-test-suite`
 }
 
 description = "Functional tests for bcv-gradle-plugin"
 
 dependencies {
-  testMavenPublication(projects.modules.bcvGradlePlugin)
+  devPublication(projects.modules.bcvGradlePlugin)
 
   testFixturesApi(gradleTestKit())
 
@@ -52,10 +52,11 @@ testing.suites {
     targets.configureEach {
       testTask.configure {
         shouldRunAfter(test)
-        dependsOn(project.configurations.testMavenPublication)
-        inputs.files(project.configurations.testMavenPublication)
-
-        systemProperty("testMavenRepoDir", file(mavenPublishTest.testMavenRepo).canonicalPath)
+        dependsOn(tasks.updateDevRepo)
+        systemProperty(
+          "devMavenRepoDir",
+          devPublish.devMavenRepo.asFile.get().invariantSeparatorsPath,
+        )
       }
     }
   }

modules/bcv-gradle-plugin-functional-tests/build.gradle.kts

@@ -125,7 +125,7 @@ private fun FunSpec.createTestFixturesProject(
     buildGradleKts = """
         |plugins {
         |  kotlin("jvm") version "1.7.10"
-        |  id("dev.adamko.kotlin.binary-compatibility-validator") version "0.2.0-SNAPSHOT"
+        |  id("dev.adamko.kotlin.binary-compatibility-validator") version "+"
         |  `java-test-fixtures`
         |}
         |

modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/JavaTestFixturesTest.kt

@@ -152,9 +152,8 @@ buildscript {
   }
 }
 
-
 plugins {
-  id("dev.adamko.kotlin.binary-compatibility-validator") version "0.2.0-SNAPSHOT"
+  id("dev.adamko.kotlin.binary-compatibility-validator") version "+"
 }
 
 include(

modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/SettingsPluginDslTest.kt

@@ -1,6 +1,6 @@
 plugins {
   id("com.android.library")
-  id("dev.adamko.kotlin.binary-compatibility-validator") version "0.2.0-SNAPSHOT"
+  id("dev.adamko.kotlin.binary-compatibility-validator") version "+"
 }
 
 android {