Merge pull request #12 from huanshankeji/dokka

Deploy the API documentation to GitHub Pages with Dokka

.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: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Set up JDK 8
+        uses: actions/setup-java@v4
+        with:
+          java-version: "8"
+          distribution: "zulu"
+
+      - 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,28 @@
+import com.huanshankeji.cpnProject
+
 tasks.wrapper {
     distributionType = Wrapper.DistributionType.ALL
 }
+
+plugins {
+    id("org.jetbrains.dokka")
+}
+
+dependencies {
+    listOf(
+        "core",
+        "net",
+        "web",
+
+        "arrow",
+        "coroutines",
+        "exposed",
+        "ktor:client",
+        "reflect",
+        "serialization",
+        "vertx",
+        "vertx:with-context-receivers",
+    ).forEach {
+        dokka(cpnProject(project, ":$it"))
+    }
+}

buildSrc/build.gradle.kts

@@ -19,4 +19,5 @@ dependencies {
     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.0") // 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/common-conventions.gradle.kts

@@ -5,6 +5,7 @@ plugins {
     id("com.huanshankeji.team.with-group")
     id("maven-central")
     id("com.huanshankeji.team.default-github-packages-maven-publish")
+    id("dokka-convention")
 }
 
 version = projectVersion

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

@@ -0,0 +1,24 @@
+plugins {
+    id("org.jetbrains.dokka")
+}
+
+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")
+        }*/
+    }
+}

gradle.properties

@@ -1,3 +1,5 @@
 kotlin.mpp.stability.nowarn=true
 # needed for the GitHub Actions CI
 org.gradle.jvmargs=-Xmx4G
+# for Dokka
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled