Add mima and sbt coveralls

Author: mdedetrich

.github/workflows/ci.yml

@@ -51,5 +51,14 @@ jobs:
       - name: Check that workflows are up to date
         run: sbt ++${{ matrix.scala }} githubWorkflowCheck
 
+      - name: Report binary compatibility issues
+        run: sbt ++${{ matrix.scala }} mimaReportBinaryIssues
+
       - name: Build project
-        run: sbt ++${{ matrix.scala }} test
+        run: sbt ++${{ matrix.scala }} clean coverage test
+
+      - name: Upload coverage data to Coveralls
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_FLAG_NAME: Scala ${{ matrix.scala }}
+        run: sbt ++${{ matrix.scala }} coverageReport coverageAggregate coveralls

README.md

@@ -1,3 +1,5 @@
+[![Coverage Status](https://coveralls.io/repos/github/mdedetrich/webmodels/badge.svg?branch=master)](https://coveralls.io/github/mdedetrich/webmodels?branch=master)
+
 ## Webmodels
 
 Webmodels is a scala library with a collection of Scala models/constants that are relevant to modern HTTP programming.

build.sbt

@@ -22,8 +22,9 @@ val flagsFor13 = Seq(
   "-opt:l:method"
 )
 
-ThisBuild / crossScalaVersions := Seq(currentScalaVersion, scala213Version)
-ThisBuild / scalaVersion       := (ThisBuild / crossScalaVersions).value.last
+ThisBuild / crossScalaVersions   := Seq(currentScalaVersion, scala213Version)
+ThisBuild / scalaVersion         := (ThisBuild / crossScalaVersions).value.last
+ThisBuild / mimaFailOnNoPrevious := false // Set this to true when we start caring about binary compatibility
 
 ThisBuild / Test / scalacOptions += "-Yrangepos"
 
@@ -86,6 +87,25 @@ lazy val webmodels = crossProject(JSPlatform, JVMPlatform)
 lazy val webmodelsJVM = webmodels.jvm
 lazy val webmodelsJS  = webmodels.js
 
-ThisBuild / githubWorkflowPublishTargetBranches := Seq()
-// This is set to false due to https://github.com/sbt/sbt/issues/6468
+ThisBuild / githubWorkflowBuild := Seq(
+  WorkflowStep.Sbt(List("mimaReportBinaryIssues"), name = Some("Report binary compatibility issues")),
+  WorkflowStep.Sbt(List("clean", "coverage", "test"), name = Some("Build project"))
+)
+
+ThisBuild / githubWorkflowBuildPostamble ++= Seq(
+  // See https://github.com/scoverage/sbt-coveralls#github-actions-integration
+  WorkflowStep.Sbt(
+    List("coverageReport", "coverageAggregate", "coveralls"),
+    name = Some("Upload coverage data to Coveralls"),
+    env = Map(
+      "COVERALLS_REPO_TOKEN" -> "${{ secrets.GITHUB_TOKEN }}",
+      "COVERALLS_FLAG_NAME"  -> "Scala ${{ matrix.scala }}"
+    )
+  )
+)
+
+// This is causing problems with env variables being passed in, see
+// https://github.com/sbt/sbt/issues/6468
 ThisBuild / githubWorkflowUseSbtThinClient := false
+
+ThisBuild / githubWorkflowPublishTargetBranches := Seq()

project/plugins.sbt

@@ -1,6 +1,9 @@
 addSbtPlugin("org.scala-js"       % "sbt-scalajs"              % "1.6.0")
 addSbtPlugin("org.portable-scala" % "sbt-scalajs-crossproject" % "1.1.0")
 addSbtPlugin("org.scalameta"      % "sbt-scalafmt"             % "2.4.2")
+addSbtPlugin("org.scoverage"      % "sbt-scoverage"            % "1.8.2")
+addSbtPlugin("org.scoverage"      % "sbt-coveralls"            % "1.3.1")
+addSbtPlugin("com.typesafe"       % "sbt-mima-plugin"          % "0.9.2")
 addSbtPlugin("com.github.sbt"     % "sbt-pgp"                  % "2.1.2")
 addSbtPlugin("org.xerial.sbt"     % "sbt-sonatype"             % "3.9.7")
 addSbtPlugin("com.codecommit"     % "sbt-github-actions"       % "0.12.0")