pekko/project/MiMa.scala
Johan Andrén 5dc6755ad2
Add CI check for wrong mima filter directories (#31088)
And fix incorrect filter mima directory for 31055
2022-02-02 11:08:48 +01:00

85 lines
3.2 KiB
Scala

/*
* Copyright (C) 2009-2021 Lightbend Inc. <https://www.lightbend.com>
*/
package akka
import scala.collection.immutable
import sbt._
import sbt.Keys._
import com.typesafe.tools.mima.plugin.MimaPlugin
import com.typesafe.tools.mima.plugin.MimaPlugin.autoImport._
object MiMa extends AutoPlugin {
private val latestPatchOf25 = 32
private val latestPatchOf26 = 18
override def requires = MimaPlugin
override def trigger = allRequirements
val checkMimaFilterDirectories =
taskKey[Unit]("Check that the mima directories are correct compared to latest version")
override val projectSettings = Seq(
mimaReportSignatureProblems := true,
mimaPreviousArtifacts := akkaPreviousArtifacts(name.value, organization.value, scalaBinaryVersion.value),
checkMimaFilterDirectories := checkFilterDirectories(baseDirectory.value))
def checkFilterDirectories(moduleRoot: File): Unit = {
val nextVersionFilterDir = moduleRoot / "src" / "main" / "mima-filters" / s"2.6.${latestPatchOf26 + 1}.backwards.excludes"
if (nextVersionFilterDir.exists()) {
throw new IllegalArgumentException(s"Incorrect mima filter directory exists: '${nextVersionFilterDir}' " +
s"should be with number from current release '${moduleRoot / "src" / "main" / "mima-filters" / s"2.6.${latestPatchOf26}.backwards.excludes"}")
}
}
def akkaPreviousArtifacts(
projectName: String,
organization: String,
scalaBinaryVersion: String): Set[sbt.ModuleID] = {
if (scalaBinaryVersion.startsWith("3")) {
// No binary compatibility for 3.0 artifacts for now - experimental
Set.empty
} else {
val versions: Seq[String] = {
val firstPatchOf25 =
if (scalaBinaryVersion.startsWith("2.13")) 25
else if (projectName.contains("discovery")) 19
else if (projectName.contains("coordination")) 22
else 0
val akka25Previous =
if (!(projectName.contains("typed") || projectName.contains("jackson"))) {
// 2.5.18 is the only release built with Scala 2.12.7, which due to
// https://github.com/scala/bug/issues/11207 produced many more
// static methods than expected. These are hard to filter out, so
// we exclude it here and rely on the checks for 2.5.17 and 2.5.19.
// Additionally, 2.5.30 had some problems related to
// https://github.com/akka/akka/issues/28807
expandVersions(2, 5, ((firstPatchOf25 to latestPatchOf25).toSet - 18 - 30).toList)
} else {
Nil
}
val akka26Previous = expandVersions(2, 6, 0 to latestPatchOf26)
akka25Previous ++ akka26Previous
}
val akka25PromotedArtifacts = Set("akka-distributed-data")
// check against all binary compatible artifacts
versions.map { v =>
val adjustedProjectName =
if (akka25PromotedArtifacts(projectName) && v.startsWith("2.4"))
projectName + "-experimental"
else
projectName
organization %% adjustedProjectName % v
}.toSet
}
}
private def expandVersions(major: Int, minor: Int, patches: immutable.Seq[Int]): immutable.Seq[String] =
patches.map(patch => s"$major.$minor.$patch")
}