Merge pull request #36 from jakzal/deprecate-annotations

Deprecate annotations

Author: jakzal

README.md

@@ -15,6 +15,10 @@ Supported annotations:
  * `@server` and `@unset-server` for `$_SERVER`
  * `@putenv` and `@unset-getenv` for [`putenv()`](http://php.net/putenv)
 
+> Annotations are deprecated since v3.1.0 and will be removed in the next major or minor version (whichever comes first).
+> The latest annotation support is planned to be removed is when PHPUnit 11 is released.
+> Annotation support is complete, so if you plan on using them keep using v3.1 of this package.
+
 Global variables are set before each test case is executed,
 and brought to the original state after each test case has finished.
 The same applies to `putenv()`/`getenv()` calls.

src/AnnotationExtension.php

@@ -8,6 +8,9 @@
 use PHPUnit\Runner\Extension\ParameterCollection;
 use PHPUnit\TextUI\Configuration\Configuration;
 
+/**
+ * @deprecated since 3.1.0, use Zalas\PHPUnit\Globals\AttributeExtension instead.
+ */
 final class AnnotationExtension implements Extension
 {
     public function bootstrap(Configuration $configuration, Facade $facade, ParameterCollection $parameters): void

src/GlobalsAnnotationReader.php

@@ -7,6 +7,9 @@
 use PHPUnit\Event\Test\PreparationStartedSubscriber;
 use PHPUnit\Metadata\Annotation\Parser\Registry;
 
+/**
+ * @deprecated since 3.1.0, use Zalas\PHPUnit\Globals\GlobalsAttributeReader instead.
+ */
 final class GlobalsAnnotationReader implements PreparationStartedSubscriber
 {
     public function notify(PreparationStarted $event): void