Configure the Dokka Gradle plugin, its tasks, and the GitHub Actions workflow, with code copied and adapted from "gradle-common"

A source commit: huanshankeji/gradle-common@d0c8105

Author: ShreckYe

.github/workflows/dokka-gh-pages.yml

@@ -0,0 +1,61 @@
+name: Deploy the API documentation to GitHub Pages with Dokka
+
+on:
+  push:
+    branches: [ "release" ]
+  pull_request:
+    branches: [ "release" ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v4
+        with:
+          java-version: "11"
+          distribution: "temurin"
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Build the distribution with Gradle Wrapper
+        run: ./gradlew :dokkaGeneratePublicationHtml
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build/dokka/html/
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

build.gradle.kts

@@ -1,3 +1,21 @@
 tasks.wrapper {
     distributionType = Wrapper.DistributionType.ALL
 }
+
+plugins {
+    id("org.jetbrains.dokka")
+}
+
+// workaround for https://github.com/Kotlin/dokka/issues/3903 from https://github.com/Kotlin/dokka/issues/2260 TODO remove when it's fixed
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    listOf(
+        "compose-html-common",
+        "compose-html-material3"
+    ).forEach {
+        dokka(project(":$it"))
+    }
+}

buildSrc/build.gradle.kts

@@ -17,4 +17,5 @@ dependencies {
     implementation("com.huanshankeji:kotlin-common-gradle-plugins:$huanshankejiGradlePluginsVersion")
     implementation("com.huanshankeji.team:gradle-plugins:$huanshankejiGradlePluginsVersion")
     implementation("com.huanshankeji:common-gradle-dependencies:0.8.0-20241016") // don't use a snapshot version in a main branch
+    implementation("org.jetbrains.dokka:dokka-gradle-plugin:2.0.0-Beta")
 }

buildSrc/src/main/kotlin/dokka-convention.gradle.kts

@@ -0,0 +1,12 @@
+plugins {
+    id("org.jetbrains.dokka")
+}
+
+dokka {
+    dokkaSourceSets.all {
+        sourceLink {
+            remoteUrl("https://github.com/huanshankeji/compose-html-material/tree/v${version}/${project.name}")
+            remoteLineSuffix.set("#L")
+        }
+    }
+}

buildSrc/src/main/kotlin/lib-conventions.gradle.kts

@@ -1,4 +1,5 @@
 plugins {
     id("lib-conventions-without-publishing")
     id("com.huanshankeji.kotlin-multiplatform-sonatype-ossrh-publish-conventions")
-}
+    id("dokka-convention")
+}

gradle.properties

@@ -0,0 +1,2 @@
+# for Dokka
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled