Dokka workflow updates

Mr3zee · Mr3zee · commit 78d173aa376f · 2025-07-01T14:38:08.000+02:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -6,6 +6,10 @@ on:
       - 'docs/pages/**'
       - '.github/workflows/**'
   workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version of library that is being documented'
+        required: true
 
 permissions:
   id-token: write
@@ -21,6 +25,9 @@ env:
   ALGOLIA_KEY: '${{ secrets.ALGOLIA_KEY }}'
   CONFIG_JSON_PRODUCT: 'kotlinx-rpc'
   CONFIG_JSON_VERSION: '0.8.0'
+  DOKKA_ARTIFACT: 'dokka.zip'
+  ASSEMBLE_DIR: '__docs_assembled'
+  ASSEMBLE_ARTIFACT: 'assembled.zip'
 
 jobs:
   build:
@@ -67,11 +74,8 @@ jobs:
         with:
           instance: ${{ env.INSTANCE }}
 
-  deploy:
+  assemble:
     if: github.event_name == 'workflow_dispatch'
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
     needs: [ build, test ]
     runs-on: ubuntu-latest
     steps:
@@ -80,58 +84,76 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Setup Gradle
-        uses: gradle/actions/setup-gradle@v4
-
-      - name: Run Dokka
-        run: ./gradlew dokkaGenerate
+      - name: Download Writerside artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: kotlinx-rpc
 
-      - name: Move API docs to the publication directory
-        run:
-          mkdir __docs_publication_dir
-          cp -r docs/pages/api __docs_publication_dir/api
+      - name: Unzip Writerside artifacts
+        run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}
 
-      - name: Download artifacts
+      - name: Download Dokka
         uses: actions/download-artifact@v4
         with:
-          name: kotlinx-rpc
+          name: dokka-${{ inputs.version }}
+          path: ${{ env.DOKKA_ARTIFACT }}
 
-      - name: Unzip artifact
-        run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d __docs_publication_dir
+      - name: Unzip Dokka
+        run: unzip -O UTF-8 -qq '${{ env.DOKKA_ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}/api
+        
+      - name: Move changelog.md to the docs root
+        run: mv ${{ env.ASSEMBLE_DIR }}/api/changelog.md ${{ env.ASSEMBLE_DIR }}/changelog.md      
 
       - name: Update sitemap.xml
-        run: chmod +x updateSitemap.sh && ./updateSitemap.sh __docs_publication_dir/sitemap.xml __docs_publication_dir/api
+        run: chmod +x updateSitemap.sh && ./updateSitemap.sh ${{ env.ASSEMBLE_DIR }}/sitemap.xml ${{ env.ASSEMBLE_DIR }}/api
+
+      - name: Save assembled artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: kotlinx-rpc-assembled
+          path: |
+            ${{ env.ASSEMBLE_DIR }}
+          retention-days: 7
 
-      - name: Run Changelog Generator
-        run: ./gradlew updateDocsChangelog
+  deploy:
+    if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: [ build, test, assemble ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: kotlinx-rpc-assembled
 
-      - name: Move Changelog.md to the publication directory
-        run:
-          mv docs/pages/kotlinx-rpc/topics/changelog.md __docs_publication_dir/changelog.md
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq '${{ env.ASSEMBLE_ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}
 
       - name: Setup Pages
         uses: actions/configure-pages@v5
 
       - name: Package and upload Pages artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: __docs_publication_dir
+          path: ${{ env.ASSEMBLE_DIR }}
 
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
 
   publish-indexes:
-    if: github.event_name == 'workflow_dispatch'
-    needs: [ build, test, deploy ]
+    if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main'
+    needs: [ build, test, assemble, deploy ]
     runs-on: ubuntu-latest
     container:
       image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3
     steps:
       - name: Download artifact
         uses: actions/download-artifact@v4
         with:
-          name: kotlinx-rpc
+          name: kotlinx-rpc-assembled
       - name: Unzip artifact
         run: |
           unzip -O UTF-8 -qq '${{ env.ALGOLIA_ARTIFACT }}' -d algolia-indexes
diff --git a/.github/workflows/dokka.yml b/.github/workflows/dokka.yml
@@ -0,0 +1,34 @@
+name: Store Dokka Artifact
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version of library that is being documented'
+        required: true
+        type: string
+      buildId:
+        description: 'TeamCity build id'
+        required: true
+        type: string
+      artifactName:
+        description: 'Name of artifact to download'
+        required: true
+        type: string
+
+jobs:
+  store-dokka-artifact:
+    name: Store Dokka Artifact
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download Dokka artifact
+        run: |
+          curl -v -s -f -L \
+            -H "Authorization: Bearer ${{ secrets.TEAMCITY_TOKEN }}" \
+            https://krpc.teamcity.com/app/rest/builds/id:${{ inputs.buildId }}/artifacts/content/${{ inputs.artifactName }} -o dokka.zip
+      - name: Save artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: dokka-${{ inputs.version }}
+          path: dokka.zip
+          retention-days: 21
diff --git a/compiler-plugin/gradle.properties b/compiler-plugin/gradle.properties
@@ -6,10 +6,10 @@ kotlin.code.style=official
 
 kotlin.native.ignoreDisabledTargets=true
 
-kotlin.daemon.jvmargs=-Xmx6g -XX:+HeapDumpOnOutOfMemoryError
+kotlin.daemon.jvmargs=-Xmx8g -XX:+HeapDumpOnOutOfMemoryError
 kotlin.daemon.useFallbackStrategy=false
 
-org.gradle.jvmargs=-Xmx6g -XX:+HeapDumpOnOutOfMemoryError -XX:+UseParallelGC -XX:MaxMetaspaceSize=768m
+org.gradle.jvmargs=-Xmx8g -XX:+HeapDumpOnOutOfMemoryError -XX:+UseParallelGC -XX:MaxMetaspaceSize=768m
 org.gradle.daemon=true
 org.gradle.parallel=true
 org.gradle.workers.max=8
diff --git a/dokka-plugin/gradle.properties b/dokka-plugin/gradle.properties
@@ -6,10 +6,10 @@ kotlin.code.style=official
 
 kotlin.native.ignoreDisabledTargets=true
 
-kotlin.daemon.jvmargs=-Xmx6g -XX:+HeapDumpOnOutOfMemoryError
+kotlin.daemon.jvmargs=-Xmx8g -XX:+HeapDumpOnOutOfMemoryError
 kotlin.daemon.useFallbackStrategy=false
 
-org.gradle.jvmargs=-Xmx6g -XX:+HeapDumpOnOutOfMemoryError -XX:+UseParallelGC -XX:MaxMetaspaceSize=768m
+org.gradle.jvmargs=-Xmx8g -XX:+HeapDumpOnOutOfMemoryError -XX:+UseParallelGC -XX:MaxMetaspaceSize=768m
 org.gradle.daemon=true
 org.gradle.parallel=true
 org.gradle.workers.max=8
diff --git a/gradle-conventions/src/main/kotlin/conventions-dokka-spec.gradle.kts b/gradle-conventions/src/main/kotlin/conventions-dokka-spec.gradle.kts
@@ -4,7 +4,6 @@
 
 import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
 import util.KOTLINX_RPC_PREFIX
-import util.other.asDokkaVersion
 import util.other.libs
 import java.time.Year
 
@@ -24,7 +23,7 @@ dokka {
     dokkaSourceSets.configureEach {
         sourceLink {
             localDirectory = rootDir
-            remoteUrl("https://github.com/Kotlin/kotlinx-rpc/blob/${libs.versions.kotlinx.rpc.get().asDokkaVersion()}")
+            remoteUrl("https://github.com/Kotlin/kotlinx-rpc/blob/${libs.versions.kotlinx.rpc.get()}")
             remoteLineSuffix = "#L"
 
             documentedVisibilities = setOf(
diff --git a/gradle-conventions/src/main/kotlin/conventions-gradle-doctor.gradle.kts b/gradle-conventions/src/main/kotlin/conventions-gradle-doctor.gradle.kts
@@ -8,7 +8,6 @@ plugins {
 
 doctor {
     enableTestCaching.assign(false)
-    warnWhenNotUsingParallelGC.assign(true)
     disallowMultipleDaemons.assign(false)
     GCFailThreshold.assign(0.5f)
 }
diff --git a/gradle-conventions/src/main/kotlin/conventions-root.gradle.kts b/gradle-conventions/src/main/kotlin/conventions-root.gradle.kts
@@ -2,7 +2,6 @@
  * Copyright 2023-2025 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
-import util.other.asDokkaVersion
 import util.other.libs
 import util.tasks.configureNpm
 import util.tasks.registerChangelogTask
@@ -29,9 +28,9 @@ allprojects {
 }
 
 dokka {
-    val libDokkaVersion = libs.versions.kotlinx.rpc.get().asDokkaVersion()
+    val libVersion = libs.versions.kotlinx.rpc.get()
 
-    moduleVersion.set(libDokkaVersion)
+    moduleVersion.set(libVersion)
 
     val pagesDirectory = layout.projectDirectory
         .dir("docs")
@@ -63,6 +62,13 @@ dokka {
         outputDirectory = dokkaVersionsDirectory
     }
 
+    tasks.dokkaGenerate {
+        doFirst {
+            dokkaVersionsDirectory.mkdirs()
+            dokkaVersionsDirectory.resolve("version.txt").writeText(libVersion)
+        }
+    }
+
     tasks.clean {
         delete(dokkaVersionsDirectory)
     }
diff --git a/gradle-conventions/src/main/kotlin/util/other/dokkaUtil.kt b/gradle-conventions/src/main/kotlin/util/other/dokkaUtil.kt
diff --git a/gradle-plugin/gradle.properties b/gradle-plugin/gradle.properties
@@ -6,10 +6,10 @@ kotlin.code.style=official
 
 kotlin.native.ignoreDisabledTargets=true
 
-kotlin.daemon.jvmargs=-Xmx6g -XX:+HeapDumpOnOutOfMemoryError
+kotlin.daemon.jvmargs=-Xmx8g -XX:+HeapDumpOnOutOfMemoryError
 kotlin.daemon.useFallbackStrategy=false
 
-org.gradle.jvmargs=-Xmx6g -XX:+HeapDumpOnOutOfMemoryError -XX:+UseParallelGC -XX:MaxMetaspaceSize=768m
+org.gradle.jvmargs=-Xmx8g -XX:+HeapDumpOnOutOfMemoryError -XX:+UseParallelGC -XX:MaxMetaspaceSize=768m
 org.gradle.daemon=true
 org.gradle.parallel=true
 org.gradle.workers.max=8
diff --git a/gradle.properties b/gradle.properties
@@ -6,10 +6,10 @@ kotlin.code.style=official
 
 kotlin.native.ignoreDisabledTargets=true
 
-kotlin.daemon.jvmargs=-Xmx6g -XX:+HeapDumpOnOutOfMemoryError
+kotlin.daemon.jvmargs=-Xmx8g -XX:+HeapDumpOnOutOfMemoryError
 kotlin.daemon.useFallbackStrategy=false
 
-org.gradle.jvmargs=-Xmx6g -XX:+HeapDumpOnOutOfMemoryError -XX:+UseParallelGC -XX:MaxMetaspaceSize=768m
+org.gradle.jvmargs=-Xmx8g -XX:+HeapDumpOnOutOfMemoryError -XX:+UseParallelGC -XX:MaxMetaspaceSize=768m
 org.gradle.daemon=true
 org.gradle.parallel=true
 org.gradle.workers.max=8

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,6 @@ plugins {`
`8`	`8`
`9`	`9`	`doctor {`
`10`	`10`	`enableTestCaching.assign(false)`
`11`		`- warnWhenNotUsingParallelGC.assign(true)`
`12`	`11`	`disallowMultipleDaemons.assign(false)`
`13`	`12`	`GCFailThreshold.assign(0.5f)`
`14`	`13`	`}`