Skip to content

Commit

Permalink
Merge pull request #740 from sjrd/mention-tasty-mima
Browse files Browse the repository at this point in the history
  • Loading branch information
SethTisue committed Feb 1, 2023
2 parents 2b657b3 + bc6b02f commit 56cca47
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ consequence of modifications in classes/members signature.

MiMa compares all classfiles of two released libraries and reports all source
of incompatibilities that may lead to a linkage error. MiMa provides you, the
library maintainer, with a tool that can greatly automates and simplifies the
library maintainer, with a tool that can greatly automate and simplify the
process of ensuring the release-to-release binary compatibility of your
libraries.

Expand All @@ -35,6 +35,17 @@ Java language binary compatibility does not imply source compatibility as well.
MiMa focuses on binary compatibility and currently provides no insight into
source compatibility.

### See also: TASTy-MiMa

For Scala 3, in addition to binary compatible, TASTy compatibility becomes
increasingly important. Another tool,
[TASTy-MiMa](https://github.com/scalacenter/tasty-mima), is designed to
automatically check TASTy compatibility in much the same way that MiMa checks
binary compatibility.

Keep in mind that TASTy-MiMa is still young, as of early 2023. It is likely to
contain bugs.

## Usage

MiMa's sbt plugin supports sbt 1.x only. (Use v0.3.0 for sbt 0.13.x.)
Expand Down

0 comments on commit 56cca47

Please sign in to comment.