diff --git a/UPGRADING.md b/UPGRADING.md new file mode 100644 index 00000000..5ad28da1 --- /dev/null +++ b/UPGRADING.md @@ -0,0 +1,11 @@ +# Upgrade notes for FriendsOfBehat/MinkExtension + +This document summarizes the changes relevant for users when upgrading to new versions. + +# Upgrade to 2.8 + +## Soft `@final` and `@internal` declarations added + +The classes `FailureShowListener`, `SessionsListener` and `MinkExtension` have been marked as `@final`. They will become `final` classes in the next major release and you will no longer be able to use them by inheritance (https://github.com/FriendsOfBehat/MinkExtension/pull/41). + +Additionally, the two listener classes have been marked as `@internal`. Starting with the next major version, their API may change at any time without further notice. diff --git a/src/Behat/MinkExtension/Listener/FailureShowListener.php b/src/Behat/MinkExtension/Listener/FailureShowListener.php index 3e8a0d3d..a3b3d0bb 100644 --- a/src/Behat/MinkExtension/Listener/FailureShowListener.php +++ b/src/Behat/MinkExtension/Listener/FailureShowListener.php @@ -22,6 +22,9 @@ * Listens to failed Behat steps and shows last response in a browser. * * @author Konstantin Kudryashov + * + * @final since 2.8.0 + * @internal since 2.8.0 */ class FailureShowListener implements EventSubscriberInterface { diff --git a/src/Behat/MinkExtension/Listener/SessionsListener.php b/src/Behat/MinkExtension/Listener/SessionsListener.php index 7a18cc95..69216394 100644 --- a/src/Behat/MinkExtension/Listener/SessionsListener.php +++ b/src/Behat/MinkExtension/Listener/SessionsListener.php @@ -25,6 +25,9 @@ * Listens Behat events and configures/stops Mink sessions. * * @author Konstantin Kudryashov + * + * @final since 2.8.0 + * @internal since 2.8.0 */ class SessionsListener implements EventSubscriberInterface { diff --git a/src/Behat/MinkExtension/ServiceContainer/MinkExtension.php b/src/Behat/MinkExtension/ServiceContainer/MinkExtension.php index 7a75ce55..6bb1e70b 100644 --- a/src/Behat/MinkExtension/ServiceContainer/MinkExtension.php +++ b/src/Behat/MinkExtension/ServiceContainer/MinkExtension.php @@ -38,6 +38,8 @@ * * @author Konstantin Kudryashov * @author Christophe Coevoet + * + * @final since 2.8.0 */ class MinkExtension implements ExtensionInterface {