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.

Sign up for GitHub

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

Clarify how our binary compatibility applies to external dependencies #1420

Merged
merged 1 commit into from
Aug 1, 2024
Merged

Clarify how our binary compatibility applies to external dependencies #1420

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions docs/src/main/paradox/common/binary-compatibility-rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.