[K2] Run unit tests against the latest Analysis API

Kotlin · Mar 28, 2024 · aba29f5 · aba29f5
1 parent 31ec638
commit aba29f5
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/build-logic/src/main/kotlin/dokkabuild/DokkaBuildProperties.kt b/build-logic/src/main/kotlin/dokkabuild/DokkaBuildProperties.kt
@@ -25,6 +25,13 @@ abstract class DokkaBuildProperties @Inject constructor(
     private val layout: ProjectLayout,
 ) {
 
+    /**
+     * The latest version of Analysis API should be used to build the Dokka
+     */
+    val useTheLatestAnalysisAPI: Provider<Boolean> =
+        dokkaProperty("build.useTheLatestAnalysisAPI", String::toBoolean)
+            .orElse(false)
+
     private val buildingOnTeamCity: Provider<Boolean> =
         providers.environmentVariable("TEAMCITY_VERSION").map(String::isNotBlank)
 

diff --git a/dokka-subprojects/analysis-kotlin-symbols/README.md b/dokka-subprojects/analysis-kotlin-symbols/README.md
@@ -16,3 +16,8 @@ The `.jar` produced by this project shadows all dependencies. There are several
 2. There are many intertwining transitive dependencies of different versions, as well as direct copy-paste,
    that can lead to runtime errors due to classpath conflicts, so it's best to let Gradle take care of
    dependency resolution, and then pack everything into a single jar in a single place that can be tuned.
+
+## Testing with the latest version of Analysis API
+
+To build it with the latest version of Analysis API, the property 
+`org.jetbrains.dokka.build.useTheLatestAnalysisAPI=true` should be added to the project.
diff --git a/dokka-subprojects/analysis-kotlin-symbols/build.gradle.kts b/dokka-subprojects/analysis-kotlin-symbols/build.gradle.kts
@@ -140,3 +140,16 @@ tasks.shadowJar {
     configurations = emptyList()
     from(shadowOverride, shadowDependenciesJar)
 }
+
+// for testing with the latest version of Analysis API
+if (dokkaBuild.useTheLatestAnalysisAPI.get()) {
+    project.logger.lifecycle("Using the latest version of Analysis API")
+    configurations.all {
+        resolutionStrategy.eachDependency {
+            if (requested.version == libs.versions.kotlin.compiler.k2.get()) {
+                useVersion(libs.versions.kotlin.compiler.latest.get())
+                because("unit testing can use the latest version of Analysis API")
+            }
+        }
+    }
+}
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -16,6 +16,9 @@ kotlinx-bcv = "0.13.2"
 ## Analysis
 kotlin-compiler = "1.9.22"
 kotlin-compiler-k2 = "2.0.20-dev-7"
+# to run testing against the latest dev build of Analysis API
+# it is used in the build script of symbol analysis
+kotlin-compiler-latest = "2.0.20-dev-+"
 
 # MUST match the version of the intellij platform used in the kotlin compiler,
 # otherwise this will lead to different versions of psi API and implementations