Merge pull request #315 from Yoast/JRF/ghactions-update-workflows

GH Actions: various updates to the workflows
Yoast · Nov 3, 2023 · b075884 · b075884
2 parents c3b064f + 6131d41
commit b075884
Show file tree

Hide file tree

Showing 3 changed files with 91 additions and 95 deletions.
diff --git a/.github/workflows/basics.yml b/.github/workflows/basics.yml
@@ -6,6 +6,8 @@ on:
   push:
     paths-ignore:
       - '**.md'
+    branches-ignore:
+      - 'main'
   pull_request:
   # Allow manually triggering the workflow.
   workflow_dispatch:
@@ -40,14 +42,18 @@ jobs:
       - name: Validate Composer installation
         run: composer validate --no-check-all --strict
 
-      - name: 'Composer: adjust dependencies'
-        run: |
-          # The sniff stage doesn't run the unit tests, so no need for PHPUnit.
-          composer remove --no-update --dev phpunit/phpunit --no-scripts --no-interaction
-          # Using PHPCS `master` as an early detection system for bugs upstream.
-          composer require --no-update --no-scripts squizlabs/php_codesniffer:"dev-master" --no-interaction
-          # Using WPCS `main` (=stable). This can be changed back to `dev-develop` after the WPCS 3.0.0 release.
-          # composer require --no-update --no-scripts wp-coding-standards/wpcs:"dev-main" --no-interaction
+      # The sniff stage doesn't run the unit tests, so no need for PHPUnit.
+      - name: 'Composer: adjust dependencies - remove PHPUnit'
+        run: composer remove --no-update --dev phpunit/phpunit --no-scripts --no-interaction
+
+      # Use the WIP/develop branches of all CS dependencies as an early detection system for bugs upstream.
+      - name: 'Composer: adjust dependencies - use dev versions of CS dependencies'
+        # Note: while WPCS 3.0.0 is not yet supported, WPCS will not be updated.
+        # Once YoastCS has been updated for WPCS 3.0.0, WPCS dev-develop should be added (back) to this command.
+        # wp-coding-standards/wpcs:"dev-develop"
+        run: >
+          composer require --no-update --no-scripts --no-interaction
+          squizlabs/php_codesniffer:"dev-master"
 
       # Install dependencies and handle caching in one go.
       # @link https://github.com/marketplace/actions/install-composer-dependencies
@@ -64,7 +70,8 @@ jobs:
 
       # Show XML violations inline in the file diff.
       # @link https://github.com/marketplace/actions/xmllint-problem-matcher
-      - uses: korelstar/xmllint-problem-matcher@v1
+      - name: Show XML issues inline
+        uses: korelstar/xmllint-problem-matcher@v1
 
       # Validate the ruleset XML file.
       # @link http://xmlsoft.org/xmllint.html
@@ -73,7 +80,6 @@ jobs:
 
       # Validate the Docs XML files.
       # @link http://xmlsoft.org/xmllint.html
-      # For the build to properly error when validating against a scheme, these each have to be in their own condition.
       - name: Validate the XML sniff docs against schema
         run: xmllint --noout --schema vendor/phpcsstandards/phpcsdevtools/DocsXsd/phpcsdocs.xsd ./Yoast/Docs/*/*Standard.xml
 

diff --git a/.github/workflows/quicktest.yml b/.github/workflows/quicktest.yml
@@ -19,38 +19,31 @@ concurrency:
 jobs:
   #### QUICK TEST STAGE ####
   # This is a much quicker test which only runs the unit tests and linting against low/high
-  # supported PHP/PHPCS/WPCS combinations.
+  # of the supported PHP/CS dependencies combinations.
   quicktest:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
+        php_version: ['5.4', 'latest']
+        cs_dependencies: ['lowest', 'stable']
+
         include:
           - php_version: 'latest'
-            phpcs_version: 'dev-master'
-            wpcs_version: '2.3.0'
-          - php_version: 'latest'
-            phpcs_version: '3.7.2'
-            wpcs_version: '2.3.0'
-          - php_version: '5.4'
-            phpcs_version: 'dev-master'
-            wpcs_version: '2.3.0'
-          - php_version: '5.4'
-            phpcs_version: '3.7.2'
-            wpcs_version: '2.3.0'
+            cs_dependencies: 'dev'
 
-    name: "QTest${{ matrix.phpcs_version == 'dev-master' && ' + Lint' || '' }}: PHP ${{ matrix.php_version }} - PHPCS ${{ matrix.phpcs_version }} - WPCS ${{ matrix.wpcs_version }}"
+    name: "QTest${{ matrix.cs_dependencies == 'stable' && ' + Lint' || '' }}: PHP ${{ matrix.php_version }} - CS deps ${{ matrix.cs_dependencies }}"
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      # On stable PHPCS versions, allow for PHP deprecation notices.
+      # With stable PHPCS dependencies, allow for PHP deprecation notices.
       # Unit tests don't need to fail on those for stable releases where those issues won't get fixed anymore.
       - name: Setup ini config
         id: set_ini
         run: |
-          if [ "${{ matrix.phpcs_version }}" != "dev-master" ]; then
+          if [ "${{ matrix.cs_dependencies }}" != "dev" ]; then
             echo 'PHP_INI=error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On' >> $GITHUB_OUTPUT
           else
             echo 'PHP_INI=error_reporting=-1, display_errors=On' >> $GITHUB_OUTPUT
@@ -63,12 +56,13 @@ jobs:
           ini-values: ${{ steps.set_ini.outputs.PHP_INI }}
           coverage: none
 
-      - name: 'Composer: adjust dependencies'
-        run: |
-          # Set the PHPCS version to test against.
-          composer require --no-update --no-scripts squizlabs/php_codesniffer:"${{ matrix.phpcs_version }}" --no-interaction
-          # Set the WPCS version to test against.
-          composer require --no-update --no-scripts wp-coding-standards/wpcs:"${{ matrix.wpcs_version }}" --no-interaction
+      - name: "Composer: set PHPCS dependencies for tests (dev)"
+        if: ${{ matrix.cs_dependencies == 'dev' }}
+        # Note: while WPCS 3.0.0 is not yet supported, WPCS will not be updated for the `dev` builds.
+        # Once YoastCS has been updated for WPCS 3.0.0, WPCS dev-develop should be added to this command.
+        run: >
+          composer require --no-update --no-scripts --no-interaction --ignore-platform-req=php+
+          squizlabs/php_codesniffer:"dev-master"
 
       # Install dependencies and handle caching in one go.
       # @link https://github.com/marketplace/actions/install-composer-dependencies
@@ -87,11 +81,18 @@ jobs:
           composer-options: --ignore-platform-req=php+
           custom-cache-suffix: $(date -u "+%Y-%m")
 
+      - name: "Composer: downgrade PHPCS dependencies for tests (lowest) (with ignore platform)"
+        if: ${{ matrix.cs_dependencies == 'lowest' }}
+        run: >
+          composer update --prefer-lowest --no-scripts --no-interaction --ignore-platform-req=php+
+          squizlabs/php_codesniffer
+          wp-coding-standards/wpcs
+
       - name: Verify installed standards
         run: vendor/bin/phpcs -i
 
       - name: Lint against parse errors
-        if: matrix.phpcs_version == 'dev-master'
+        if: matrix.cs_dependencies == 'stable'
         run: composer lint
 
       - name: Run the unit tests - PHP 5.4 - 8.0

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -32,8 +32,6 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
-      # Keys:
-      # - experimental: Whether the build is "allowed to fail".
       matrix:
         # The GHA matrix works different from Travis.
         # You can define jobs here and then augment them with extra variables in `include`,
@@ -42,41 +40,42 @@ jobs:
         #
         # The matrix is set up so as not to duplicate the builds which are run for code coverage.
         php_version: ['5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '8.0', '8.1', '8.2']
-        cs_dependencies: ['lowest', 'highest']
-        experimental: [false]
+        cs_dependencies: ['lowest', 'stable']
 
         include:
-          # Experimental builds. These are allowed to fail.
-
+          # Make the matrix complete (when combined with the code coverage builds).
+          - php_version: '5.4'
+            cs_dependencies: 'stable'
+          - php_version: '7.4'
+            cs_dependencies: 'stable'
+
+          # Test against dev versions of all CS dependencies with select PHP versions for early detection of issues.
+          - php_version: '7.0'
+            cs_dependencies: 'dev'
+          - php_version: '8.0'
+            cs_dependencies: 'dev'
+          - php_version: '8.2'
+            cs_dependencies: 'dev'
+
+          # Experimental build(s). These are allowed to fail.
           # PHP nightly
           - php_version: '8.3'
-            cs_dependencies: 'highest'
-            experimental: true
-          # Test against WPCS unstable. Re-enable when WPCS is not in dev for the next major.
-          #- php_version: '8.0'
-          #  cs_dependencies: 'highest'
-          #  experimental: true
-
-          # Test against the next major of PHPCS. Temporarily disabled due to upstream bugs.
-          #- php_version: '7.4'
-          #  cs_dependencies: 'highest'
-          #  phpcs_version: '4.0.x-dev'
-          #  experimental: true
+            cs_dependencies: 'dev'
 
-    name: "Test${{ matrix.cs_dependencies == 'highest' && ' + Lint' || '' }}: PHP ${{ matrix.php_version }} - CS Deps ${{ matrix.cs_dependencies }}"
+    name: "Test${{ matrix.cs_dependencies == 'stable' && ' + Lint' || '' }}: PHP ${{ matrix.php_version }} - CS Deps ${{ matrix.cs_dependencies }}"
 
-    continue-on-error: ${{ matrix.experimental }}
+    continue-on-error: ${{ matrix.php == '8.3' }}
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      # On stable PHPCS versions, allow for PHP deprecation notices.
+      # With stable PHPCS dependencies, allow for PHP deprecation notices.
       # Unit tests don't need to fail on those for stable releases where those issues won't get fixed anymore.
       - name: Setup ini config
         id: set_ini
         run: |
-          if [[ "${{ matrix.cs_dependencies }}" != "highest" && "${{ matrix.phpcs_version }}" != "4.0.x-dev" ]]; then
+          if [ "${{ matrix.cs_dependencies }}" != "dev" ]; then
             echo 'PHP_INI=error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On' >> $GITHUB_OUTPUT
           else
             echo 'PHP_INI=error_reporting=-1, display_errors=On' >> $GITHUB_OUTPUT
@@ -89,32 +88,14 @@ jobs:
           ini-values: ${{ steps.set_ini.outputs.PHP_INI }}
           coverage: none
           tools: cs2pr
-        env:
-          # Token is needed for the PHPCS 4.x run against source.
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      # Set Composer up to download only PHPCS from source for PHPCS 4.x.
-      # The source is needed to get the base testcase from PHPCS.
-      # All other jobs can use `auto`, which is Composer's default value.
-      - name: 'Composer: conditionally prefer source for PHPCS 4.x'
-        if: ${{ startsWith( matrix.phpcs_version, '4' ) }}
-        run: composer config preferred-install.squizlabs/php_codesniffer source
-
-      - name: 'Composer: adjust CS dependencies (high)'
-        if: ${{ matrix.cs_dependencies == 'highest' }}
-        run: |
-          composer require --no-update --no-scripts squizlabs/php_codesniffer:"${{ env.PHPCS_HIGHEST }}" --no-interaction
-          composer require --no-update --no-scripts wp-coding-standards/wpcs:"${{ env.WPCS_HIGHEST }}" --no-interaction
 
-      - name: 'Composer: adjust CS dependencies (4.x)'
-        if: ${{ matrix.phpcs_version }}
-        run: |
-          composer require --no-update --no-scripts squizlabs/php_codesniffer:"${{ matrix.phpcs_version }}" --no-interaction
-
-      - name: 'Composer: conditionally remove PHPCSDevtools for PHPCS 4.x'
-        if: ${{ startsWith( matrix.phpcs_version, '4' ) }}
-        # Remove devtools as it will not (yet) install on PHPCS 4.x.
-        run: composer remove --no-update --dev phpcsstandards/phpcsdevtools --no-interaction
+      - name: "Composer: set PHPCS dependencies for tests (dev)"
+        if: ${{ matrix.cs_dependencies == 'dev' }}
+        # Note: while WPCS 3.0.0 is not yet supported, WPCS will not be updated for the `dev` builds.
+        # Once YoastCS has been updated for WPCS 3.0.0, WPCS dev-develop should be added to this command.
+        run: >
+          composer require --no-update --no-scripts --no-interaction --ignore-platform-req=php+
+          squizlabs/php_codesniffer:"${{ env.PHPCS_HIGHEST }}"
 
       # Install dependencies and handle caching in one go.
       # @link https://github.com/marketplace/actions/install-composer-dependencies
@@ -133,9 +114,12 @@ jobs:
           composer-options: --ignore-platform-req=php+
           custom-cache-suffix: $(date -u "+%Y-%m")
 
-      - name: "Composer: set PHPCS version for tests (low)"
+      - name: "Composer: downgrade PHPCS dependencies for tests (lowest) (with ignore platform)"
         if: ${{ matrix.cs_dependencies == 'lowest' }}
-        run: composer update squizlabs/php_codesniffer wp-coding-standards/wpcs --with-dependencies --prefer-lowest --ignore-platform-req=php+ --no-scripts --no-interaction
+        run: >
+          composer update --prefer-lowest --no-scripts --no-interaction --ignore-platform-req=php+
+          squizlabs/php_codesniffer
+          wp-coding-standards/wpcs
 
       - name: Verify installed versions
         run: composer info --no-dev
@@ -146,7 +130,7 @@ jobs:
       # The results of the linting will be shown inline in the PR via the CS2PR tool.
       # @link https://github.com/staabm/annotate-pull-request-from-checkstyle/
       - name: Lint against parse errors
-        if: ${{ matrix.cs_dependencies == 'highest' }}
+        if: ${{ matrix.cs_dependencies == 'stable' }}
         run: composer lint -- --checkstyle | cs2pr
 
       - name: Run the unit tests - PHP 5.4 - 8.0
@@ -171,22 +155,22 @@ jobs:
 
     strategy:
       matrix:
-        # 7.4 should be updated to 8.2 when higher PHPUnit versions can be supported.
+        # 7.4 should be updated to 8.x when higher PHPUnit versions can be supported.
         php_version: ['5.4', '7.4']
-        cs_dependencies: ['lowest', 'highest']
+        cs_dependencies: ['lowest', 'dev']
 
-    name: "Coverage${{ matrix.cs_dependencies == 'highest' && ' + Lint' || '' }}: PHP ${{ matrix.php_version }} - CS Deps ${{ matrix.cs_dependencies }}"
+    name: "Coverage${{ matrix.cs_dependencies == 'stable' && ' + Lint' || '' }}: PHP ${{ matrix.php_version }} - CS Deps ${{ matrix.cs_dependencies }}"
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      # On stable PHPCS versions, allow for PHP deprecation notices.
+      # With stable PHPCS dependencies, allow for PHP deprecation notices.
       # Unit tests don't need to fail on those for stable releases where those issues won't get fixed anymore.
       - name: Setup ini config
         id: set_ini
         run: |
-          if [[ "${{ matrix.cs_dependencies }}" != "highest" && "${{ matrix.phpcs_version }}" != "4.0.x-dev" ]]; then
+          if [ "${{ matrix.cs_dependencies }}" != "dev" ]; then
             echo 'PHP_INI=error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On' >> $GITHUB_OUTPUT
           else
             echo 'PHP_INI=error_reporting=-1, display_errors=On' >> $GITHUB_OUTPUT
@@ -200,11 +184,13 @@ jobs:
           coverage: xdebug
           tools: cs2pr
 
-      - name: 'Composer: adjust CS dependencies (high)'
-        if: ${{ matrix.cs_dependencies == 'highest' }}
-        run: |
-          composer require --no-update --no-scripts squizlabs/php_codesniffer:"${{ env.PHPCS_HIGHEST }}" --no-interaction
-          composer require --no-update --no-scripts wp-coding-standards/wpcs:"${{ env.WPCS_HIGHEST }}" --no-interaction
+      - name: "Composer: set PHPCS dependencies for tests (dev)"
+        if: ${{ matrix.cs_dependencies == 'dev' }}
+        # Note: while WPCS 3.0.0 is not yet supported, WPCS will not be updated for the `dev` builds.
+        # Once YoastCS has been updated for WPCS 3.0.0, WPCS dev-develop should be added to this command.
+        run: >
+          composer require --no-update --no-scripts --no-interaction
+          squizlabs/php_codesniffer:"${{ env.PHPCS_HIGHEST }}"
 
       # Install dependencies and handle caching in one go.
       # @link https://github.com/marketplace/actions/install-composer-dependencies
@@ -214,9 +200,12 @@ jobs:
           # Bust the cache at least once a month - output format: YYYY-MM.
           custom-cache-suffix: $(date -u "+%Y-%m")
 
-      - name: "Composer: set PHPCS version for tests (low)"
+      - name: "Composer: downgrade PHPCS dependencies for tests (lowest)"
         if: ${{ matrix.cs_dependencies == 'lowest' }}
-        run: composer update squizlabs/php_codesniffer wp-coding-standards/wpcs --with-dependencies --prefer-lowest --ignore-platform-req=php+ --no-scripts --no-interaction
+        run: >
+          composer update --prefer-lowest --no-scripts --no-interaction
+          squizlabs/php_codesniffer
+          wp-coding-standards/wpcs
 
       - name: Verify installed versions
         run: composer info --no-dev
@@ -227,7 +216,7 @@ jobs:
       # The results of the linting will be shown inline in the PR via the CS2PR tool.
       # @link https://github.com/staabm/annotate-pull-request-from-checkstyle/
       - name: Lint against parse errors
-        if: ${{ matrix.cs_dependencies == 'highest' }}
+        if: ${{ matrix.cs_dependencies == 'dev' }}
         run: composer lint -- --checkstyle | cs2pr
 
       - name: Run the unit tests with code coverage