misc: upgrade to Dokka 2.0.0 (#1284)

Author: lauzadis

.changes/50a9ce20-c4d7-4952-8fad-f9ffb38c9259.json

@@ -0,0 +1,5 @@
+{
+    "id": "50a9ce20-c4d7-4952-8fad-f9ffb38c9259",
+    "type": "misc",
+    "description": "Upgrade to Dokka 2.0.0"
+}

.editorconfig

@@ -9,4 +9,4 @@ ktlint_standard_backing-property-naming = disabled
 # enable trailing commas per JetBrains recommendation
 # (https://kotlinlang.org/docs/coding-conventions.html#trailing-commas)
 ij_kotlin_allow_trailing_comma_on_call_site = true
-ij_kotlin_allow_trailing_comma = true
+ij_kotlin_allow_trailing_comma = true

build.gradle.kts

@@ -18,13 +18,13 @@ buildscript {
 }
 
 plugins {
-    alias(libs.plugins.dokka)
+    `dokka-convention`
     alias(libs.plugins.kotlinx.binary.compatibility.validator)
+    alias(libs.plugins.aws.kotlin.repo.tools.artifactsizemetrics)
     // ensure the correct version of KGP ends up on our buildscript classpath
     // since build-plugins also has <some> version in its dependency closure
-    alias(libs.plugins.kotlin.multiplatform) apply false
-    alias(libs.plugins.kotlin.jvm) apply false
-    alias(libs.plugins.aws.kotlin.repo.tools.artifactsizemetrics)
+    id(libs.plugins.kotlin.multiplatform.get().pluginId) apply false
+    id(libs.plugins.kotlin.jvm.get().pluginId) apply false
 }
 
 artifactSizeMetrics {
@@ -40,35 +40,9 @@ val testJavaVersion = typedProp<String>("test.java.version")?.let {
 }
 
 allprojects {
-    tasks.withType<org.jetbrains.dokka.gradle.AbstractDokkaTask>().configureEach {
-        val sdkVersion: String by project
-        moduleVersion.set(sdkVersion)
-
-        val year = java.time.LocalDate.now().year
-        val pluginConfigMap = mapOf(
-            "org.jetbrains.dokka.base.DokkaBase" to """
-                {
-                    "customStyleSheets": [
-                        "${rootProject.file("docs/dokka-presets/css/logo-styles.css")}",
-                        "${rootProject.file("docs/dokka-presets/css/aws-styles.css")}"
-                    ],
-                    "customAssets": [
-                        "${rootProject.file("docs/dokka-presets/assets/logo-icon.svg")}",
-                        "${rootProject.file("docs/dokka-presets/assets/aws_logo_white_59x35.png")}",
-                        "${rootProject.file("docs/dokka-presets/scripts/accessibility.js")}"
-                    ],
-                    "footerMessage": "© $year, Amazon Web Services, Inc. or its affiliates. All rights reserved.",
-                    "separateInheritedMembers" : true,
-                    "templatesDir": "${rootProject.file("docs/dokka-presets/templates")}"
-                }
-            """,
-        )
-        pluginsMapConfiguration.set(pluginConfigMap)
-    }
-
     if (rootProject.typedProp<Boolean>("kotlinWarningsAsErrors") == true) {
         tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
-            kotlinOptions.allWarningsAsErrors = true
+            compilerOptions.allWarningsAsErrors = true
         }
     }
 
@@ -90,27 +64,18 @@ allprojects {
 }
 
 // configure the root multimodule docs
-tasks.dokkaHtmlMultiModule.configure {
+dokka {
     moduleName.set("Smithy Kotlin")
 
-    // Output subprojects' docs to <docs-base>/project-name/* instead of <docs-base>/path/to/project-name/*
-    // This is especially important for inter-repo linking (e.g., via externalDocumentationLink) because the
-    // package-list doesn't contain enough project path information to indicate where modules' documentation are
-    // located.
-    fileLayout.set { parent, child ->
-        parent.outputDirectory.dir(child.moduleName)
+    dokkaPublications.html {
+        includes.from(
+            rootProject.file("docs/dokka-presets/README.md"),
+        )
     }
+}
 
-    includes.from(
-        // NOTE: these get concatenated
-        rootProject.file("docs/dokka-presets/README.md"),
-    )
-
-    val excludeFromDocumentation = listOf(
-        project(":runtime:testing"),
-        project(":runtime:smithy-test"),
-    )
-    removeChildTasks(excludeFromDocumentation)
+dependencies {
+    dokka(project(":runtime"))
 }
 
 // Publishing
@@ -121,6 +86,7 @@ val lintPaths = listOf(
     "**/*.{kt,kts}",
     "!**/generated-src/**",
     "!**/smithyprojections/**",
+    "!**/build/**",
 )
 
 configureLinting(lintPaths)

buildSrc/build.gradle.kts

@@ -0,0 +1,13 @@
+plugins {
+    `kotlin-dsl`
+}
+
+repositories {
+    mavenCentral()
+    gradlePluginPortal()
+}
+
+dependencies {
+    implementation(libs.dokka.gradle.plugin)
+    implementation(libs.kotlin.gradle.plugin)
+}

buildSrc/settings.gradle.kts

@@ -0,0 +1,9 @@
+rootProject.name = "buildSrc"
+
+dependencyResolutionManagement {
+    versionCatalogs {
+        create("libs") {
+            from(files("../gradle/libs.versions.toml"))
+        }
+    }
+}

buildSrc/src/main/kotlin/dokka-convention.gradle.kts

@@ -0,0 +1,30 @@
+import kotlin.text.set
+
+plugins {
+    id("org.jetbrains.dokka")
+}
+
+dokka {
+    val sdkVersion: String by project
+    moduleVersion.set(sdkVersion)
+
+    pluginsConfiguration.html {
+        customStyleSheets.from(
+            rootProject.file("docs/dokka-presets/css/aws-styles.css"),
+        )
+
+        customAssets.from(
+            rootProject.file("docs/dokka-presets/assets/logo-icon.svg"),
+            rootProject.file("docs/dokka-presets/scripts/accessibility.js"),
+        )
+
+        templatesDir.set(rootProject.file("docs/dokka-presets/templates"))
+
+        footerMessage.set("© ${java.time.LocalDate.now().year}, Amazon Web Services, Inc. or its affiliates. All rights reserved.")
+        separateInheritedMembers.set(true)
+    }
+}
+
+dependencies {
+    dokkaPlugin(project(":dokka-smithy"))
+}

codegen/smithy-aws-kotlin-codegen/build.gradle.kts

@@ -7,7 +7,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-    alias(libs.plugins.kotlin.jvm)
+    id(libs.plugins.kotlin.jvm.get().pluginId)
     jacoco
     `maven-publish`
 }

codegen/smithy-kotlin-codegen-testutils/build.gradle.kts

@@ -7,7 +7,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-    alias(libs.plugins.kotlin.jvm)
+    id(libs.plugins.kotlin.jvm.get().pluginId)
     jacoco
     `maven-publish`
 }

codegen/smithy-kotlin-codegen/build.gradle.kts

@@ -7,7 +7,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-    alias(libs.plugins.kotlin.jvm)
+    id(libs.plugins.kotlin.jvm.get().pluginId)
     jacoco
     `maven-publish`
 }