Enable scoverage in github actions and add coveralls plus badge

Author: mdedetrich

.github/workflows/ci.yml

@@ -52,4 +52,10 @@ jobs:
         run: sbt ++${{ matrix.scala }} githubWorkflowCheck
 
       - 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,6 +1,7 @@
 # decline
 
 [![Build Status](https://travis-ci.org/bkirwi/decline.svg?branch=master)](https://travis-ci.org/bkirwi/decline)
+[![Coverage Status](https://coveralls.io/repos/github/bkirwi/decline/badge.svg?branch=master)](https://coveralls.io/github/bkirwi/decline?branch=master)
 
 A composable command-line parser, inspired by [`optparse-applicative`][optparse]
 and built on [`cats`][cats].

build.sbt

@@ -12,8 +12,24 @@ lazy val Scala3 = "3.0.1"
 
 ThisBuild / scalaVersion := Scala212
 ThisBuild / crossScalaVersions := List(Scala212, Scala213, Scala3)
+ThisBuild / githubWorkflowBuild := Seq(
+  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 }}"
+    )
+  )
+)
 ThisBuild / githubWorkflowArtifactUpload := false
 ThisBuild / githubWorkflowPublishTargetBranches := Seq()
+// This is causing problems with env variables being passed in, see
+// https://github.com/sbt/sbt/issues/6468
 ThisBuild / githubWorkflowUseSbtThinClient := false
 
 val defaultSettings = Seq(

project/plugins.sbt

@@ -8,5 +8,6 @@ addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.5.1")
 addSbtPlugin("org.scalameta" % "sbt-mdoc" % "2.2.21")
 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.3")
 addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.8.2")
+addSbtPlugin("org.scoverage" % "sbt-coveralls" % "1.3.1")
 addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "3.9.7")
 addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.4.0")