[Gradle] Apply Dokka versioning plugin also to leaf partial html

Tapchicoma · Space Team · commit 4086c4b53e93 · 2025-06-10T12:51:52.000Z
This fixes versioning styling in the published API reference.
diff --git a/repo/gradle-build-conventions/gradle-plugins-documentation/src/main/kotlin/PluginsApiDocumentationExtension.kt b/repo/gradle-build-conventions/gradle-plugins-documentation/src/main/kotlin/PluginsApiDocumentationExtension.kt
@@ -12,7 +12,7 @@ import javax.inject.Inject
 
 abstract class PluginsApiDocumentationExtension @Inject constructor(
     objectFactory: ObjectFactory,
-    private val childProjectConfiguration: (Project) -> Unit
+    private val childProjectConfiguration: (Project, PluginsApiDocumentationExtension) -> Unit
 ) {
     abstract val documentationOutput: DirectoryProperty
     abstract val documentationOldVersions: DirectoryProperty
@@ -23,6 +23,6 @@ abstract class PluginsApiDocumentationExtension @Inject constructor(
 
     fun addGradlePluginProject(project: Project) {
         gradlePluginsProjects.add(project)
-        childProjectConfiguration(project)
+        childProjectConfiguration(project, this)
     }
 }
diff --git a/repo/gradle-build-conventions/gradle-plugins-documentation/src/main/kotlin/gradle-plugins-documentation.gradle.kts b/repo/gradle-build-conventions/gradle-plugins-documentation/src/main/kotlin/gradle-plugins-documentation.gradle.kts
@@ -8,22 +8,39 @@ plugins {
     base
 }
 
-val templateConfig = Pair(
+private val templateConfig = Pair(
     "org.jetbrains.dokka.base.DokkaBase",
     "{ \"templatesDir\": \"${project.rootDir.resolve("build/api-reference/templates").also { it.mkdirs() }}\" }"
 )
 
+// Documentation: https://github.com/Kotlin/dokka/tree/1.9.20/dokka-subprojects/plugin-versioning
+private val PluginsApiDocumentationExtension.versioningConfig
+    get() = Pair(
+        "org.jetbrains.dokka.versioning.VersioningPlugin",
+        documentationOldVersions.map { olderVersionsDir ->
+            "{ \"version\":\"$version\", \"olderVersionsDir\":\"${olderVersionsDir.asFile.also { it.mkdirs() }}\" }"
+        }
+    )
+
+private val dokkaVersioningPlugin = versionCatalogs.named("libs").findLibrary("dokka-versioningPlugin").get()
+
 val documentationExtension = extensions.create<PluginsApiDocumentationExtension>(
     "pluginsApiDocumentation",
-    { project: Project ->
-        project.tasks.withType<DokkaTaskPartial>().configureEach {
-            pluginsMapConfiguration.put(templateConfig.first, templateConfig.second)
+    { project: Project, extension: PluginsApiDocumentationExtension ->
+        project.plugins.withId("org.jetbrains.dokka") {
+            project.dependencies {
+                "dokkaPlugin"(dokkaVersioningPlugin)
+            }
+            project.tasks.withType<DokkaTaskPartial>().configureEach {
+                pluginsMapConfiguration.put(templateConfig.first, templateConfig.second)
+                extension.versioningConfig.let { pluginsMapConfiguration.put(it.first, it.second) }
+            }
         }
     }
 )
 
 dependencies {
-    dokkaPlugin(versionCatalogs.named("libs").findLibrary("dokka-versioningPlugin").get())
+    dokkaPlugin(dokkaVersioningPlugin)
     dokkaPlugin(versionCatalogs.named("libs").findLibrary("dokka-multiModulePlugin").get())
 }
 
@@ -81,14 +98,9 @@ tasks.register<org.jetbrains.dokka.gradle.DokkaMultiModuleTask>("dokkaKotlinlang
 
     dependsOn(unzipTemplates)
     pluginsMapConfiguration.put(templateConfig.first, templateConfig.second)
-
-    // Documentation: https://github.com/Kotlin/dokka/tree/1.9.20/dokka-subprojects/plugin-versioning
-    pluginsMapConfiguration.put(
-        "org.jetbrains.dokka.versioning.VersioningPlugin",
-        documentationExtension.documentationOldVersions.map { olderVersionsDir ->
-            "{ \"version\":\"$version\", \"olderVersionsDir\":\"${olderVersionsDir.asFile.also { it.mkdirs() }}\" }"
-        }
-    )
+    documentationExtension.versioningConfig.let {
+        pluginsMapConfiguration.put(it.first, it.second)
+    }
 
     fileLayout.set(DokkaMultiModuleFileLayout { parent, child ->
         parent.outputDirectory.dir(child.project.name)

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import javax.inject.Inject`
`12`	`12`
`13`	`13`	`abstract class PluginsApiDocumentationExtension @Inject constructor(`
`14`	`14`	`objectFactory: ObjectFactory,`
`15`		`- private val childProjectConfiguration: (Project) -> Unit`
	`15`	`+ private val childProjectConfiguration: (Project, PluginsApiDocumentationExtension) -> Unit`
`16`	`16`	`) {`
`17`	`17`	`abstract val documentationOutput: DirectoryProperty`
`18`	`18`	`abstract val documentationOldVersions: DirectoryProperty`
`@@ -23,6 +23,6 @@ abstract class PluginsApiDocumentationExtension @Inject constructor(`
`23`	`23`
`24`	`24`	`fun addGradlePluginProject(project: Project) {`
`25`	`25`	`gradlePluginsProjects.add(project)`
`26`		`- childProjectConfiguration(project)`
	`26`	`+ childProjectConfiguration(project, this)`
`27`	`27`	`}`
`28`	`28`	`}`