This is an automated email from the ASF dual-hosted git repository.
engelen pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko.git
The following commit(s) were added to refs/heads/main by this push:
new 5bf60da763 Clarify how our binary compatibility applies to external
dependencies (#1420)
5bf60da763 is described below
commit 5bf60da763a296b1cc56f97d547cbafb1a7c2231
Author: Arnout Engelen <[email protected]>
AuthorDate: Thu Aug 1 09:44:21 2024 +0200
Clarify how our binary compatibility applies to external dependencies
(#1420)
---
docs/src/main/paradox/common/binary-compatibility-rules.md | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/docs/src/main/paradox/common/binary-compatibility-rules.md
b/docs/src/main/paradox/common/binary-compatibility-rules.md
index 87526fb33f..9273dd589a 100644
--- a/docs/src/main/paradox/common/binary-compatibility-rules.md
+++ b/docs/src/main/paradox/common/binary-compatibility-rules.md
@@ -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.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
