php-qa.yml

name: PHP Quality Assurance

on:
    push:
        paths:
            - '**workflows/php-qa.yml'
            - '**.php'
            - '**phpcs.xml.dist'
            - '**phpunit.xml.dist'
            - '**psalm.xml'
            - '**composer.json'
    pull_request:
        paths:
            - '**workflows/php-qa.yml'
            - '**.php'
            - '**phpcs.xml.dist'
            - '**phpunit.xml.dist'
            - '**psalm.xml'
            - '**composer.json'
    workflow_dispatch:
        inputs:
            jobs:
                required: true
                type: choice
                default: 'Run all'
                description: 'Choose jobs to run'
                options:
                    - 'Run all'
                    - 'Run static QA only'
                    - 'Run tests only'

concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}
    cancel-in-progress: true

jobs:

    static-qa:
        runs-on: ubuntu-latest
        if: ${{ ((github.event_name != 'workflow_dispatch') && !contains(github.event.head_commit.message, 'skip qa')) || ((github.event_name == 'workflow_dispatch') && (github.event.inputs.jobs != 'Run tests only')) }}
        steps:

            -   name: Checkout
                uses: actions/checkout@v3

            -   name: Setup PHP
                uses: shivammathur/setup-php@v2
                with:
                    php-version: 7.4
                    coverage: none
                    tools: cs2pr

            -   name: Install dependencies
                uses: ramsey/composer-install@v2

            -   name: Check code styles
                run: ./vendor/bin/phpcs -q ${{ ((github.event_name == 'pull_request') && '--report-checkstyle="phpcs-report.xml" ') || '' }}--report-full --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1

            -   name: Annotate code styles for PRs
                if: ${{ github.event_name == 'pull_request' }}
                run: cs2pr --graceful-warnings phpcs-report.xml

            -   name: Check Psalm
                run: ./vendor/bin/psalm ${{ ((github.event_name == 'pull_request') && '--output-format=github ') || '' }} --no-suggestions --find-unused-psalm-suppress --no-diff --no-cache --no-file-cache

    unit-tests:
        runs-on: ubuntu-latest
        if: ${{ ((github.event_name != 'workflow_dispatch') && !contains(github.event.head_commit.message, 'skip tests')) || ((github.event_name == 'workflow_dispatch') && (github.event.inputs.jobs != 'Run static QA only')) }}
        env:
            USE_COVERAGE: no
        strategy:
            fail-fast: false
            matrix:
                php-ver: [ '7.2', '7.3', '7.4', '8.0', '8.1', '8.2' ]
                wp-ver: [ '4.7.*', '5.*', '6.*' ]
                dependency-versions: [ 'highest', 'lowest' ]
                exclude:
                    -   php-ver: '8.1'
                        wp-ver: '4.7.*'
                    -   php-ver: '8.1'
                        wp-ver: '5.*'
                        dependency-versions: 'lowest'
                    -   php-ver: '8.2'
                        wp-ver: '4.7.*'
                    -   php-ver: '8.2'
                        wp-ver: '5.*'
                        dependency-versions: 'lowest'

        steps:

            -   name: Update "USE_COVERAGE" env var based on matrix
                if: ${{ matrix.php-ver == '7.4' && matrix.wp-ver == '6.*' && matrix.dependency-versions == 'highest' }}
                run: echo "USE_COVERAGE=yes" >> $GITHUB_ENV

            -   name: Checkout
                uses: actions/checkout@v3

            -   name: Setup PHP
                uses: shivammathur/setup-php@v2
                with:
                    php-version: ${{ matrix.php-ver }}
                    ini-values: zend.assertions=1, error_reporting=E_ALL, display_errors=On
                    coverage: ${{ ((env.USE_COVERAGE == 'yes') && 'xdebug') || 'none' }}

            -   name: Adjust WP version
                run: |
                    composer remove --dev --no-update "roots/wordpress-no-content"
                    composer remove --dev --no-update "phpunit/phpunit"
                    composer require --no-update "roots/wordpress-no-content:${{ matrix.wp-ver }}"
                    composer require --no-update "phpunit/phpunit:^7.5.20 || ^9.6.4"

            -   name: Install dependencies
                uses: ramsey/composer-install@v2
                with:
                    dependency-versions: ${{ matrix.dependency-versions }}

            -   name: Run unit tests
                run: |
                    ./vendor/bin/phpunit --atleast-version 9 && ./vendor/bin/phpunit --migrate-configuration || echo 'Config does not need updates.'
                    ./vendor/bin/phpunit ${{ ((env.USE_COVERAGE == 'yes') && '--coverage-html=coverage-report') || '--no-coverage' }}

            -   name: Upload coverage report
                uses: actions/upload-artifact@v3
                if: ${{ env.USE_COVERAGE == 'yes' }}
                with:
                    name: coverage-report
                    path: coverage-report/

    lint:
        runs-on: ubuntu-latest
        if: ${{ !contains(github.event.head_commit.message, 'skip lint') }}
        strategy:
            fail-fast: true
            matrix:
                php-ver: [ '7.2', '7.3', '7.4', '8.0', '8.1', '8.2' ]
        steps:

            -   name: Checkout
                uses: actions/checkout@v3

            -   name: Setup PHP
                uses: shivammathur/setup-php@v2
                with:
                    php-version: ${{ matrix.php-ver }}
                    ini-values: zend.assertions=1, error_reporting=E_ALL, display_errors=On
                    tools: parallel-lint

            -   name: Check syntax error in sources
                run: parallel-lint ./