quicktest.yml

name: Quick Tests

on:
  push:
    branches-ignore:
      - main
    paths-ignore:
      - '**.md'
  # Allow manually triggering the workflow.
  workflow_dispatch:

# Cancels all previous workflow runs for the same branch that have not yet completed.
concurrency:
  # The concurrency group contains the workflow name and the branch name.
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  # Performs some quick tests.
  # This is a much quicker test suite which only runs the unit tests and linting
  # against the low/high supported PHP/PHPCS combinations.
  quick-tests:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        php: [ '5.4', 'latest' ]
        dependencies: [ 'lowest', 'stable' ]

    name: QTest - PHP ${{ matrix.php }} on PHPCS ${{ matrix.dependencies }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php }}
          # 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.
          ini-values: error_reporting=-1, display_errors=On
          coverage:  ${{ github.ref_name == 'develop' && 'xdebug' || 'none' }}

      - name: Enable creation of `composer.lock` file
        if: ${{ matrix.dependencies == 'lowest' }}
        run: composer config --unset lock

      - name: Install Composer dependencies
        uses: ramsey/composer-install@v3
        with:
          # Bust the cache at least once a month - output format: YYYY-MM.
          custom-cache-suffix: $(date -u "+%Y-%m")

      - name: "Composer: downgrade PHPCS dependencies for tests (lowest)"
        if: ${{ matrix.dependencies == 'lowest' }}
        run: >
          composer update --prefer-lowest --no-scripts --no-interaction
          squizlabs/php_codesniffer
          phpcsstandards/phpcsutils
          phpcsstandards/phpcsextra

      - name: Lint PHP files against parse errors
        if: ${{ matrix.dependencies == 'stable' }}
        run: composer lint

      - name: Run the unit tests without code coverage
        if: ${{ github.ref_name != 'develop' }}
        run: composer run-tests

      - name: Run the unit tests with code coverage
        if: ${{ github.ref_name == 'develop' }}
        run: composer coverage

      - name: Send coverage report to Codecov
        if: ${{ success() && github.ref_name == 'develop' }}
        uses: codecov/codecov-action@v5
        with:
          files: ./build/logs/clover.xml
          fail_ci_if_error: true
          verbose: true
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}