Extract out a GitHub plugin

.github/workflows/ci.yml

@@ -61,7 +61,7 @@ jobs:
       - run: sbt ++${{ matrix.scala }} ci
 
       - name: Compress target directories
-        run: tar cf targets.tar kernel/target versioning/target ci-release/target target ci-signing/target mima/target no-publish/target sonatype/target ci/target sonatype-ci-release/target core/target settings/target project/target
+        run: tar cf targets.tar github/target kernel/target versioning/target ci-release/target target ci-signing/target mima/target no-publish/target sonatype/target ci/target sonatype-ci-release/target core/target settings/target project/target
 
       - name: Upload target directories
         uses: actions/upload-artifact@v2

build.sbt

@@ -11,16 +11,11 @@ ThisBuild / tlCiReleaseSnapshots := true
 ThisBuild / tlCiReleaseBranches := Seq("main")
 
 ThisBuild / developers := List(
-  Developer("armanbilge", "Arman Bilge", "@armanbilge", url("https://github.com/armanbilge")),
-  Developer("rossabaker", "Ross A. Baker", "@rossabaker", url("https://github.com/rossabaker")),
-  Developer(
-    "ChristopherDavenport",
-    "Christopher Davenport",
-    "@ChristopherDavenport",
-    url("https://github.com/ChristopherDavenport")),
-  Developer("djspiewak", "Daniel Spiewak", "@djspiewak", url("https://github.com/djspiewak"))
+  tlGitHubDev("armanbilge", "Arman Bilge"),
+  tlGitHubDev("rossabaker", "Ross A. Baker"),
+  tlGitHubDev("ChristopherDavenport", "Christopher Davenport"),
+  tlGitHubDev("djspiewak", "Daniel Spiewak")
 )
-ThisBuild / homepage := Some(url("https://github.com/typelevel/sbt-typelevel"))
 ThisBuild / licenses += "Apache-2.0" -> url("http://www.apache.org/licenses/")
 
 lazy val root = project
@@ -30,6 +25,7 @@ lazy val root = project
     kernel,
     noPublish,
     settings,
+    github,
     versioning,
     mima,
     sonatype,
@@ -61,6 +57,14 @@ lazy val settings = project
   )
   .dependsOn(kernel)
 
+lazy val github = project
+  .in(file("github"))
+  .enablePlugins(SbtPlugin)
+  .settings(
+    name := "sbt-typelevel-github"
+  )
+  .dependsOn(kernel)
+
 lazy val versioning = project
   .in(file("versioning"))
   .enablePlugins(SbtPlugin)

github/build.sbt

@@ -0,0 +1,2 @@
+addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.7.1")
+addSbtPlugin("com.typesafe.sbt" % "sbt-git" % "1.0.2")

github/src/main/scala/org/typelevel/sbt/TypelevelGitHubPlugin.scala

@@ -0,0 +1,52 @@
+package org.typelevel.sbt
+
+import sbt._, Keys._
+
+import scala.util.Try
+
+object TypelevelGitHubPlugin extends AutoPlugin {
+
+  override def trigger = allRequirements
+  override def requires = TypelevelKernelPlugin
+
+  object autoImport {
+
+    /**
+     * Helper to create a `Developer` entry from a GitHub username.
+     */
+    def tlGitHubDev(user: String, fullName: String): Developer = {
+      Developer(user, fullName, s"@$user", url(s"https://github.com/$user"))
+    }
+  }
+
+  override def buildSettings = Seq(
+    scmInfo := getScmInfo(),
+    homepage := homepage.value.orElse(scmInfo.value.map(_.browseUrl))
+  )
+
+  def getScmInfo(): Option[ScmInfo] = {
+    import scala.sys.process._
+
+    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"
+      )
+
+    val identifier = """([^\/]+?)"""
+    val GitHubHttps = s"https://github.com/$identifier/$identifier(?:\\.git)?".r
+    val GitHubGit = s"git://github.com:$identifier/$identifier(?:\\.git)?".r
+    val GitHubSsh = s"git@github.com:$identifier/$identifier(?:\\.git)?".r
+    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 _ => None
+      }
+    }.toOption.flatten
+  }
+
+}

settings/src/main/scala/org/typelevel/sbt/TypelevelScalaJSSettingsPlugin.scala → github/src/main/scala/org/typelevel/sbt/TypelevelScalaJSGitHubPlugin.scala

@@ -3,10 +3,11 @@ package org.typelevel.sbt
 import sbt._, Keys._
 import org.scalajs.sbtplugin.ScalaJSPlugin
 import com.typesafe.sbt.SbtGit.git
+import org.typelevel.sbt.kernel.GitHelper
 
-object TypelevelScalaJSSettingsPlugin extends AutoPlugin {
+object TypelevelScalaJSGitHubPlugin extends AutoPlugin {
   override def trigger = allRequirements
-  override def requires = ScalaJSPlugin && TypelevelSettingsPlugin
+  override def requires = ScalaJSPlugin && TypelevelKernelPlugin
 
   import TypelevelKernelPlugin.autoImport._
 
@@ -15,7 +16,7 @@ object TypelevelScalaJSSettingsPlugin extends AutoPlugin {
       val flag = if (tlIsScala3.value) "-scalajs-mapSourceURI:" else "-P:scalajs:mapSourceURI:"
 
       val tagOrHash =
-        TypelevelSettingsPlugin.getTagOrHash(git.gitCurrentTags.value, git.gitHeadCommit.value)
+        GitHelper.getTagOrHash(git.gitCurrentTags.value, git.gitHeadCommit.value)
 
       val l = (LocalRootProject / baseDirectory).value.toURI.toString
 

kernel/src/main/scala/org/typelevel/sbt/kernel/GitHelper.scala

@@ -19,4 +19,7 @@ object GitHelper {
     }.getOrElse(List.empty).sorted.reverse
   }
 
+  def getTagOrHash(tags: Seq[String], hash: Option[String]): Option[String] =
+    tags.collect { case v @ V.Tag(_) => v }.headOption.orElse(hash)
+
 }

project/github.sbt

@@ -0,0 +1 @@
+../github/build.sbt

project/src/main/scala/github

@@ -0,0 +1 @@
+../../../../github/

settings/build.sbt

@@ -1,3 +1 @@
-addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.8.0")
-addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.4.2")
 addSbtPlugin("com.typesafe.sbt" % "sbt-git" % "1.0.2")

settings/src/main/scala/org/typelevel/sbt/TypelevelSettingsPlugin.scala

@@ -4,8 +4,7 @@ import sbt._, Keys._
 import com.typesafe.sbt.GitPlugin
 import com.typesafe.sbt.SbtGit.git
 import org.typelevel.sbt.kernel.V
-
-import scala.util.Try
+import org.typelevel.sbt.kernel.GitHelper
 
 object TypelevelSettingsPlugin extends AutoPlugin {
   override def trigger = allRequirements
@@ -24,10 +23,6 @@ object TypelevelSettingsPlugin extends AutoPlugin {
     Def.derive(scalaVersion := crossScalaVersions.value.last, default = true)
   )
 
-  override def buildSettings = Seq(
-    scmInfo := getScmInfo()
-  )
-
   override def projectSettings = Seq(
     versionScheme := Some("early-semver"),
     pomIncludeRepository := { _ => false },
@@ -137,7 +132,8 @@ object TypelevelSettingsPlugin extends AutoPlugin {
         Seq("-sourcepath", (LocalRootProject / baseDirectory).value.getAbsolutePath)
       else {
 
-        val tagOrHash = getTagOrHash(git.gitCurrentTags.value, git.gitHeadCommit.value)
+        val tagOrHash =
+          GitHelper.getTagOrHash(git.gitCurrentTags.value, git.gitHeadCommit.value)
 
         val infoOpt = scmInfo.value
         tagOrHash.toSeq flatMap { vh =>
@@ -165,32 +161,4 @@ object TypelevelSettingsPlugin extends AutoPlugin {
     }
   )
 
-  def getTagOrHash(tags: Seq[String], hash: Option[String]): Option[String] =
-    tags.collect { case v @ V.Tag(_) => v }.headOption.orElse(hash)
-
-  def getScmInfo(): Option[ScmInfo] = {
-    import scala.sys.process._
-
-    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"
-      )
-
-    val identifier = """([^\/]+?)"""
-    val GitHubHttps = s"https://github.com/$identifier/$identifier(?:\\.git)?".r
-    val GitHubGit = s"git://github.com:$identifier/$identifier(?:\\.git)?".r
-    val GitHubSsh = s"git@github.com:$identifier/$identifier(?:\\.git)?".r
-    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 _ => None
-      }
-    }.toOption.flatten
-  }
-
 }