mima check

Author: pjfanning

.github/workflows/ci.yml

@@ -62,8 +62,7 @@ jobs:
       - name: Check that workflows are up to date
         run: sbt -J-Xmx2G '++ ${{ matrix.scala }}' githubWorkflowCheck
 
-      - name: Build project
-        run: sbt -J-Xmx2G '++ ${{ matrix.scala }}' test
+      - run: sbt -J-Xmx2G '++ ${{ matrix.scala }}' test mimaReportBinaryIssues
 
       - name: Compress target directories
         run: tar cf targets.tar target project/target

build.sbt

@@ -1,4 +1,5 @@
 import sbtghactions.JavaSpec.Distribution.Zulu
+import com.typesafe.tools.mima.core._
 import com.github.sbt.sbom._
 import xerial.sbt.Sonatype.sonatypeCentralHost
 
@@ -62,6 +63,8 @@ scalaMajorVersion := {
   }
 }
 
+mimaPreviousArtifacts := Set(organization.value %% name.value % "3.0.0")
+
 scalacOptions ++= Seq("-deprecation", "-unchecked", "-feature")
 
 // Temporarily disable warnings as error since SerializationFeature.WRITE_NULL_MAP_VALUES has been deprecated
@@ -134,6 +137,7 @@ Test / parallelExecution := false
 
 ThisBuild / githubWorkflowSbtCommand := "sbt -J-Xmx2G"
 ThisBuild / githubWorkflowJavaVersions := Seq(JavaSpec(Zulu, "17"), JavaSpec(Zulu, "21"), JavaSpec(Zulu, "25"))
+ThisBuild / githubWorkflowBuild := Seq(WorkflowStep.Sbt(List("test", "mimaReportBinaryIssues")))
 ThisBuild / githubWorkflowTargetBranches := Seq("3.x", "3.0")
 ThisBuild / githubWorkflowTargetTags ++= Seq("v*")
 ThisBuild / githubWorkflowPublishTargetBranches :=
@@ -160,3 +164,18 @@ enablePlugins(ReproducibleBuildsPlugin)
 enablePlugins(SiteScaladocPlugin)
 //enablePlugins(GhpagesPlugin)
 git.remoteRepo := "git@github.com:FasterXML/jackson-module-scala.git"
+
+mimaBinaryIssueFilters ++= Seq(
+  ProblemFilters.exclude[DirectMissingMethodProblem]("tools.jackson.module.scala.ser.IterableSerializer.withResolved"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("tools.jackson.module.scala.ser.ResolvedIterableSerializer.withResolved"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("tools.jackson.module.scala.ser.ResolvedIterableSerializer.this"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("tools.jackson.module.scala.ser.ResolvedIteratorSerializer.withResolved"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("tools.jackson.module.scala.ser.ResolvedIteratorSerializer.this"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("tools.jackson.module.scala.ser.ScalaIterableSerializer.*"),
+  ProblemFilters.exclude[MissingTypesProblem]("tools.jackson.module.scala.ser.ScalaIterableSerializer$"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("tools.jackson.module.scala.ser.ScalaIteratorSerializer.*"),
+  ProblemFilters.exclude[MissingTypesProblem]("tools.jackson.module.scala.ser.ScalaIteratorSerializer$"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("tools.jackson.module.scala.ser.UnresolvedIterableSerializer.withResolved"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("tools.jackson.module.scala.ser.UnresolvedIteratorSerializer.withResolved"),
+  ProblemFilters.exclude[DirectMissingMethodProblem]("tools.jackson.module.scala.ser.IteratorSerializer.withResolved")
+)