Skip to content

Commit 7364382

Browse files
authored
chore: migrate to Dokka plugin V2 (#1869)
In Dokka 2.1.0, the V1 mode will be gone. Opting in proactively, and to get rid of annoying warnings.
1 parent 29a6fa9 commit 7364382

File tree

4 files changed

+5
-3
lines changed

4 files changed

+5
-3
lines changed

.github/workflows/release.main.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ private fun JobBuilder<*>.deployDocs() {
8080
uses(action = ActionsSetupGradle())
8181
run(
8282
name = "Generate API docs",
83-
command = "./gradlew :github-workflows-kt:dokkaHtml --no-configuration-cache",
83+
command = "./gradlew :github-workflows-kt:dokkaGenerate",
8484
)
8585
run(
8686
name = "Prepare target directory for API docs",

.github/workflows/release.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ jobs:
9898
uses: 'gradle/actions/setup-gradle@v4'
9999
- id: 'step-16'
100100
name: 'Generate API docs'
101-
run: './gradlew :github-workflows-kt:dokkaHtml --no-configuration-cache'
101+
run: './gradlew :github-workflows-kt:dokkaGenerate'
102102
- id: 'step-17'
103103
name: 'Prepare target directory for API docs'
104104
run: 'mkdir -p to-gh-pages/api-docs'

github-workflows-kt/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,6 @@ pitest {
7777
junit5PluginVersion.set("1.1.0")
7878
}
7979

80-
tasks.dokkaHtml {
80+
dokka {
8181
moduleName.set("github-workflows-kt")
8282
}

gradle.properties

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@ kotlin.incremental.useClasspathSnapshot=true
1010

1111
# So that KSP doesn't generate files in "test" sources root
1212
ksp.allow.all.target.configuration=false
13+
14+
org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled

0 commit comments

Comments
 (0)