Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup MiMa filter for planed breaking changes #4733

Merged
merged 1 commit into from
Mar 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down
1 change: 1 addition & 0 deletions site/src/main/paradox/dev/How-to-Release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand Down