From 06214acc95b644085bf2b303c5b83ba3c69ba0d0 Mon Sep 17 00:00:00 2001 From: Matas Lauzadis Date: Wed, 11 Dec 2024 12:22:13 -0500 Subject: [PATCH 1/8] Docs are getting generated --- build.gradle.kts | 65 ++++++------------- buildSrc/build.gradle.kts | 13 ++++ buildSrc/settings.gradle.kts | 9 +++ .../main/kotlin/dokka-convention.gradle.kts | 46 +++++++++++++ .../build.gradle.kts | 2 +- .../build.gradle.kts | 2 +- .../smithy-kotlin-codegen/build.gradle.kts | 2 +- docs/dokka-presets/README.md | 2 +- dokka-smithy/build.gradle.kts | 2 +- gradle.properties | 4 +- gradle/libs.versions.toml | 8 ++- runtime/build.gradle.kts | 26 ++++++-- .../nullability-tests/build.gradle.kts | 2 +- .../codegen/paginator-tests/build.gradle.kts | 2 +- tests/codegen/serde-tests/build.gradle.kts | 2 +- tests/codegen/waiter-tests/build.gradle.kts | 2 +- 16 files changed, 124 insertions(+), 65 deletions(-) create mode 100644 buildSrc/build.gradle.kts create mode 100644 buildSrc/settings.gradle.kts create mode 100644 buildSrc/src/main/kotlin/dokka-convention.gradle.kts diff --git a/build.gradle.kts b/build.gradle.kts index ab17214cd..1ec5da06a 100644 --- a/build.gradle.kts +++ b/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 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,32 +40,6 @@ val testJavaVersion = typedProp("test.java.version")?.let { } allprojects { - tasks.withType().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("kotlinWarningsAsErrors") == true) { tasks.withType { kotlinOptions.allWarningsAsErrors = true @@ -90,27 +64,26 @@ allprojects { } // configure the root multimodule docs -tasks.dokkaHtmlMultiModule.configure { +dokka { moduleName.set("Smithy Kotlin") - // Output subprojects' docs to /project-name/* instead of /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"), - ) +// // Output subprojects' docs to /project-name/* instead of /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) +// } +} - val excludeFromDocumentation = listOf( - project(":runtime:testing"), - project(":runtime:smithy-test"), - ) - removeChildTasks(excludeFromDocumentation) +dependencies { + dokka(project(":runtime")) } // Publishing diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts new file mode 100644 index 000000000..306b0211a --- /dev/null +++ b/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) +} diff --git a/buildSrc/settings.gradle.kts b/buildSrc/settings.gradle.kts new file mode 100644 index 000000000..cd7c4b9af --- /dev/null +++ b/buildSrc/settings.gradle.kts @@ -0,0 +1,9 @@ +rootProject.name = "buildSrc" + +dependencyResolutionManagement { + versionCatalogs { + create("libs") { + from(files("../gradle/libs.versions.toml")) + } + } +} \ No newline at end of file diff --git a/buildSrc/src/main/kotlin/dokka-convention.gradle.kts b/buildSrc/src/main/kotlin/dokka-convention.gradle.kts new file mode 100644 index 000000000..a66e6142c --- /dev/null +++ b/buildSrc/src/main/kotlin/dokka-convention.gradle.kts @@ -0,0 +1,46 @@ +import kotlin.text.set + +plugins { + id("org.jetbrains.dokka") +} + +dokka { + val sdkVersion: String by project + moduleVersion.set(sdkVersion) + moduleName.set("Smithy Kotlin") + + pluginsConfiguration.html { + customStyleSheets.from( + rootProject.file("docs/dokka-presets/css/logo-styles.css"), + 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/assets/aws_logo_white_59x35.png"), + rootProject.file("docs/dokka-presets/scripts/accessibility.js") + ) + + footerMessage.set("© ${java.time.LocalDate.now().year}, Amazon Web Services, Inc. or its affiliates. All rights reserved.") + separateInheritedMembers.set(true) + templatesDir.set(rootProject.file("docs/dokka-presets/templates")) + } + + dokkaPublications.html { + includes.from( + rootProject.file("docs/dokka-presets/README.md") + ) + } + +// // Output subprojects' docs to /project-name/* instead of /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) +// } +} + +dependencies { + dokkaPlugin(project(":dokka-smithy")) +} \ No newline at end of file diff --git a/codegen/smithy-aws-kotlin-codegen/build.gradle.kts b/codegen/smithy-aws-kotlin-codegen/build.gradle.kts index 96a7442a5..00b0b1f88 100644 --- a/codegen/smithy-aws-kotlin-codegen/build.gradle.kts +++ b/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` } diff --git a/codegen/smithy-kotlin-codegen-testutils/build.gradle.kts b/codegen/smithy-kotlin-codegen-testutils/build.gradle.kts index 3bd714fb6..b24f9ac8b 100644 --- a/codegen/smithy-kotlin-codegen-testutils/build.gradle.kts +++ b/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` } diff --git a/codegen/smithy-kotlin-codegen/build.gradle.kts b/codegen/smithy-kotlin-codegen/build.gradle.kts index 0381edb03..0ac6c27c6 100644 --- a/codegen/smithy-kotlin-codegen/build.gradle.kts +++ b/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` } diff --git a/docs/dokka-presets/README.md b/docs/dokka-presets/README.md index e1e6c1a8f..b7b789deb 100644 --- a/docs/dokka-presets/README.md +++ b/docs/dokka-presets/README.md @@ -1 +1 @@ -# Smithy Kotlin API Reference +# Module Smithy Kotlin API Reference diff --git a/dokka-smithy/build.gradle.kts b/dokka-smithy/build.gradle.kts index 3126e0a24..5725d3ea5 100644 --- a/dokka-smithy/build.gradle.kts +++ b/dokka-smithy/build.gradle.kts @@ -9,7 +9,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget * SPDX-License-Identifier: Apache-2.0 */ plugins { - alias(libs.plugins.kotlin.jvm) + id(libs.plugins.kotlin.jvm.get().pluginId) } description = "Custom Dokka plugin for Kotlin Smithy SDK API docs" diff --git a/gradle.properties b/gradle.properties index 8639149e0..57851b6e4 100644 --- a/gradle.properties +++ b/gradle.properties @@ -16,4 +16,6 @@ org.gradle.jvmargs=-Xmx2G -XX:MaxMetaspaceSize=1G sdkVersion=1.3.29-SNAPSHOT # codegen -codegenVersion=0.33.29-SNAPSHOT \ No newline at end of file +codegenVersion=0.33.29-SNAPSHOT + +org.jetbrains.dokka.experimental.gradle.pluginMode=V2EnabledWithHelpers diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 0683bfc2e..b92973d3e 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -1,6 +1,6 @@ [versions] kotlin-version = "2.0.21" -dokka-version = "1.9.10" +dokka-version = "2.0.0-Beta" aws-kotlin-repo-tools-version = "0.4.16" @@ -34,12 +34,14 @@ jsoup-version = "1.18.1" [libraries] aws-kotlin-repo-tools-build-support = { module="aws.sdk.kotlin.gradle:build-support", version.ref = "aws-kotlin-repo-tools-version" } +kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin-version" } kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib", version.ref = "kotlin-version"} kotlin-stdlib-jdk8 = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin-version"} kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin-version" } kotlin-test-junit5 = { module = "org.jetbrains.kotlin:kotlin-test-junit5", version.ref = "kotlin-version" } dokka-core = { module = "org.jetbrains.dokka:dokka-core", version.ref = "dokka-version" } dokka-base = { module = "org.jetbrains.dokka:dokka-base", version.ref = "dokka-version" } +dokka-gradle-plugin = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokka-version" } kotlinx-atomicfu = { module = "org.jetbrains.kotlinx:atomicfu", version.ref = "atomicfu-version" } kotlinx-atomicfu-plugin = { module = "org.jetbrains.kotlinx:atomicfu-gradle-plugin", version.ref = "atomicfu-version" } @@ -101,8 +103,8 @@ jsoup = { module = "org.jsoup:jsoup", version.ref = "jsoup-version" } [plugins] dokka = { id = "org.jetbrains.dokka", version.ref = "dokka-version"} -kotlin-jvm = {id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin-version" } -kotlin-multiplatform = {id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin-version" } +kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin-version" } +kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin-version" } kotlinx-benchmark = { id = "org.jetbrains.kotlinx.benchmark", version.ref = "kotlinx-benchmark-version" } kotlinx-binary-compatibility-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version = "0.13.2" } kotlinx-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin-version"} diff --git a/runtime/build.gradle.kts b/runtime/build.gradle.kts index 82a5b5fe5..8c086e346 100644 --- a/runtime/build.gradle.kts +++ b/runtime/build.gradle.kts @@ -4,10 +4,11 @@ */ import aws.sdk.kotlin.gradle.dsl.configurePublishing import aws.sdk.kotlin.gradle.kmp.* +import org.gradle.kotlin.dsl.apply import org.jetbrains.kotlin.gradle.dsl.JvmTarget plugins { - alias(libs.plugins.dokka) + `dokka-convention` alias(libs.plugins.aws.kotlin.repo.tools.kmp) apply false jacoco } @@ -24,7 +25,6 @@ subprojects { apply { plugin("org.jetbrains.kotlin.multiplatform") - plugin("org.jetbrains.dokka") plugin(libraries.plugins.aws.kotlin.repo.tools.kmp.get().pluginId) } @@ -62,10 +62,6 @@ subprojects { listOf("kotlin.RequiresOptIn").forEach { languageSettings.optIn(it) } } - dependencies { - dokkaPlugin(project(":dokka-smithy")) - } - tasks.withType { compilerOptions { jvmTarget.set(JvmTarget.JVM_1_8) @@ -78,3 +74,21 @@ subprojects { } } } + + +val excludeFromDocumentation = listOf( + ":runtime:testing", + ":runtime:smithy-test", +) + +subprojects + .filterNot { excludeFromDocumentation.contains(it.path) } + .forEach { + it.plugins.apply("dokka-convention") + } + +dependencies { + subprojects.filterNot { excludeFromDocumentation.contains(it.path) }.forEach { + dokka(project(it.path)) + } +} diff --git a/tests/codegen/nullability-tests/build.gradle.kts b/tests/codegen/nullability-tests/build.gradle.kts index e69809dc6..b05b7635b 100644 --- a/tests/codegen/nullability-tests/build.gradle.kts +++ b/tests/codegen/nullability-tests/build.gradle.kts @@ -6,7 +6,7 @@ import aws.sdk.kotlin.gradle.codegen.smithyKotlinProjectionSrcDir import aws.sdk.kotlin.gradle.dsl.skipPublishing plugins { - alias(libs.plugins.kotlin.jvm) + id(libs.plugins.kotlin.jvm.get().pluginId) alias(libs.plugins.aws.kotlin.repo.tools.smithybuild) } diff --git a/tests/codegen/paginator-tests/build.gradle.kts b/tests/codegen/paginator-tests/build.gradle.kts index caa3afbe4..948f2b079 100644 --- a/tests/codegen/paginator-tests/build.gradle.kts +++ b/tests/codegen/paginator-tests/build.gradle.kts @@ -6,7 +6,7 @@ import aws.sdk.kotlin.gradle.codegen.smithyKotlinProjectionSrcDir import aws.sdk.kotlin.gradle.dsl.skipPublishing plugins { - alias(libs.plugins.kotlin.jvm) + id(libs.plugins.kotlin.jvm.get().pluginId) alias(libs.plugins.aws.kotlin.repo.tools.smithybuild) } diff --git a/tests/codegen/serde-tests/build.gradle.kts b/tests/codegen/serde-tests/build.gradle.kts index 0bfe1ca08..f28091e7e 100644 --- a/tests/codegen/serde-tests/build.gradle.kts +++ b/tests/codegen/serde-tests/build.gradle.kts @@ -6,7 +6,7 @@ import aws.sdk.kotlin.gradle.codegen.smithyKotlinProjectionSrcDir import aws.sdk.kotlin.gradle.dsl.skipPublishing plugins { - alias(libs.plugins.kotlin.jvm) + id(libs.plugins.kotlin.jvm.get().pluginId) alias(libs.plugins.aws.kotlin.repo.tools.smithybuild) } diff --git a/tests/codegen/waiter-tests/build.gradle.kts b/tests/codegen/waiter-tests/build.gradle.kts index 4c48a80c6..72b244a6c 100644 --- a/tests/codegen/waiter-tests/build.gradle.kts +++ b/tests/codegen/waiter-tests/build.gradle.kts @@ -6,7 +6,7 @@ import aws.sdk.kotlin.gradle.codegen.smithyKotlinProjectionSrcDir import aws.sdk.kotlin.gradle.dsl.skipPublishing plugins { - alias(libs.plugins.kotlin.jvm) + id(libs.plugins.kotlin.jvm.get().pluginId) alias(libs.plugins.aws.kotlin.repo.tools.smithybuild) } From 429524787b1fa653317b0037a2b7f9e3239d191e Mon Sep 17 00:00:00 2001 From: Matas Lauzadis Date: Wed, 11 Dec 2024 12:27:47 -0500 Subject: [PATCH 2/8] Correct dokka-convention plugin --- .../src/main/kotlin/dokka-convention.gradle.kts | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/buildSrc/src/main/kotlin/dokka-convention.gradle.kts b/buildSrc/src/main/kotlin/dokka-convention.gradle.kts index a66e6142c..77812bce2 100644 --- a/buildSrc/src/main/kotlin/dokka-convention.gradle.kts +++ b/buildSrc/src/main/kotlin/dokka-convention.gradle.kts @@ -7,7 +7,6 @@ plugins { dokka { val sdkVersion: String by project moduleVersion.set(sdkVersion) - moduleName.set("Smithy Kotlin") pluginsConfiguration.html { customStyleSheets.from( @@ -25,20 +24,6 @@ dokka { separateInheritedMembers.set(true) templatesDir.set(rootProject.file("docs/dokka-presets/templates")) } - - dokkaPublications.html { - includes.from( - rootProject.file("docs/dokka-presets/README.md") - ) - } - -// // Output subprojects' docs to /project-name/* instead of /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) -// } } dependencies { From 21694f30a7bbc1fed847f89ee5ed3f531c61ca43 Mon Sep 17 00:00:00 2001 From: Matas Lauzadis Date: Wed, 11 Dec 2024 12:30:54 -0500 Subject: [PATCH 3/8] ktlint --- .editorconfig | 5 ++++- build.gradle.kts | 2 +- buildSrc/settings.gradle.kts | 2 +- buildSrc/src/main/kotlin/dokka-convention.gradle.kts | 6 +++--- runtime/build.gradle.kts | 1 - 5 files changed, 9 insertions(+), 7 deletions(-) diff --git a/.editorconfig b/.editorconfig index 47da0e888..97c896711 100644 --- a/.editorconfig +++ b/.editorconfig @@ -9,4 +9,7 @@ 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 \ No newline at end of file +ij_kotlin_allow_trailing_comma = true + +[buildSrc/build/**] +ktlint = disabled diff --git a/build.gradle.kts b/build.gradle.kts index 1ec5da06a..941814da3 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -69,7 +69,7 @@ dokka { dokkaPublications.html { includes.from( - rootProject.file("docs/dokka-presets/README.md") + rootProject.file("docs/dokka-presets/README.md"), ) } diff --git a/buildSrc/settings.gradle.kts b/buildSrc/settings.gradle.kts index cd7c4b9af..62991c1ef 100644 --- a/buildSrc/settings.gradle.kts +++ b/buildSrc/settings.gradle.kts @@ -6,4 +6,4 @@ dependencyResolutionManagement { from(files("../gradle/libs.versions.toml")) } } -} \ No newline at end of file +} diff --git a/buildSrc/src/main/kotlin/dokka-convention.gradle.kts b/buildSrc/src/main/kotlin/dokka-convention.gradle.kts index 77812bce2..9e3a40e63 100644 --- a/buildSrc/src/main/kotlin/dokka-convention.gradle.kts +++ b/buildSrc/src/main/kotlin/dokka-convention.gradle.kts @@ -11,13 +11,13 @@ dokka { pluginsConfiguration.html { customStyleSheets.from( rootProject.file("docs/dokka-presets/css/logo-styles.css"), - rootProject.file("docs/dokka-presets/css/aws-styles.css") + 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/assets/aws_logo_white_59x35.png"), - rootProject.file("docs/dokka-presets/scripts/accessibility.js") + rootProject.file("docs/dokka-presets/scripts/accessibility.js"), ) footerMessage.set("© ${java.time.LocalDate.now().year}, Amazon Web Services, Inc. or its affiliates. All rights reserved.") @@ -28,4 +28,4 @@ dokka { dependencies { dokkaPlugin(project(":dokka-smithy")) -} \ No newline at end of file +} diff --git a/runtime/build.gradle.kts b/runtime/build.gradle.kts index 8c086e346..61057e5bb 100644 --- a/runtime/build.gradle.kts +++ b/runtime/build.gradle.kts @@ -75,7 +75,6 @@ subprojects { } } - val excludeFromDocumentation = listOf( ":runtime:testing", ":runtime:smithy-test", From 1ef6ce1f2d9d1df4c156c898e33fd560cee7edab Mon Sep 17 00:00:00 2001 From: Matas Lauzadis Date: Wed, 11 Dec 2024 12:32:04 -0500 Subject: [PATCH 4/8] revert README change --- docs/dokka-presets/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dokka-presets/README.md b/docs/dokka-presets/README.md index b7b789deb..e1e6c1a8f 100644 --- a/docs/dokka-presets/README.md +++ b/docs/dokka-presets/README.md @@ -1 +1 @@ -# Module Smithy Kotlin API Reference +# Smithy Kotlin API Reference From 5b3f1e10eed85da9984e963939ff6696941f9a3a Mon Sep 17 00:00:00 2001 From: Matas Lauzadis Date: Wed, 11 Dec 2024 12:32:55 -0500 Subject: [PATCH 5/8] Disable V2 helpers --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 57851b6e4..b882f9c78 100644 --- a/gradle.properties +++ b/gradle.properties @@ -18,4 +18,4 @@ sdkVersion=1.3.29-SNAPSHOT # codegen codegenVersion=0.33.29-SNAPSHOT -org.jetbrains.dokka.experimental.gradle.pluginMode=V2EnabledWithHelpers +org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled From f49cc50820be5af626983fd6682060e7dce941dc Mon Sep 17 00:00:00 2001 From: Matas Lauzadis Date: Wed, 11 Dec 2024 12:35:19 -0500 Subject: [PATCH 6/8] Combine config blocks --- runtime/build.gradle.kts | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/runtime/build.gradle.kts b/runtime/build.gradle.kts index 61057e5bb..7a6945c17 100644 --- a/runtime/build.gradle.kts +++ b/runtime/build.gradle.kts @@ -80,14 +80,9 @@ val excludeFromDocumentation = listOf( ":runtime:smithy-test", ) -subprojects - .filterNot { excludeFromDocumentation.contains(it.path) } - .forEach { - it.plugins.apply("dokka-convention") - } - dependencies { subprojects.filterNot { excludeFromDocumentation.contains(it.path) }.forEach { - dokka(project(it.path)) + it.plugins.apply("dokka-convention") // Apply the Dokka conventions plugin to the submodule + dokka(project(it.path)) // Aggregate the submodule's generated documentation } } From 30becbb0f028ae0975e0cd472d468660bfd658c3 Mon Sep 17 00:00:00 2001 From: Matas Lauzadis Date: Wed, 11 Dec 2024 12:37:26 -0500 Subject: [PATCH 7/8] Remove fileLayout config, does not seem necessary anymore --- build.gradle.kts | 8 -------- 1 file changed, 8 deletions(-) diff --git a/build.gradle.kts b/build.gradle.kts index 941814da3..8c66b78fe 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -72,14 +72,6 @@ dokka { rootProject.file("docs/dokka-presets/README.md"), ) } - -// // Output subprojects' docs to /project-name/* instead of /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) -// } } dependencies { From dfe21bf40ee3a81d7a2a0dfa4cdc9fa273ea3495 Mon Sep 17 00:00:00 2001 From: Matas Lauzadis Date: Wed, 11 Dec 2024 12:39:33 -0500 Subject: [PATCH 8/8] Changelog --- .changes/bff93ee1-3d3b-4e21-b19f-7f9b3a61a04c.json | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changes/bff93ee1-3d3b-4e21-b19f-7f9b3a61a04c.json diff --git a/.changes/bff93ee1-3d3b-4e21-b19f-7f9b3a61a04c.json b/.changes/bff93ee1-3d3b-4e21-b19f-7f9b3a61a04c.json new file mode 100644 index 000000000..c6bda7dc7 --- /dev/null +++ b/.changes/bff93ee1-3d3b-4e21-b19f-7f9b3a61a04c.json @@ -0,0 +1,5 @@ +{ + "id": "bff93ee1-3d3b-4e21-b19f-7f9b3a61a04c", + "type": "misc", + "description": "Upgrade to Dokka v2.0.0-Beta" +} \ No newline at end of file