From 87750496f83e7e7163082c607daa38c7324cb212 Mon Sep 17 00:00:00 2001 From: Patrik Nordwall Date: Wed, 9 Aug 2017 14:24:48 +0200 Subject: [PATCH] disclaimer about security vs binary compatibility --- .../src/main/paradox/scala/common/binary-compatibility-rules.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/akka-docs/src/main/paradox/scala/common/binary-compatibility-rules.md b/akka-docs/src/main/paradox/scala/common/binary-compatibility-rules.md index fedc14ca3e..7eaaff7241 100644 --- a/akka-docs/src/main/paradox/scala/common/binary-compatibility-rules.md +++ b/akka-docs/src/main/paradox/scala/common/binary-compatibility-rules.md @@ -40,6 +40,8 @@ OK: 3.1.n --> 3.2.0 ... ### Cases where binary compatibility is not retained +If a security vulnerability is reported in Akka or a transient dependency of Akka and it cannot be solved without breaking binary compatibility then fixing the security issue is more important. In such cases binary compatibility might not be retained when releasing a minor version. Such exception is always noted in the release announcement. + Some modules are excluded from the binary compatibility guarantees, such as: * `*-testkit` modules - since these are to be used only in tests, which usually are re-compiled and run on demand