misc: upgrade to Dokka 2.0.0 #1284
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "id": "50a9ce20-c4d7-4952-8fad-f9ffb38c9259", | ||
| "type": "misc", | ||
| "description": "Upgrade to Dokka 2.0.0" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,13 +18,13 @@ buildscript { | |
| } | ||
|
|
||
| plugins { | ||
| `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 | ||
| 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 { | ||
| if (rootProject.typedProp<Boolean>("kotlinWarningsAsErrors") == true) { | ||
| tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> { | ||
| compilerOptions.allWarningsAsErrors = true | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -90,27 +64,18 @@ allprojects { | |
| } | ||
|
|
||
| // configure the root multimodule docs | ||
| dokka { | ||
| moduleName.set("Smithy Kotlin") | ||
|
|
||
| dokkaPublications.html { | ||
| includes.from( | ||
| rootProject.file("docs/dokka-presets/README.md"), | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| dependencies { | ||
| dokka(project(":runtime")) | ||
| } | ||
|
Comment on lines
+77
to
79
There was a problem hiding this comment. Why do we need this now? There was a problem hiding this comment. Do you mean the |
||
|
|
||
| // Publishing | ||
|
|
@@ -121,6 +86,7 @@ val lintPaths = listOf( | |
| "**/*.{kt,kts}", | ||
| "!**/generated-src/**", | ||
| "!**/smithyprojections/**", | ||
| "!**/build/**", | ||
| ) | ||
|
|
||
| configureLinting(lintPaths) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| plugins { | ||
| `kotlin-dsl` | ||
| } | ||
|
|
||
| repositories { | ||
| mavenCentral() | ||
| gradlePluginPortal() | ||
| } | ||
|
|
||
| dependencies { | ||
| implementation(libs.dokka.gradle.plugin) | ||
| implementation(libs.kotlin.gradle.plugin) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| rootProject.name = "buildSrc" | ||
|
|
||
| dependencyResolutionManagement { | ||
| versionCatalogs { | ||
| create("libs") { | ||
| from(files("../gradle/libs.versions.toml")) | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| import kotlin.text.set | ||
|
There was a problem hiding this comment. Question: I like the idea of refactoring this out of the main build file. How much more work would it be to move it all the way out into aws-kotlin-repo-tools so that we had less duplication? |
||
|
|
||
| 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")) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does dokka handle this now or is the layout going to change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This didn't seem to be necessary anymore in my testing. It was an old bit of code, might have been fixed a long time ago or just now in Dokka 2.0.0