Optimize CI workflow for flexibility and efficiency

Refactored the CI workflow to improve maintainability and support multiple OS and PHP versions. Adjusted matrix configurations, streamlined dependency management, and introduced environment-based conditions. Updated step names and enhanced Composer caching for better performance.

Author: koriym

.github/workflows/continuous-integration.yml

@@ -5,103 +5,89 @@ on:
     paths-ignore:
       - '**.md'
   pull_request:
+    paths-ignore:
+      - '**.md'
   workflow_dispatch:
 
 env:
-  COMPOSER_FLAGS: "--ansi --no-interaction --no-progress --prefer-dist --no-plugins"
-  COMPOSER_UPDATE_FLAGS: ""
-  script: demo/run.php
+  COMPOSER_FLAGS: "--ansi --no-interaction --no-progress --prefer-dist"
+  SCRIPT_PATH: "demo/run.php"
 
 jobs:
   phpunit:
-    name: PHPUnit
-    runs-on: ubuntu-latest
-    services:
-      redis:
-        image: redis
-        ports:
-          - 6379:6379
-        options: --health-cmd="redis-cli ping" --health-interval=10s --health-timeout=5s --health-retries=3
+    name: PHPUnit (${{ matrix.os }} - PHP ${{ matrix.php }} - ${{ matrix.dependencies }})
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        php-version: [8.2, 8.3, 8.4]
+        php: [8.1, 8.2, 8.3, 8.4]
         dependencies: [highest, lowest]
-        os: [ubuntu-latest]
-        include:
-          - php-version: 8.1
-            os: windows-latest
-          - php-version: 8.1
-            os: macos-latest
-          - php-version: 8.2
-            dependencies: lowest
-            os: ubuntu-latest
-          - php-version:  8.2
-            dependencies: highest
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        exclude:
+          - php: 8.1
             os: ubuntu-latest
-          - php-version:  8.3
-            dependencies: highest
-            os: ubuntu-latest
-          - php-version: 8.3
+          - php: 8.1
             dependencies: lowest
-            os: ubuntu-latest
-          - php-version:  8.4
-            dependencies: highest
-            os: ubuntu-latest
-          - php-version: 8.4
+            os: windows-latest
+          - php: 8.1
             dependencies: lowest
+            os: macos-latest
+        include:
+          - php: 8.4
             os: ubuntu-latest
+            experimental: true
+
+    services:
+      redis:
+        image: redis
+        ports: [6379:6379]
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 3
+
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-      - name: Setup PHP ${{ matrix.php-version }}
+      - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php-version }}
+          php-version: ${{ matrix.php }}
           coverage: pcov
           ini-values: zend.assertions=1
+          tools: composer
+          experimental: ${{ contains(matrix.experimental, 'true') }}
 
-      - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-
-      - name: Cache dependencies
-        uses: actions/cache@v2
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
         with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: ${{ runner.os }}-composer-
-
-      - name: Handle lowest dependencies update
-        if: contains(matrix.dependencies, 'lowest')
-        run: echo COMPOSER_UPDATE_FLAGS=$COMPOSER_UPDATE_FLAGS --prefer-lowest >> $GITHUB_ENV
+          path: ~/.composer/cache
+          key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-${{ matrix.php }}-composer-
 
-      - name: Handle ignore-platform-reqs dependencies update
-        if: contains(matrix.dependencies, 'ignore')
-        run: echo COMPOSER_FLAGS=$COMPOSER_FLAGS --ignore-platform-req=php >> $GITHUB_ENV
+      - name: Configure dependency strategy
+        run: |
+          if [ "${{ matrix.dependencies }}" = "lowest" ]; then
+            composer config prefer-stable true
+            composer config prefer-lowest true
+          fi
 
-      - name: Remove platform config to get latest dependencies for current PHP version
-        if: contains(matrix.dependencies, 'highest') || contains(matrix.dependencies, 'lowest')
-        run: composer config platform --unset
-
-      - name: Allow alpha releases for latest-deps builds to catch problems earlier
-        if: contains(matrix.dependencies, 'ignore')
-        run: composer config minimum-stability alpha
-
-      - name: Update dependencies
-        run: composer update ${{ env.COMPOSER_UPDATE_FLAGS }} ${{ env.COMPOSER_FLAGS }}
+      - name: Install dependencies
+        run: composer update ${{ matrix.dependencies == 'lowest' && '--prefer-lowest' || '' }} ${{ env.COMPOSER_FLAGS }}
 
       - name: Run test suite
         run: ./vendor/bin/phpunit --coverage-clover=coverage.xml
 
-      - name: Upload coverage report
+      - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:
-          file: ./coverage.xml
-
-      - name: Update dependencies for demo
-        run: composer require doctrine/cache ^1 ${{ env.COMPOSER_UPDATE_FLAGS }} ${{ env.COMPOSER_FLAGS }}
+          files: coverage.xml
+          fail_ci_if_error: true
 
-      - name: Run additional script
-        if: ${{ env.script }}
-        run: php ${{ env.script }}
+      - name: Prepare demo environment
+        if: matrix.os == 'ubuntu-latest' && env.SCRIPT_PATH
+        run: |
+          composer require doctrine/cache ^1
+          php ${{ env.SCRIPT_PATH }}