Use the new com.huanshankeji.team.dokka.github-dokka-convention plugin

The corresponding commit: huanshankeji/gradle-common@9e60c15
huanshankeji · Nov 7, 2024 · 1384528 · 1384528
1 parent 9ce9e60
commit 1384528
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 15 deletions.
diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts
@@ -18,6 +18,6 @@ dependencies {
     // With Kotlin 2.0.20, a "Could not parse POM" build error occurs in the JVM projects of some dependent projects.
     implementation(kotlin("gradle-plugin", "2.0.10"))
     implementation("com.huanshankeji:common-gradle-dependencies:0.8.0-20241016") // don't use a snapshot version in a main branch
-    implementation("com.huanshankeji.team:gradle-plugins:0.6.1-SNAPSHOT") // don't use a snapshot version in a main branch
+    implementation("com.huanshankeji.team:gradle-plugins:0.7.0-SNAPSHOT") // TODO don't use a snapshot version in a main branch
     implementation("org.jetbrains.dokka:dokka-gradle-plugin:2.0.0-Beta")
 }
diff --git a/buildSrc/src/main/kotlin/common-conventions.gradle.kts b/buildSrc/src/main/kotlin/common-conventions.gradle.kts
@@ -5,11 +5,10 @@ plugins {
     id("com.huanshankeji.team.with-group")
     id("maven-central")
     id("com.huanshankeji.team.default-github-packages-maven-publish")
+    id("version")
     id("dokka-convention")
 }
 
-version = projectVersion
-
 afterEvaluate {
     publishing.publications.withType<MavenPublication> {
         pomForTeamDefaultOpenSource(

diff --git a/buildSrc/src/main/kotlin/dokka-convention.gradle.kts b/buildSrc/src/main/kotlin/dokka-convention.gradle.kts
@@ -1,22 +1,11 @@
 plugins {
-    id("org.jetbrains.dokka")
+    id("com.huanshankeji.team.dokka.github-dokka-convention")
 }
 
 dokka {
     //moduleName.set("Huanshankeji Kotlin Common")
     dokkaSourceSets.all {
         //includes.from("README.md")
-        sourceLink {
-            //localDirectory.set(file("src/main/kotlin"))
-            remoteUrl(
-                "https://github.com/huanshankeji/kotlin-common/tree/v${version}/${
-                    with(project) {
-                        name.removePrefix(parent!!.name + '-')
-                    }
-                }"
-            )
-            remoteLineSuffix.set("#L")
-        }
         /*pluginsConfiguration.html {
             footerMessage.set("(c) Yongshun Ye")
         }*/

diff --git a/buildSrc/src/main/kotlin/version.gradle.kts b/buildSrc/src/main/kotlin/version.gradle.kts
@@ -0,0 +1,3 @@
+// extracted into a separate script so the version can be set before `dokka-convention`
+
+version = projectVersion
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		// extracted into a separate script so the version can be set before `dokka-convention`

		version = projectVersion