Merge pull request #97 from armanbilge/feature/tlsite-task

Make site plugin more robust
typelevel · Jan 23, 2022 · fbac902 · fbac902
2 parents 62914d2 + ee9f775
commit fbac902
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -182,7 +182,7 @@ jobs:
           key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }}
 
       - name: Generate site
-        run: sbt '++${{ matrix.scala }}' tlSite
+        run: sbt '++${{ matrix.scala }}' docs/tlSite
 
       - name: Publish site
         if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'

diff --git a/site/src/main/scala/org/typelevel/sbt/TypelevelSitePlugin.scala b/site/src/main/scala/org/typelevel/sbt/TypelevelSitePlugin.scala
@@ -27,6 +27,7 @@ import org.typelevel.sbt.kernel.GitHelper
 import gha.GenerativePlugin, GenerativePlugin.autoImport._
 import scala.io.Source
 import java.util.Base64
+import scala.annotation.nowarn
 
 object TypelevelSitePlugin extends AutoPlugin {
 
@@ -39,10 +40,10 @@ object TypelevelSitePlugin extends AutoPlugin {
       "A sequence of workflow steps which publishes the site (default: peaceiris/actions-gh-pages)")
     lazy val tlSitePublishBranch = settingKey[Option[String]](
       "The branch to publish the site from on every push. Set this to None if you only want to update the site on tag releases. (default: main)")
+    lazy val tlSite = taskKey[Unit]("Generate the site (default: runs mdoc then laika)")
   }
 
   import autoImport._
-  import TypelevelKernelPlugin.mkCommand
 
   override def requires = MdocPlugin && LaikaPlugin && GenerativePlugin && NoPublishPlugin
 
@@ -52,6 +53,12 @@ object TypelevelSitePlugin extends AutoPlugin {
   )
 
   override def projectSettings = Seq(
+    tlSite := Def
+      .sequential(
+        mdoc.toTask(""),
+        laikaSite
+      )
+      .value: @nowarn("cat=other-pure-statement"),
     Laika / sourceDirectories := Seq(mdocOut.value),
     laikaTheme := tlSiteHeliumConfig.value.build,
     mdocVariables ++= Map(
@@ -105,7 +112,10 @@ object TypelevelSitePlugin extends AutoPlugin {
       laika.parse.code.SyntaxHighlighting
     ),
     tlSiteGenerate := List(
-      WorkflowStep.Sbt(List("tlSite"), name = Some("Generate site"))
+      WorkflowStep.Sbt(
+        List(s"${thisProject.value.id}/${tlSite.key.toString}"),
+        name = Some("Generate site")
+      )
     ),
     tlSitePublish := List(
       WorkflowStep.Use(
@@ -140,7 +150,7 @@ object TypelevelSitePlugin extends AutoPlugin {
         steps =
           githubWorkflowJobSetup.value.toList ++ tlSiteGenerate.value ++ tlSitePublish.value
       )
-  ) ++ addCommandAlias("tlSite", mkCommand(List("docs/mdoc", "docs/laikaSite")))
+  )
 
   private def getSvgLogo: String = {
     val src = Source.fromURL(getClass.getResource("/logo.svg"))