Update to Dokka 2

.github/workflows/ci.yml

@@ -81,4 +81,4 @@ jobs:
 
       - name: Publish snapshot
         if: github.repository == 'slackhq/foundry'
-        run: ./gradlew publish -PmavenCentralUsername=${{ secrets.SONATYPEUSERNAME }} -PmavenCentralPassword=${{ secrets.SONATYPEPASSWORD }} -x dokkaHtml --no-configuration-cache
+        run: ./gradlew publish -PmavenCentralUsername=${{ secrets.SONATYPEUSERNAME }} -PmavenCentralPassword=${{ secrets.SONATYPEPASSWORD }}

.github/workflows/publish-docs.yml

@@ -31,7 +31,7 @@ jobs:
         uses: gradle/actions/setup-gradle@v4
 
       - name: Build Dokka API docs
-        run: dokkaHtml --no-configuration-cache
+        run: :dokkaGenerate
 
       - name: Setup Python
         uses: actions/setup-python@v5

build.gradle.kts

@@ -23,10 +23,10 @@ import dev.bmac.gradle.intellij.PluginUploader
 import dev.bmac.gradle.intellij.UploadPluginTask
 import io.gitlab.arturbosch.detekt.Detekt
 import io.gitlab.arturbosch.detekt.extensions.DetektExtension
-import java.net.URI
 import okio.ByteString.Companion.encode
 import org.gradle.util.internal.VersionNumber
-import org.jetbrains.dokka.gradle.DokkaTaskPartial
+import org.jetbrains.dokka.gradle.DokkaExtension
+import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
 import org.jetbrains.intellij.platform.gradle.extensions.IntelliJPlatformDependenciesExtension
 import org.jetbrains.intellij.platform.gradle.extensions.IntelliJPlatformExtension
 import org.jetbrains.intellij.platform.gradle.tasks.BuildPluginTask
@@ -154,9 +154,20 @@ allprojects {
   }
 }
 
-tasks.dokkaHtmlMultiModule {
-  outputDirectory.set(rootDir.resolve("docs/api/0.x"))
-  includes.from(project.layout.projectDirectory.file("README.md"))
+dokka {
+  dokkaPublications.html {
+    outputDirectory.set(rootDir.resolve("docs/api/0.x"))
+    includes.from(project.layout.projectDirectory.file("README.md"))
+  }
+}
+
+dependencies {
+  dokka(projects.tools.cli)
+  dokka(projects.tools.foundryCommon)
+  dokka(projects.tools.skippy)
+  dokka(projects.tools.tracing)
+  dokka(projects.platforms.gradle.foundryGradlePlugin)
+  dokka(projects.platforms.gradle.agpHandlers.agpHandlerApi)
 }
 
 val kotlinVersion = libs.versions.kotlin.get()
@@ -268,43 +279,37 @@ subprojects {
   pluginManager.withPlugin("com.vanniktech.maven.publish") {
     apply(plugin = "org.jetbrains.dokka")
 
-    tasks.withType<DokkaTaskPartial>().configureEach {
-      outputDirectory.set(layout.buildDirectory.dir("docs/partial"))
+    configure<DokkaExtension> {
+      dokkaPublicationDirectory.set(layout.buildDirectory.dir("dokkaDir"))
       dokkaSourceSets.configureEach {
         val readMeProvider = project.layout.projectDirectory.file("README.md")
         if (readMeProvider.asFile.exists()) {
           includes.from(readMeProvider)
         }
+        documentedVisibilities.add(VisibilityModifier.Public)
         skipDeprecated.set(true)
         if (isForGradle) {
           // Gradle docs
-          externalDocumentationLink {
-            url.set(
-              URI("https://docs.gradle.org/${gradle.gradleVersion}/javadoc/index.html").toURL()
-            )
+          externalDocumentationLinks.register("Gradle") {
+            packageListUrl("https://docs.gradle.org/${gradle.gradleVersion}/javadoc/element-list")
+            url("https://docs.gradle.org/${gradle.gradleVersion}/javadoc")
           }
           // AGP docs
-          externalDocumentationLink {
+          externalDocumentationLinks.register("AGP") {
             val agpVersionNumber = VersionNumber.parse(libs.versions.agp.get()).baseVersion
             val simpleApi = "${agpVersionNumber.major}.${agpVersionNumber.minor}"
-            packageListUrl.set(
-              URI(
-                  "https://developer.android.com/reference/tools/gradle-api/$simpleApi/package-list"
-                )
-                .toURL()
-            )
-            url.set(
-              URI("https://developer.android.com/reference/tools/gradle-api/$simpleApi/classes")
-                .toURL()
+            packageListUrl(
+              "https://developer.android.com/reference/tools/gradle-api/$simpleApi/package-list"
             )
+            url("https://developer.android.com/reference/tools/gradle-api/$simpleApi/classes")
           }
         }
         sourceLink {
-          localDirectory.set(layout.projectDirectory.dir("src").asFile)
+          localDirectory.set(layout.projectDirectory.dir("src"))
           val relPath = rootProject.projectDir.toPath().relativize(projectDir.toPath())
-          remoteUrl.set(
+          remoteUrl(
             providers.gradleProperty("POM_SCM_URL").map { scmUrl ->
-              URI("$scmUrl/tree/main/$relPath/src").toURL()
+              "$scmUrl/tree/main/$relPath/src"
             }
           )
           remoteLineSuffix.set("#L")

deploy_website.sh

@@ -23,7 +23,7 @@ if ! [[ ${local} || ${ci} ]]; then
   # Move working directory into temp folder
   cd ${DIR}
   # Generate the API docs
-  ./gradlew dokkaHtmlMultiModule --no-configuration-cache
+  ./gradlew :dokkaGenerate
 fi
 
 # Copy in special files that GitHub wants in the project root.

gradle.properties

@@ -29,6 +29,10 @@ kotlin.compiler.preciseCompilationResultsBackup=true
 
 moshix.generateProguardRules=false
 
+# Dokka flags
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
+org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
+
 ksp.useKSP2=true
 
 # The IJ platform gradle plugin does this silly thing where it checks for updates at configuration-time

gradle/libs.versions.toml

@@ -13,7 +13,7 @@ coroutines = "1.9.0"
 coroutines-ij = "1.9.0"
 dependencyAnalysisPlugin = "2.1.4"
 detekt = "1.23.7"
-dokka = "1.9.20"
+dokka = "2.0.0-Beta"
 errorproneGradle = "4.0.1"
 gradle-retry = "1.6.0"
 graph-assert = "2.7.1"

release.sh

@@ -19,7 +19,7 @@ git commit -am "Prepare for release $NEW_VERSION."
 git tag -a "$NEW_VERSION" -m "Version $NEW_VERSION"
 
 # Publish
-./gradlew publish -x dokkaHtml --no-configuration-cache -PSONATYPE_CONNECT_TIMEOUT_SECONDS=300
+./gradlew publish --no-configuration-cache -PSONATYPE_CONNECT_TIMEOUT_SECONDS=300
 
 # Prepare next snapshot
 echo "Restoring snapshot version $SNAPSHOT_VERSION"