Skip to content

Commit

Permalink
Waive false binary compatibility failure
Browse files Browse the repository at this point in the history
Also move waivers from files to build.sbt.
  • Loading branch information
jackkoenig committed May 23, 2024
1 parent d70ca23 commit eee9420
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 11 deletions.
14 changes: 12 additions & 2 deletions build.sbt
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
// See LICENSE for license details.

import com.typesafe.tools.mima.core._

enablePlugins(SiteScaladocPlugin)

addCommandAlias("fmt", "; scalafmtAll ; scalafmtSbt")
addCommandAlias("fmtCheck", "; scalafmtCheckAll ; scalafmtSbtCheck")

// Previous versions are read from project/previous-versions.txt
// If this file is empty or does not exist, no binary compatibility checking will be done
// Add waivers to the directory defined by key `mimaFiltersDirectory` in files named: <since version>.backwards.excludes
// eg. unipublish/src/main/mima-filters/5.0.0.backwards.excludes
// Add waivers to mimaBinaryIssueFilters below.
val previousVersions = settingKey[Set[String]]("Previous versions for binary compatibility checking")
ThisBuild / previousVersions := {
val file = new java.io.File("project", "previous-versions.txt")
Expand Down Expand Up @@ -378,6 +379,15 @@ lazy val unipublish =
},
// This is a pseudo-project with no class files, use the package jar instead
mimaCurrentClassfiles := (Compile / packageBin).value,
// MiMa waivers
mimaBinaryIssueFilters ++= Seq(
// chisel3.properties.Path is sealed
ProblemFilters.exclude[ReversedAbstractMethodProblem]("chisel3.properties.Path.convert"),
// chisel3.HasTarget is sealed
ProblemFilters.exclude[ReversedMissingMethodProblem]("chisel3.package#HasTarget.suggestName"),
// chisel3.internal.firrtl.ir.LitArg is package private
ProblemFilters.exclude[ReversedMissingMethodProblem]("chisel3.internal.firrtl.ir#LitArg.cloneWithValue"),
),
// Forward doc command to unidoc
Compile / doc := (ScalaUnidoc / doc).value,
// Include unidoc as the ScalaDoc for publishing
Expand Down
2 changes: 0 additions & 2 deletions unipublish/src/main/mima-filters/6.0.0.backwards.excludes

This file was deleted.

5 changes: 0 additions & 5 deletions unipublish/src/main/mima-filters/6.1.0.backwards.excludes

This file was deleted.

2 changes: 0 additions & 2 deletions unipublish/src/main/mima-filters/6.2.0.backwards.excludes

This file was deleted.

0 comments on commit eee9420

Please sign in to comment.