Add sbt-version-policy

mdedetrich · Sep 12, 2024 · 1e94eaa · 1e94eaa
1 parent 3c19fcf
commit 1e94eaa
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -77,8 +77,8 @@ 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: Report version policy issues
+        run: sbt '++ ${{ matrix.scala }}' versionPolicyCheck
 
       - name: Build project
         run: sbt '++ ${{ matrix.scala }}' clean coverage test

diff --git a/build.sbt b/build.sbt
@@ -12,10 +12,11 @@ val pekkoHttpVersion = "1.0.1"
 val jawnVersion      = "1.6.0"
 val scalaTestVersion = "3.2.19"
 
-ThisBuild / crossScalaVersions := Seq(scala212Version, scala213Version, scala3Version)
-ThisBuild / scalaVersion       := scala213Version
-ThisBuild / organization       := "org.mdedetrich"
-ThisBuild / versionScheme      := Some(VersionScheme.EarlySemVer)
+ThisBuild / crossScalaVersions     := Seq(scala212Version, scala213Version, scala3Version)
+ThisBuild / scalaVersion           := scala213Version
+ThisBuild / organization           := "org.mdedetrich"
+ThisBuild / versionScheme          := Some(VersionScheme.EarlySemVer)
+ThisBuild / versionPolicyIntention := Compatibility.BinaryCompatible
 
 lazy val streamJson = project
   .in(file("stream-json"))
@@ -158,7 +159,7 @@ ThisBuild / scalacOptions ++= {
 ThisBuild / githubWorkflowTargetBranches := Seq("main") // Once we have branches per version, add the pattern here
 
 ThisBuild / githubWorkflowBuild := Seq(
-  WorkflowStep.Sbt(List("mimaReportBinaryIssues"), name = Some("Report binary compatibility issues")),
+  WorkflowStep.Sbt(List("versionPolicyCheck"), name = Some("Report version policy issues")),
   WorkflowStep.Sbt(List("clean", "coverage", "test"), name = Some("Build project"))
 )
 

diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -7,3 +7,4 @@ addSbtPlugin("org.scoverage"                     % "sbt-scoverage"      % "2.2.0
 addSbtPlugin("org.scoverage"                     % "sbt-coveralls"      % "1.3.13")
 addSbtPlugin("com.typesafe"                      % "sbt-mima-plugin"    % "1.1.3")
 addSbtPlugin("com.github.sbt"                    % "sbt-github-actions" % "0.24.0")
+addSbtPlugin("ch.epfl.scala"                     % "sbt-version-policy" % "3.2.1")