Soft-finalize classes that might need to be changed in the future (#41)

* Soft-finalize classes that might need to be changed in the future

* Leave a note in the UPGRADING document

* @internal-ize listener classes
This commit is contained in:
Matthias Pigulla
2025-12-19 10:43:53 +01:00
committed by GitHub
parent 9037349407
commit 37e6a53e9d
4 changed files with 19 additions and 0 deletions

11
UPGRADING.md Normal file
View File

@@ -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.