Merge pull request #124 from armanbilge/topic/site-improvements

site plugin improvements
typelevel · Feb 10, 2022 · ccdeb45 · ccdeb45
2 parents db9a006 + 2ede5fe
commit ccdeb45
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 18 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -191,4 +191,4 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: mdocs/target/docs/site
-          publish_branch: gh-pages
+          keep_files: true
diff --git a/build.sbt b/build.sbt
@@ -147,7 +147,7 @@ lazy val site = project
   .settings(
     name := "sbt-typelevel-site"
   )
-  .dependsOn(kernel, githubActions, noPublish)
+  .dependsOn(kernel, github, githubActions, noPublish)
 
 lazy val docs = project
   .in(file("mdocs"))

diff --git a/github/src/main/scala/org/typelevel/sbt/TypelevelGitHubPlugin.scala b/github/src/main/scala/org/typelevel/sbt/TypelevelGitHubPlugin.scala
@@ -33,22 +33,30 @@ object TypelevelGitHubPlugin extends AutoPlugin {
     def tlGitHubDev(user: String, fullName: String): Developer = {
       Developer(user, fullName, s"@$user", url(s"https://github.com/$user"))
     }
+
+    lazy val tlGitHubRepo = settingKey[Option[String]]("The name of this repository on GitHub")
   }
 
+  import autoImport._
+
   override def buildSettings = Seq(
-    scmInfo := getScmInfo(),
+    tlGitHubRepo := gitHubUserRepo.value.map(_._2),
+    scmInfo := gitHubUserRepo.value.map {
+      case (user, repo) =>
+        gitHubScmInfo(user, repo)
+    },
     homepage := homepage.value.orElse(scmInfo.value.map(_.browseUrl))
   )
 
-  private def getScmInfo(): Option[ScmInfo] = {
-    import scala.sys.process._
+  private def gitHubScmInfo(user: String, repo: String) =
+    ScmInfo(
+      url(s"https://github.com/$user/$repo"),
+      s"scm:git:https://github.com/$user/$repo.git",
+      s"scm:git:git@github.com:$user/$repo.git"
+    )
 
-    def gitHubScmInfo(user: String, repo: String) =
-      ScmInfo(
-        url(s"https://github.com/$user/$repo"),
-        s"scm:git:https://github.com/$user/$repo.git",
-        s"scm:git:git@github.com:$user/$repo.git"
-      )
+  private[sbt] def gitHubUserRepo = Def.setting {
+    import scala.sys.process._
 
     val identifier = """([^\/]+?)"""
     val GitHubHttps = s"https://github.com/$identifier/$identifier(?:\\.git)?".r
@@ -57,9 +65,9 @@ object TypelevelGitHubPlugin extends AutoPlugin {
     Try {
       val remote = List("git", "ls-remote", "--get-url", "origin").!!.trim()
       remote match {
-        case GitHubHttps(user, repo) => Some(gitHubScmInfo(user, repo))
-        case GitHubGit(user, repo) => Some(gitHubScmInfo(user, repo))
-        case GitHubSsh(user, repo) => Some(gitHubScmInfo(user, repo))
+        case GitHubHttps(user, repo) => Some((user, repo))
+        case GitHubGit(user, repo) => Some((user, repo))
+        case GitHubSsh(user, repo) => Some((user, repo))
         case _ => None
       }
     }.toOption.flatten

diff --git a/site/src/main/scala/org/typelevel/sbt/TypelevelSitePlugin.scala b/site/src/main/scala/org/typelevel/sbt/TypelevelSitePlugin.scala
@@ -34,6 +34,8 @@ object TypelevelSitePlugin extends AutoPlugin {
   object autoImport {
     lazy val tlSiteHeliumConfig = settingKey[Helium]("The Helium configuration")
     lazy val tlSiteApiUrl = settingKey[Option[URL]]("URL to the API docs")
+    lazy val tlSiteKeepFiles =
+      settingKey[Boolean]("Whether to keep existing files when deploying site (default: true)")
     lazy val tlSiteGenerate = settingKey[Seq[WorkflowStep]](
       "A sequence of workflow steps which generates the site (default: [Sbt(List(\"tlSite\"))])")
     lazy val tlSitePublish = settingKey[Seq[WorkflowStep]](
@@ -44,12 +46,21 @@ object TypelevelSitePlugin extends AutoPlugin {
   }
 
   import autoImport._
+  import TypelevelGitHubPlugin._
 
-  override def requires = MdocPlugin && LaikaPlugin && GenerativePlugin && NoPublishPlugin
+  override def requires =
+    MdocPlugin && LaikaPlugin && TypelevelGitHubPlugin && GenerativePlugin && NoPublishPlugin
 
   override def buildSettings = Seq(
     tlSitePublishBranch := Some("main"),
-    tlSiteApiUrl := None
+    tlSiteApiUrl := None,
+    tlSiteKeepFiles := true,
+    homepage := {
+      gitHubUserRepo.value.map {
+        case ("typelevel", repo) => url(s"https://typelevel.org/$repo")
+        case (user, repo) => url(s"https://$user.github.io/$repo")
+      }
+    }
   )
 
   override def projectSettings = Seq(
@@ -63,7 +74,7 @@ object TypelevelSitePlugin extends AutoPlugin {
     laikaTheme := tlSiteHeliumConfig.value.build,
     mdocVariables ++= Map(
       "VERSION" -> GitHelper
-        .previousReleases()
+        .previousReleases(fromHead = true)
         .filterNot(_.isPrerelease)
         .headOption
         .fold(version.value)(_.toString),
@@ -128,7 +139,7 @@ object TypelevelSitePlugin extends AutoPlugin {
             .toAbsolutePath
             .relativize(((Laika / target).value / "site").toPath)
             .toString,
-          "publish_branch" -> "gh-pages"
+          "keep_files" -> tlSiteKeepFiles.value.toString
         ),
         name = Some("Publish site"),
         cond = {