pekko/project/MiMa.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 = 13

  override def requires = MimaPlugin
  override def trigger = allRequirements

  override val projectSettings = Seq(
    mimaReportSignatureProblems := true,
    mimaPreviousArtifacts := akkaPreviousArtifacts(name.value, organization.value, scalaBinaryVersion.value))

  def akkaPreviousArtifacts(
      projectName: String,
      organization: String,
      scalaBinaryVersion: String): Set[sbt.ModuleID] = {

    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")
}