Add MiMa binary compatibility checks#833
Merged
halotukozak merged 5 commits intomasterfrom Apr 22, 2026
Merged
Conversation
Wires sbt-mima-plugin 1.1.4 into the build with cross-platform support (via `%%%`) and configures `previousCompatibleVersions` covering the last seven minor releases. Filters for intentional API changes (removed `mongo.scala.*` helpers from PR #827, renamed `listDatabases`/`listCollections` in commit 11e6d7e, and removed `AnalyzerRule.report`) live as `mimaBinaryIssueFilters` on the respective subprojects. The check runs in CI before tests via a new `Binary compatibility check` workflow step.
There was a problem hiding this comment.
Pull request overview
This PR integrates MiMa binary compatibility checks into the sbt build and CI, establishing a baseline across a set of previously released versions and documenting known intentional incompatibilities via issue filters.
Changes:
- Add
sbt-mima-pluginto the build plugins. - Configure
mimaPreviousArtifactsand introduce targetedmimaBinaryIssueFiltersfor known intentional breakages. - Add a dedicated “Binary compatibility check” step to the GitHub Actions CI workflow.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| project/plugins.sbt | Adds the MiMa sbt plugin dependency. |
| project/Commons.scala | Wires MiMa settings (previous artifacts + issue filters) and attempts to inject a CI workflow step. |
| .github/workflows/ci.yml | Adds a mimaReportBinaryIssues step before running tests. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ddworak
requested changes
Apr 17, 2026
- `previousCompatibleVersions` now covers every released 2.x version in the baseline window (adds 2.23.0 and 2.27.0 that were previously implicit via "last patch per minor"), since the project lacks prior MiMa history to back that shortcut. Strategy documented in a comment. - Move MiMa to a dedicated `mima` CI job running on a single JDK (temurin@21) instead of multiplying the work across the build matrix; MiMa compares bytecode and is JDK-agnostic. - Replace self-referential `githubWorkflowBuild := ... ++ .value` with `githubWorkflowAddedJobs += WorkflowJob(...)`.
# Conflicts: # project/plugins.sbt
ddworak
approved these changes
Apr 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.