Update to dokka v2 (#317)

* Update to dokka v2

* Fix a warning

Author: ansman

.github/workflows/gradle.yml

@@ -20,7 +20,7 @@ jobs:
     - uses: actions/setup-java@v3
       with:
         distribution: 'zulu'
-        java-version: '21'
+        java-version: '23'
 
     - uses: actions/setup-python@v5
       with:

.github/workflows/pages.yml

@@ -22,7 +22,7 @@ jobs:
       - uses: actions/setup-java@v3
         with:
           distribution: 'zulu'
-          java-version: '21'
+          java-version: '23'
 
       - uses: actions/setup-python@v5
         with:

.github/workflows/update-gradle-wrapper.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/setup-java@v3
         with:
           distribution: 'zulu'
-          java-version: '21'
+          java-version: '23'
 
       - uses: actions/setup-python@v5
         with:

build-logic/build.gradle.kts

@@ -1,10 +1,31 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
 plugins {
     kotlin("jvm") version embeddedKotlinVersion
     `kotlin-dsl`
     `version-catalog`
     alias(libs.plugins.projectAccessors)
 }
 
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(libs.versions.java.get())
+        vendor.set(JvmVendorSpec.AZUL)
+    }
+    sourceCompatibility = JavaVersion.VERSION_22
+    targetCompatibility = sourceCompatibility
+}
+
+kotlin {
+    jvmToolchain {
+        languageVersion.set(JavaLanguageVersion.of(libs.versions.java.get()))
+        vendor.set(JvmVendorSpec.AZUL)
+    }
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_22)
+    }
+}
+
 dependencies {
     implementation(files(libs.javaClass.superclass.protectionDomain.codeSource.location))
     implementation(libs.projectAccessors)
@@ -14,4 +35,5 @@ dependencies {
     api(libs.testLogger)
     api(libs.kotlin.jvm.gradle)
     api(libs.sonatypePublishFix)
+    api(libs.ksp.gradlePlugin)
 }

build-logic/src/main/kotlin/dokka-common.gradle.kts

@@ -1,12 +1,19 @@
-
-import org.gradle.accessors.dm.LibrariesForLibs
+import com.google.devtools.ksp.gradle.KspAATask
 
 plugins {
     id("org.jetbrains.dokka")
+    id("org.jetbrains.dokka-javadoc")
 }
 
-val libs = the<LibrariesForLibs>()
-
-dependencies {
-    dokkaPlugin(libs.dokka.versioningPlugin)
+dokka {
+    dokkaSourceSets.configureEach {
+        suppressGeneratedFiles = true
+        tasks.withType<KspAATask>().configureEach {
+            suppressedFiles.from(fileTree(kspConfig.outputBaseDir))
+        }
+        perPackageOption {
+            matchingRegex = "hilt_aggregated_deps*"
+            suppress = true
+        }
+    }
 }

build-logic/src/main/kotlin/library.gradle.kts

@@ -10,6 +10,7 @@ import com.android.build.api.variant.HasTestFixturesBuilder
 import com.android.build.api.variant.HasUnitTestBuilder
 import org.gradle.accessors.dm.LibrariesForLibs
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 val libs = the<LibrariesForLibs>()
@@ -121,6 +122,12 @@ pluginManager.withPlugin("org.jetbrains.kotlin.jvm") {
     tasks.withType<Test>().configureEach {
         useJUnitPlatform()
     }
+    configure<KotlinJvmProjectExtension> {
+        jvmToolchain {
+            languageVersion.set(JavaLanguageVersion.of(libs.versions.java.get()))
+            vendor.set(JvmVendorSpec.AZUL)
+        }
+    }
     dependencies {
         "testImplementation"(libs.bundles.jvmTesting)
     }
@@ -130,7 +137,7 @@ pluginManager.withPlugin("org.jetbrains.kotlin.jvm") {
 plugins.withType<JavaBasePlugin>().configureEach {
     extensions.configure<JavaPluginExtension> {
         toolchain {
-            languageVersion.set(JavaLanguageVersion.of(21))
+            languageVersion.set(JavaLanguageVersion.of(libs.versions.java.get()))
             vendor.set(JvmVendorSpec.AZUL)
         }
     }

build-logic/src/main/kotlin/library.publishing.gradle.kts

@@ -2,8 +2,6 @@
 import com.android.build.gradle.LibraryExtension
 import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import org.gradle.accessors.dm.LibrariesForLibs
-import org.jetbrains.dokka.gradle.AbstractDokkaLeafTask
-import se.ansman.dagger.auto.gradle.cachedProvider
 import se.ansman.dagger.auto.gradle.execWithOutput
 import se.ansman.dagger.auto.gradle.mapNullable
 
@@ -16,12 +14,13 @@ plugins {
 
 val libs = the<LibrariesForLibs>()
 
-val gitCommit = cachedProvider {
-    project.execWithOutput {
+val gitCommit = project
+    .execWithOutput {
         commandLine("git", "rev-parse", "HEAD")
         workingDir = project.rootDir
-    }.trim()
-}
+    }
+    .map { it.trim() }
+
 
 fun repo(path: String = "") = "https://github.com/ansman/auto-dagger$path"
 
@@ -30,20 +29,17 @@ val remoteSource: Provider<String> = providers.gradleProperty("version")
     .orElse(gitCommit)
     .map { repo("/blob/$it") }
 
-tasks.withType<AbstractDokkaLeafTask>().configureEach {
+dokka {
     val projectPath = project.path.removePrefix(":").replace(':', '/')
     dokkaSourceSets.configureEach {
         reportUndocumented.set(false)
         sourceLink {
             localDirectory.set(project.file("src/main/kotlin"))
             remoteUrl.set(remoteSource.map { remoteSource ->
-                uri("$remoteSource/$projectPath/src/main/kotlin").toURL()
+                uri("$remoteSource/$projectPath/src/main/kotlin")
             })
             remoteLineSuffix.set("#L")
         }
-        externalDocumentationLink(
-            url = "https://javadoc.io/doc/com.google.dagger/dagger/${libs.versions.dagger}/",
-        )
     }
 }
 
@@ -92,7 +88,7 @@ tasks.register("publishSnapshot") {
 }
 
 val javadocJar by tasks.registering(Jar::class) {
-    from(tasks.dokkaJavadoc)
+    from(tasks.dokkaGeneratePublicationJavadoc)
     archiveClassifier.set("javadoc")
 }
 

build-logic/src/main/kotlin/se/ansman/dagger/auto/gradle/utils.kt

@@ -6,20 +6,16 @@ import org.gradle.api.provider.Provider
 import org.gradle.process.ExecSpec
 import java.io.ByteArrayOutputStream
 
-internal fun Project.execWithOutput(configure: ExecSpec.() -> Unit): String {
-    val output = ByteArrayOutputStream()
-    project
-        .exec {
-            configure()
-            standardOutput = output
+internal fun Project.execWithOutput(configure: ExecSpec.() -> Unit): Provider<String> =
+    project.providers
+        .exec(configure)
+        .run {
+            result.flatMap {
+                it.assertNormalExitValue()
+                it.rethrowFailure()
+                standardOutput.asText
+            }
         }
-        .assertNormalExitValue()
-        .rethrowFailure()
-    return output.toByteArray().toString(Charsets.UTF_8)
-}
-
-internal fun <T> Project.cachedProvider(producer: () -> T): Provider<T> =
-    provider(lazy(producer)::value)
 
 internal fun ExtraPropertiesExtension.getOrPut(name: String, block: () -> String): String =
     if (has(name)) get(name) as String else block().also { set(name, it) }

build.gradle.kts

@@ -1,6 +1,5 @@
-import org.jetbrains.dokka.gradle.DokkaMultiModuleTask
-import org.jetbrains.dokka.versioning.VersioningConfiguration
-import org.jetbrains.dokka.versioning.VersioningPlugin
+@file:Suppress("UnstableApiUsage")
+
 import ru.vyarus.gradle.plugin.python.task.BasePythonTask
 
 plugins {
@@ -31,6 +30,7 @@ val latestRelease: String = providers.gradleProperty("latestRelease").get()
 
 val isSnapshotVersion = version.endsWith("-SNAPSHOT")
 val dokkaProjects = subprojects
+    .map { it.isolated }
     .filter { ":compiler" !in it.path && ":tests" !in it.path }
     .toSet()
 
@@ -49,7 +49,9 @@ apiValidation {
         )
     )
     ignoredProjects.addAll(
-        subprojects.asSequence()
+        subprojects
+            .map { it.isolated }
+            .asSequence()
             .minus(dokkaProjects)
             .map { it.name }
     )
@@ -92,7 +94,7 @@ mkdocs {
 
 gitPublish {
     contents {
-        from(tasks.dokkaHtmlMultiModule.map { it.outputDirectory }) {
+        from(tasks.dokkaGeneratePublicationHtml.map { it.outputDirectory }) {
             into(dokkaDocsPath)
         }
     }
@@ -117,41 +119,45 @@ tasks.mkdocsBuild {
 }
 
 tasks.gitPublishReset {
-    dependsOn(tasks.dokkaHtmlMultiModule)
+    dependsOn(tasks.dokkaGeneratePublicationHtml)
 }
 
 python {
     virtualenvVersion = "20.16.7"
 }
 
-tasks.register("check") {
+tasks.check {
     dependsOn(*gradle.includedBuilds.map { it.task(":check") }.toTypedArray())
     dependsOn(tasks.mkdocsBuild)
 }
 
-tasks.register<Delete>("clean") {
-    delete(layout.buildDirectory)
-}
-
 val olderVersionsFolder = file("src/doc/dokka/")
-val versionCurrentDocs by tasks.registering(DokkaMultiModuleTask::class) {
+tasks.register<Copy>("versionCurrentDocs") {
     enabled = !isSnapshotVersion
-    outputDirectory.set(olderVersionsFolder.resolve(version))
-    pluginConfiguration<VersioningPlugin, VersioningConfiguration> {
-        version = providers.gradleProperty("version").get()
-    }
-    addChildTasks(dokkaProjects, "dokkaHtmlPartial")
+    from(tasks.dokkaGeneratePublicationHtml)
+    into(olderVersionsFolder.resolve(version))
+    exclude("older")
 }
 
 dependencies {
     dokkaPlugin(libs.dokka.allModulesPagePlugin)
-}
-
-tasks.dokkaHtmlMultiModule {
-    removeChildTasks(subprojects - dokkaProjects)
-    pluginConfiguration<VersioningPlugin, VersioningConfiguration> {
-        version = providers.gradleProperty("version").get()
-        olderVersionsDir = olderVersionsFolder
+    dokkaPlugin(libs.dokka.versioningPlugin)
+    dokka(projects.android)
+    dokka(projects.android.api)
+    dokka(projects.android.testing)
+    dokka(projects.core)
+    dokka(projects.thirdParty.androidx.room)
+    dokka(projects.thirdParty.androidx.viewmodel)
+    dokka(projects.thirdParty.ktorfit)
+    dokka(projects.thirdParty.retrofit)
+}
+
+dokka {
+    pluginsConfiguration {
+        versioning {
+            version = providers.gradleProperty("version").get()
+            olderVersionsDir = olderVersionsFolder
+        }
     }
 }
 

gradle.properties

@@ -4,6 +4,8 @@ org.gradle.vfs.watch=true
 org.gradle.caching=true
 org.gradle.configuration.cache=true
 org.gradle.configuration-cache.parallel=true
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
+org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
 
 kotlin.code.style=official