raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Clarify how our binary compatibility applies to external dependencies (#1420)

Browse source
This commit is contained in:
Arnout Engelen 2024-08-01 09:44:21 +02:00 • committed by GitHub
parent 2adb783081
commit 5bf60da763
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/src/main/paradox/common/binary-compatibility-rules.md
View file

@ -154,3 +154,12 @@ manual exception overrides may be put in place if the change happened to be in a
Scala does not maintain serialization compatibility across major versions. This means that if Java serialization is used
there is no guarantee objects can be cleanly deserialized if serialized with a different version of Scala.
## Binary Compatibility of dependencies
The above rules apply to Pekko modules themselves. They do not necessarily
apply to dependencies: within a major Pekko component version, we may upgrade a
major version of a dependency. For example, between Pekko Connectors 1.0 and
1.1, we updated from `javax.jms` 1.1 to `javax.jms` 2.0.1 in the JMS component.
This means when you update this component, you may also need to update any
other components that were still built against `javax.jms` 1.1.