From ed8ffa1ef24b86a701732faf47b8481c2954377b Mon Sep 17 00:00:00 2001 From: Michel Davit Date: Thu, 2 Mar 2023 16:48:52 +0100 Subject: [PATCH] Setup MiMa filter for planed breaking changes --- build.sbt | 13 +++++++++++++ site/src/main/paradox/dev/How-to-Release.md | 1 + 2 files changed, 14 insertions(+) diff --git a/build.sbt b/build.sbt index 52afafd83d..a522f81584 100644 --- a/build.sbt +++ b/build.sbt @@ -19,6 +19,7 @@ import sbt._ import Keys._ import sbtassembly.AssemblyPlugin.autoImport._ import com.github.sbt.git.SbtGit.GitKeys.gitRemoteRepo +import com.typesafe.tools.mima.core._ import org.scalafmt.sbt.ScalafmtPlugin.scalafmtConfigSettings import bloop.integrations.sbt.BloopDefaults import de.heikoseeberger.sbtheader.CommentCreator @@ -186,6 +187,18 @@ def previousVersion(currentVersion: String): Option[String] = { } lazy val mimaSettings = Def.settings( + mimaBinaryIssueFilters := Seq( + // minor scio-tensorflow breaking changes for 0.12.6 + ProblemFilters.exclude[DirectMissingMethodProblem]( + "com.spotify.scio.tensorflow.syntax.SeqExampleSCollectionOps.saveAsTfRecordFile$extension" + ), + ProblemFilters.exclude[DirectMissingMethodProblem]( + "com.spotify.scio.tensorflow.syntax.SeqExampleSCollectionOps.saveAsTfRecordFile" + ), + ProblemFilters.exclude[DirectMissingMethodProblem]( + "com.spotify.scio.tensorflow.syntax.SeqExampleSCollectionOps.saveAsTfRecordFile$extension" + ) + ), mimaPreviousArtifacts := previousVersion(version.value) .filter(_ => publishArtifact.value) diff --git a/site/src/main/paradox/dev/How-to-Release.md b/site/src/main/paradox/dev/How-to-Release.md index 7ea03ae000..e92b572d66 100644 --- a/site/src/main/paradox/dev/How-to-Release.md +++ b/site/src/main/paradox/dev/How-to-Release.md @@ -51,6 +51,7 @@ git push origin vX.Y.Z ## After successfully published artifacts +- Clean the `mimaBinaryIssueFilters` in `build.sbt` - Run @github[scripts/bump_scio.sh](/scripts/bump_scio.sh) to update [homebrew formula](https://github.com/spotify/homebrew-public/blob/master/scio.rb) and `scioVersion` in downstream repos including [scio.g8](https://github.com/spotify/scio.g8), [featran](https://github.com/spotify/featran), etc. - Send external announcement to scio-users@googlegroups.com and user@beam.apache.org - Announce on public [Slack](https://slackin.spotify.com/)