You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _overviews/tutorials/binary-compatibility-for-library-authors.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -142,11 +142,11 @@ How can we, as library authors, spare our users of runtime errors and dependency
142
142
143
143
## MiMa - Checking binary compatibility against previous library versions
144
144
145
-
The [Migration Manager for Scala](https://github.com/typesafehub/migration-manager) (MiMa) is a tool for diagnosing binary incompatibilities between different library versions.
145
+
The [Migration Manager for Scala](https://github.com/lightbend/migration-manager) (MiMa) is a tool for diagnosing binary incompatibilities between different library versions.
146
146
It works by comparing the class files of two provided JARs and report any binary incompatibilities found.
147
147
Both backwards and forwards binary incompatibility can be detected by swapping input order of the JARs.
148
148
149
-
By incorporating [MiMa SBT plugin](https://github.com/typesafehub/migration-manager/wiki/Sbt-plugin) into your SBT build, you can easily check whether
149
+
By incorporating [MiMa SBT plugin](https://github.com/lightbend/migration-manager/wiki/Sbt-plugin) into your SBT build, you can easily check whether
150
150
you have accidentally introduced binary incompatible changes. Detailed instruction on how to use the SBT plugin can be found in the link.
151
151
152
152
We strongly encourage every library author to incorporate MiMa into their continuous integration and release workflow.
@@ -175,7 +175,7 @@ Again, we recommend using MiMa to double check that you have not broken binary c
Library authors use versioning schemes to communicate compatibility guarantees between library releases to their users. Versioning schemes like [Semantic Versioning](http://semver.org/)(SemVer) allow
178
-
users to easily reason about the impact of updating a library, without needing to read the detailed release note.
178
+
users to easily reason about the impact of updating a library, without needing to read the detailed release notes.
179
179
180
180
In the following section, we will outline a versioning scheme based on Semantic Versioning that we **strongly encourage** you to adopt for your libraries. The rules listed below are **in addition** to
181
181
Semantic Versioning v2.0.0.
@@ -184,7 +184,7 @@ Semantic Versioning v2.0.0.
184
184
185
185
* If backward **binary compatibility** is broken, **major version number** must be increased.
186
186
* If backward **source compatibility** is broken, **minor version number** must be increased.
187
-
* A change in **patch version number** signals **no binary nor source incompatibility**.
187
+
* A change in **patch version number** signals **neither binary nor source incompatibility**.
188
188
According to SemVer, patch versions should contain only bug fixes that fix incorrect behavior so major behavioral
189
189
change in method/classes should result in a minor version bump.
190
190
* When major version is `0`, a minor version bump **may contain both source and binary breakages**.
0 commit comments