Docs publishing prototype

Kotlin · Feb 17, 2024 · b9eedc6 · b9eedc6
1 parent e80c83c
commit b9eedc6
Show file tree

Hide file tree

Showing 14 changed files with 113 additions and 7 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,65 @@
+name: Publish release docs
+
+on:
+  push:
+    branches:
+      - main
+
+# 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:
+  prepare:
+    name: Prepare docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Prepare and collect all docs by Dokka
+        uses: actions/checkout@v4
+        with:
+          path: kover
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: 17
+          cache: 'gradle'
+      - uses: gradle/gradle-build-action@v2
+        with:
+          gradle-home-cache-cleanup: true
+      - name: Build docs
+        run: ./gradlew releaseDocs
+        working-directory: kover
+  build:
+    name: Generate jekyll docs
+    runs-on: ubuntu-latest
+#    needs: prepare
+    steps:
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Build
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: "./kover/docs"
+          destination: "./docs-generated"
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: "./docs-generated"
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,4 +1,6 @@
 remote_theme: pages-themes/slate@v0.2.0
+plugins:
+  - jekyll-remote-theme # add this line to the plugins list if you already have one
 lsi: false
 safe: true
 source: /

diff --git a/docs/index.md b/docs/index.md
diff --git a/kover-cli/build.gradle.kts b/kover-cli/build.gradle.kts
@@ -63,3 +63,17 @@ tasks.jar {
 repositories {
     mavenCentral()
 }
+
+tasks.register("releaseDocs") {
+    val dirName = "cli"
+    val description = "Kover Command Line Interface"
+    val sourceDir = projectDir.resolve("docs")
+    val resultDir = rootDir.resolve("docs/$dirName")
+    val mainIndexFile = rootDir.resolve("docs/index.md")
+
+    doLast {
+        resultDir.mkdirs()
+        sourceDir.copyRecursively(resultDir)
+        mainIndexFile.appendText("- [$description]($dirName)\n")
+    }
+}
diff --git a/docs/cli/index.md → kover-cli/docs/index.md b/docs/cli/index.md → kover-cli/docs/index.md
diff --git a/kover-gradle-plugin/build.gradle.kts b/kover-gradle-plugin/build.gradle.kts
@@ -146,11 +146,9 @@ afterEvaluate {
 
 tasks.dokkaHtml {
     moduleName.set("Kover Gradle Plugin")
-    outputDirectory.set(rootProject.layout.projectDirectory.dir("docs/gradle-plugin/dokka").asFile)
+    outputDirectory.set(projectDir.resolve("docs/dokka"))
 
-    if (project.hasProperty("releaseVersion")) {
-        moduleVersion.set(project.property("releaseVersion") as String)
-    }
+    moduleVersion.set(project.property("kover.release.version").toString())
 
     dokkaSourceSets.configureEach {
         // source set configuration section
@@ -165,6 +163,22 @@ tasks.dokkaHtml {
     }
 }
 
+tasks.register("releaseDocs") {
+    val dirName = "gradle-plugin"
+    val description = "Kover Gradle Plugin"
+    val sourceDir = projectDir.resolve("docs")
+    val resultDir = rootDir.resolve("docs/$dirName")
+    val mainIndexFile = rootDir.resolve("docs/index.md")
+
+    dependsOn(tasks.dokkaHtml)
+
+    doLast {
+        resultDir.mkdirs()
+        sourceDir.copyRecursively(resultDir)
+        mainIndexFile.appendText("- [$description]($dirName)\n")
+    }
+}
+
 extensions.configure<Kover_publishing_conventions_gradle.KoverPublicationExtension> {
     description.set("Kover Gradle Plugin - Kotlin code coverage")
     //`java-gradle-plugin` plugin already creates publication with name `pluginMaven`

diff --git a/docs/gradle-plugin/configuring.md → kover-gradle-plugin/docs/configuring.md b/docs/gradle-plugin/configuring.md → kover-gradle-plugin/docs/configuring.md
diff --git a/...dle-plugin/development/functionalTests.md → ...lugin/docs/development/functionalTests.md b/...dle-plugin/development/functionalTests.md → ...lugin/docs/development/functionalTests.md
diff --git a/docs/gradle-plugin/html.png → kover-gradle-plugin/docs/html.png b/docs/gradle-plugin/html.png → kover-gradle-plugin/docs/html.png
diff --git a/docs/gradle-plugin/index.md → kover-gradle-plugin/docs/index.md b/docs/gradle-plugin/index.md → kover-gradle-plugin/docs/index.md
diff --git a/...e-plugin/migrations/migration-to-0.6.0.md → ...gin/docs/migrations/migration-to-0.6.0.md b/...e-plugin/migrations/migration-to-0.6.0.md → ...gin/docs/migrations/migration-to-0.6.0.md
diff --git a/...e-plugin/migrations/migration-to-0.7.0.md → ...gin/docs/migrations/migration-to-0.7.0.md b/...e-plugin/migrations/migration-to-0.7.0.md → ...gin/docs/migrations/migration-to-0.7.0.md
diff --git a/kover-offline-runtime/build.gradle.kts b/kover-offline-runtime/build.gradle.kts
@@ -51,3 +51,17 @@ tasks.jar {
         exclude("classpath.index")
     }
 }
+
+tasks.register("releaseDocs") {
+    val dirName = "offline-instrumentation"
+    val description = "Kover offline instrumentation"
+    val sourceDir = projectDir.resolve("docs")
+    val resultDir = rootDir.resolve("docs/$dirName")
+    val mainIndexFile = rootDir.resolve("docs/index.md")
+
+    doLast {
+        resultDir.mkdirs()
+        sourceDir.copyRecursively(resultDir)
+        mainIndexFile.appendText("- [$description]($dirName)\n")
+    }
+}
diff --git a/docs/offline-instrumentation/index.md → kover-offline-runtime/docs/index.md b/docs/offline-instrumentation/index.md → kover-offline-runtime/docs/index.md