Set MIMA plugin for the project (#560)

* Set MIMA plugin for the project

.github/workflows/ci.yml

@@ -65,6 +65,9 @@ jobs:
       - name: Upload Codecov Results
         run: codecov -F ${{ matrix.scala }}
 
+      - name: Binary compatibility check
+        run: sbt ++${{ matrix.scala }} mimaReportBinaryIssues
+
   publish:
     name: Publish Artifacts
     needs: [build]

build.sbt

@@ -10,15 +10,20 @@ val irrecVersion = "0.4.0"
 
 val Scala212 = "2.12.14"
 
+val previousVersion = "0.10.1"
+
 ThisBuild / versionScheme := Some("semver-spec")
 
 ThisBuild / crossScalaVersions := Seq(Scala212)
 ThisBuild / scalaVersion := (ThisBuild / crossScalaVersions).value.last
 
+ThisBuild / mimaFailOnNoPrevious := false
+
 lazy val root = Project("frameless", file("." + "frameless")).in(file("."))
   .aggregate(core, cats, dataset, ml, docs)
   .settings(framelessSettings: _*)
   .settings(noPublishSettings: _*)
+  .settings(mimaPreviousArtifacts := Set())
 
 lazy val core = project
   .settings(name := "frameless-core")
@@ -88,6 +93,7 @@ lazy val docs = project
       "-Ydelambdafy:inline"
     )
   )
+  .settings(mimaPreviousArtifacts := Set())
   .dependsOn(dataset, cats, ml)
 
 lazy val framelessSettings = Seq(
@@ -120,7 +126,8 @@ lazy val framelessSettings = Seq(
     "org.scalacheck" %% "scalacheck" % scalacheck % "test"),
   Test / javaOptions ++= Seq("-Xmx1G", "-ea"),
   Test / fork := true,
-  Test / parallelExecution := false
+  Test / parallelExecution := false,
+  mimaPreviousArtifacts := Set("org.typelevel" %% name.value % previousVersion)
 ) ++ consoleSettings
 
 lazy val consoleSettings = Seq(
@@ -229,6 +236,11 @@ ThisBuild / githubWorkflowBuild := Seq(
   )
 )
 
+ThisBuild / githubWorkflowBuild += WorkflowStep.Sbt(
+  List("mimaReportBinaryIssues"),
+  name = Some("Binary compatibility check")
+)
+
 ThisBuild / githubWorkflowPublishTargetBranches := Seq(
   RefPredicate.Equals(Ref.Branch("master")),
   RefPredicate.StartsWith(Ref.Tag("v"))

project/plugins.sbt

@@ -2,3 +2,4 @@ addSbtPlugin("com.geirsson"   % "sbt-ci-release"     % "1.5.7")
 addSbtPlugin("org.scoverage"  % "sbt-scoverage"      % "1.8.2")
 addSbtPlugin("com.codecommit" % "sbt-github-actions" % "0.13.0")
 addSbtPlugin("org.scalameta"  % "sbt-mdoc"           % "2.2.23")
+addSbtPlugin("com.typesafe"   % "sbt-mima-plugin"    % "1.0.0")