Move doctrine/annotations to "require-dev"

willdurand · Oct 22, 2024 · 2dd73d9 · 2dd73d9
1 parent 6e721b7
commit 2dd73d9
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 1 deletion.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -38,17 +38,29 @@ jobs:
             symfony-require: "^6.0"
           - php-version: 8.1
             symfony-require: "^6.0"
+          - php-version: 8.1
+            symfony-require: "^6.0"
+            remove-annotations: yes
+          - php-version: 8.2
+            symfony-require: "^6.0"
           - php-version: 8.2
             symfony-require: "^6.0"
+            remove-annotations: yes
+          - php-version: 8.3
+            symfony-require: "^6.0"
           - php-version: 8.3
             symfony-require: "^6.0"
+            remove-annotations: yes
           - php-version: 8.4
             symfony-require: "^6.0"
             composer-options: "--ignore-platform-req=php+" # TODO remove once phpspec/prophecy supports PHP 8.4
           - php-version: 8.2
             symfony-require: "^7.0"
           - php-version: 8.3
             symfony-require: "^7.0"
+          - php-version: 8.3
+            symfony-require: "^7.0"
+            remove-annotations: yes
           - php-version: 8.4
             symfony-require: "^7.0"
             composer-options: "--ignore-platform-req=php+" # TODO remove once phpspec/prophecy supports PHP 8.4
@@ -65,6 +77,13 @@ jobs:
           ini-values: "zend.assertions=1"
           tools: "flex"
 
+      - name: "Remove remove-annotations if required"
+        if: "${{ matrix.remove-annotations == 'yes' }}"
+        env:
+          SYMFONY_REQUIRE: "${{ matrix.symfony-require }}"
+        run: |
+          composer remove --no-update --dev doctrine/annotations
+
       - name: "Install dependencies with Composer"
         uses: "ramsey/composer-install@v2"
         env:

diff --git a/README.md b/README.md
@@ -73,6 +73,17 @@ This will resolve the latest stable version.
 
 Otherwise, install the library and setup the autoloader yourself.
 
+If you want to use [**annotations**](#annotations) for configuration you need
+to install the `doctrine/annotations` package:
+
+```sh
+composer require doctrine/annotations
+```
+
+If your app uses PHP 8.1 or higher it is recommended to use native PHP
+attributes.
+In this case you don't need to install the Doctrine package.
+
 ### Working With Symfony
 
 There is a bundle for that! Install the

diff --git a/composer.json b/composer.json
@@ -18,13 +18,13 @@
     ],
     "require": {
         "php": "^7.2 | ^8.0",
-        "doctrine/annotations": "^1.13.2 || ^2.0",
         "jms/metadata": "^2.0",
         "jms/serializer": "^3.18.2",
         "symfony/expression-language": "~3.0 || ~4.0 || ~5.0 || ~6.0 || ~7.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^7 | ^9.5.10",
+        "doctrine/annotations": "^1.13.2 || ^2.0",
         "doctrine/coding-standard": "^12.0",
         "doctrine/persistence": "^1.3.4 | ^2.0 | ^3.0",
         "pagerfanta/core": "^2.4 || ^3.0",