Doc setup with typelevel-site

Author: SystemFw

.github/workflows/ci.yml

@@ -81,9 +81,6 @@ jobs:
         if: matrix.java == 'temurin@8' && matrix.os == 'ubuntu-22.04'
         run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' doc
 
-      - if: matrix.scala == '2.13'
-        run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' docs/mdoc
-
       - name: Make target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v'))
         run: mkdir -p modules/core/.native/target modules/core/.js/target modules/core/.jvm/target project/target
@@ -280,109 +277,55 @@ jobs:
           modules-ignore: rootjs_2.13 rootjs_3 rootjs_2.12 docs_2.13 docs_3 docs_2.12 rootjvm_2.13 rootjvm_3 rootjvm_2.12 rootnative_2.13 rootnative_3 rootnative_2.12
           configs-ignore: test scala-tool scala-doc-tool test-internal
 
-  docs:
-    name: Deploy docs
-    needs: [publish]
-    if: always() && needs.build.result == 'success' && (needs.publish.result == 'success' || github.ref == 'refs/heads/docs-deploy')
+  site:
+    name: Generate Site
     strategy:
       matrix:
         os: [ubuntu-22.04]
-        scala: [2.13.16]
-        java: [temurin@8]
+        java: [temurin@11]
     runs-on: ${{ matrix.os }}
     steps:
-      - name: Download target directories (2.13, rootJS)
-        uses: actions/download-artifact@v4
-        with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-rootJS
-
-      - name: Inflate target directories (2.13, rootJS)
-        run: |
-          tar xf targets.tar
-          rm targets.tar
-
-      - name: Download target directories (2.13, rootJVM)
-        uses: actions/download-artifact@v4
-        with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-rootJVM
-
-      - name: Inflate target directories (2.13, rootJVM)
-        run: |
-          tar xf targets.tar
-          rm targets.tar
-
-      - name: Download target directories (2.13, rootNative)
-        uses: actions/download-artifact@v4
-        with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-rootNative
-
-      - name: Inflate target directories (2.13, rootNative)
-        run: |
-          tar xf targets.tar
-          rm targets.tar
-
-      - name: Download target directories (3, rootJS)
-        uses: actions/download-artifact@v4
-        with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-3-rootJS
-
-      - name: Inflate target directories (3, rootJS)
-        run: |
-          tar xf targets.tar
-          rm targets.tar
-
-      - name: Download target directories (3, rootJVM)
-        uses: actions/download-artifact@v4
-        with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-3-rootJVM
-
-      - name: Inflate target directories (3, rootJVM)
-        run: |
-          tar xf targets.tar
-          rm targets.tar
-
-      - name: Download target directories (3, rootNative)
-        uses: actions/download-artifact@v4
+      - name: Checkout current branch (full)
+        uses: actions/checkout@v4
         with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-3-rootNative
+          fetch-depth: 0
 
-      - name: Inflate target directories (3, rootNative)
-        run: |
-          tar xf targets.tar
-          rm targets.tar
+      - name: Setup sbt
+        uses: sbt/setup-sbt@v1
 
-      - name: Download target directories (2.12, rootJS)
-        uses: actions/download-artifact@v4
+      - name: Setup Java (temurin@8)
+        id: setup-java-temurin-8
+        if: matrix.java == 'temurin@8'
+        uses: actions/setup-java@v4
         with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-2.12-rootJS
+          distribution: temurin
+          java-version: 8
+          cache: sbt
 
-      - name: Inflate target directories (2.12, rootJS)
-        run: |
-          tar xf targets.tar
-          rm targets.tar
+      - name: sbt update
+        if: matrix.java == 'temurin@8' && steps.setup-java-temurin-8.outputs.cache-hit == 'false'
+        run: sbt +update
 
-      - name: Download target directories (2.12, rootJVM)
-        uses: actions/download-artifact@v4
+      - name: Setup Java (temurin@11)
+        id: setup-java-temurin-11
+        if: matrix.java == 'temurin@11'
+        uses: actions/setup-java@v4
         with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-2.12-rootJVM
-
-      - name: Inflate target directories (2.12, rootJVM)
-        run: |
-          tar xf targets.tar
-          rm targets.tar
+          distribution: temurin
+          java-version: 11
+          cache: sbt
 
-      - name: Download target directories (2.12, rootNative)
-        uses: actions/download-artifact@v4
-        with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-2.12-rootNative
+      - name: sbt update
+        if: matrix.java == 'temurin@11' && steps.setup-java-temurin-11.outputs.cache-hit == 'false'
+        run: sbt +update
 
-      - name: Inflate target directories (2.12, rootNative)
-        run: |
-          tar xf targets.tar
-          rm targets.tar
+      - name: Generate site
+        run: sbt docs/tlSite
 
-      - name: Deploy docs
-        uses: peaceiris/actions-gh-pages@v4
+      - name: Publish site
+        if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
+        uses: peaceiris/[email protected]
         with:
-          publish_dir: ./target/website
           github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: mdoc/target/docs/site
+          keep_files: true

build.sbt

@@ -60,37 +60,12 @@ lazy val docs = project
         .map(v => s"- **$v**")
         .mkString("\n")
     ),
-    githubWorkflowArtifactUpload := false,
+    laikaSite := {
+      sbt.IO.copyDirectory(mdocOut.value, (laikaSite / target).value)
+      Set.empty
+    },
+    tlJdkRelease := None,
     tlFatalWarnings := false
   )
   .dependsOn(core.jvm)
-  .enablePlugins(MdocPlugin, NoPublishPlugin)
-
-ThisBuild / githubWorkflowBuildPostamble ++= List(
-  WorkflowStep.Sbt(
-    List("docs/mdoc"),
-    cond = Some(s"matrix.scala == '2.13'")
-  )
-)
-
-ThisBuild / githubWorkflowAddedJobs += WorkflowJob(
-  id = "docs",
-  name = "Deploy docs",
-  needs = List("publish"),
-  cond = """
-  | always() &&
-  | needs.build.result == 'success' &&
-  | (needs.publish.result == 'success' || github.ref == 'refs/heads/docs-deploy')
-  """.stripMargin.trim.linesIterator.mkString.some,
-  steps = githubWorkflowGeneratedDownloadSteps.value.toList :+
-    WorkflowStep.Use(
-      UseRef.Public("peaceiris", "actions-gh-pages", "v4"),
-      name = Some(s"Deploy docs"),
-      params = Map(
-        "publish_dir" -> "./target/website",
-        "github_token" -> "${{ secrets.GITHUB_TOKEN }}"
-      )
-    ),
-  scalas = List(Scala213),
-  javas = githubWorkflowJavaVersions.value.toList
-)
+  .enablePlugins(TypelevelSitePlugin)

project/plugins.sbt

@@ -1,4 +1,5 @@
 addSbtPlugin("org.typelevel" % "sbt-typelevel" % "0.8.0")
+addSbtPlugin("org.typelevel" % "sbt-typelevel-site" % "0.8.0")
 addSbtPlugin("org.scalameta" % "sbt-mdoc" % "2.7.1")
 addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.18.2")
 addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.4.17")