Add a convenient method to compute the highest level of compatibility of all the sub-projects aggregated by a project

sbt-version-policy/src/main/scala/sbtversionpolicy/Compatibility.scala

@@ -90,4 +90,12 @@ object Compatibility {
     }
   }
 
+  // Ordering from the least compatible to the most compatible
+  implicit val ordering: Ordering[Compatibility] =
+    Ordering.by {
+      case Compatibility.None                      => 0
+      case Compatibility.BinaryCompatible          => 1
+      case Compatibility.BinaryAndSourceCompatible => 3
+    }
+
 }

sbt-version-policy/src/main/scala/sbtversionpolicy/SbtVersionPolicyPlugin.scala

@@ -35,4 +35,40 @@ object SbtVersionPolicyPlugin extends AutoPlugin {
       SbtVersionPolicySettings.findIssuesSettings ++
       SbtVersionPolicySettings.skipSettings
 
+  /**
+   * Compute the highest compatibility level satisfied by all the projects aggregated by the
+   * project this task is applied to.
+   * This is useful to know the overall level of compatibility of a multi-module project.
+   * On every aggregated project, it invokes `versionPolicyAssessCompatibility` and keeps
+   * the first result only (ie, it assumes that that task assessed the compatibility with
+   * the latest release only).
+   */
+  val aggregatedAssessedCompatibilityWithLatestRelease: Def.Initialize[Task[Compatibility]] =
+    Def.taskDyn {
+      import autoImport.versionPolicyAssessCompatibility
+      val log = Keys.streams.value.log
+      // Take all the projects aggregated by this project
+      val aggregatedProjects = Keys.thisProject.value.aggregate
+
+      // Compute the highest compatibility level that is satisfied by all the aggregated projects
+      val maxCompatibility: Compatibility = Compatibility.BinaryAndSourceCompatible
+      aggregatedProjects.foldLeft(Def.task { maxCompatibility }) { (highestCompatibilityTask, project) =>
+        Def.task {
+          val highestCompatibility = highestCompatibilityTask.value
+          val compatibilities = (project / versionPolicyAssessCompatibility).value
+          // The most common case is to assess the compatibility with the latest release,
+          // so we look at the first element only and discard the others
+          compatibilities.headOption match {
+            case Some((_, compatibility)) =>
+              log.debug(s"Compatibility of aggregated project ${project.project} is ${compatibility}")
+              // Take the lowest of both
+              Compatibility.ordering.min(highestCompatibility, compatibility)
+            case None =>
+              log.debug(s"Unable to assess the compatibility level of the aggregated project ${project.project}")
+              highestCompatibility
+          }
+        }
+      }
+    }
+
 }

sbt-version-policy/src/sbt-test/sbt-version-policy/aggregate-assessed-compatibility/build.sbt

@@ -0,0 +1,114 @@
+// A project with two modules (“a” and “b”) and a root module that aggregates them
+
+val v1_a =
+  project
+    .settings(
+      name := "aggregated-test-a",
+      version := "1.0.0",
+    )
+
+val v1_b =
+  project
+    .settings(
+      name := "aggregated-test-b",
+      version := "1.0.0",
+    )
+
+val v1_root =
+  project
+    .settings(
+      name := "aggregated-test-root",
+      publish / skip := true,
+    )
+    .aggregate(v1_a, v1_b)
+
+
+// First round of evolutions
+// No changes in v2_a
+val v2_a =
+  project
+    .settings(
+      name := "aggregated-test-a",
+      version := "1.0.0+n",
+    )
+
+// Small changes that don’t break the binary and source compatibility
+val v2_b =
+  project
+    .settings(
+      name := "aggregated-test-b",
+      version := "1.0.0+n",
+    )
+
+val v2_root =
+  project
+    .settings(
+      name := "aggregated-test-root",
+      publish / skip := true,
+      TaskKey[Unit]("check") := {
+        val compatibility = SbtVersionPolicyPlugin.aggregatedAssessedCompatibilityWithLatestRelease.value
+        assert(compatibility == Compatibility.BinaryAndSourceCompatible)
+      }
+    )
+    .aggregate(v2_a, v2_b)
+
+
+// Second round of evolutions
+// Introduction of a public member
+val v3_a =
+  project
+    .settings(
+      name := "aggregated-test-a",
+      version := "1.0.0+n",
+    )
+
+// No changes
+val v3_b =
+  project
+    .settings(
+      name := "aggregated-test-b",
+      version := "1.0.0+n",
+    )
+
+val v3_root =
+  project
+    .settings(
+      name := "aggregated-test-root",
+      publish / skip := true,
+      TaskKey[Unit]("check") := {
+        val compatibility = SbtVersionPolicyPlugin.aggregatedAssessedCompatibilityWithLatestRelease.value
+        assert(compatibility == Compatibility.BinaryCompatible)
+      }
+    )
+    .aggregate(v3_a, v3_b)
+
+// Third round of evolutions
+// Introduction of a public member
+val v4_a =
+  project
+    .settings(
+      name := "aggregated-test-a",
+      version := "1.0.0+n",
+    )
+
+// Removal of a public member
+val v4_b =
+  project
+    .settings(
+      name := "aggregated-test-b",
+      version := "1.0.0+n",
+    )
+
+val v4_root =
+  project
+    .settings(
+      name := "aggregated-test-root",
+      publish / skip := true,
+      TaskKey[Unit]("check") := {
+        val compatibility = SbtVersionPolicyPlugin.aggregatedAssessedCompatibilityWithLatestRelease.value
+        assert(compatibility == Compatibility.None)
+      }
+    )
+    .aggregate(v4_a, v4_b)
+
+

sbt-version-policy/src/sbt-test/sbt-version-policy/aggregate-assessed-compatibility/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("ch.epfl.scala" % "sbt-version-policy" % sys.props("plugin.version"))

sbt-version-policy/src/sbt-test/sbt-version-policy/aggregate-assessed-compatibility/test

@@ -0,0 +1,7 @@
+> v1_root/publishLocal
+
+> v2_root/check
+
+> v3_root/check
+
+> v4_root/check

sbt-version-policy/src/sbt-test/sbt-version-policy/aggregate-assessed-compatibility/v1_a/src/main/scala/pkg/A.scala

@@ -0,0 +1,7 @@
+package pkg
+
+object A {
+
+  val x: Int = 42
+
+}

sbt-version-policy/src/sbt-test/sbt-version-policy/aggregate-assessed-compatibility/v1_b/src/main/scala/pkg/B.scala

@@ -0,0 +1,5 @@
+package pkg
+
+object B {
+
+}

sbt-version-policy/src/sbt-test/sbt-version-policy/aggregate-assessed-compatibility/v2_a/src/main/scala/pkg/A.scala

@@ -0,0 +1,7 @@
+package pkg
+
+object A {
+
+  val x: Int = 42
+
+}

sbt-version-policy/src/sbt-test/sbt-version-policy/aggregate-assessed-compatibility/v2_b/src/main/scala/pkg/B.scala

@@ -0,0 +1,7 @@
+package pkg
+
+object B {
+
+  private val b: String = "b"
+
+}

sbt-version-policy/src/sbt-test/sbt-version-policy/aggregate-assessed-compatibility/v3_a/src/main/scala/pkg/A.scala

@@ -0,0 +1,9 @@
+package pkg
+
+object A {
+
+  val x: Int = 42
+
+  val y: Int = 0
+
+}

sbt-version-policy/src/sbt-test/sbt-version-policy/aggregate-assessed-compatibility/v3_b/src/main/scala/pkg/B.scala

@@ -0,0 +1,7 @@
+package pkg
+
+object B {
+
+  private val b: String = "b"
+
+}

sbt-version-policy/src/sbt-test/sbt-version-policy/aggregate-assessed-compatibility/v4_a/src/main/scala/pkg/A.scala

@@ -0,0 +1,9 @@
+package pkg
+
+object A {
+
+  val x: Int = 42
+
+  val y: Int = 0
+
+}

sbt-version-policy/src/sbt-test/sbt-version-policy/aggregate-assessed-compatibility/v4_b/src/main/scala/pkg/B.scala

@@ -0,0 +1,3 @@
+package pkg
+
+object C