Switch to PHPCSStandards/PHP_CodeSniffer #293
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Test | |
| on: | |
| # Run on all pushes and pull requests. | |
| push: | |
| pull_request: | |
| # 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: | |
| #### TEST STAGE #### | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| # The GHA matrix works different from Travis. | |
| # You can define jobs here and then augment them with extra variables in `include`, | |
| # as well as add extra jobs in `include`. | |
| # @link https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix | |
| # | |
| # IMPORTANT: test runs shouldn't fail because of PHPCS being incompatible with a PHP version. | |
| # - PHPCS will run without errors on PHP 5.4 - 7.4 on all supported PHPCS versions. | |
| # - PHP 8.0 needs PHPCS 3.5.7+ to run without errors. | |
| # - PHP 8.1 needs PHPCS 3.6.1+ to run without errors. | |
| # - PHP 8.2 needs PHPCS 3.6.1+ to run without errors. | |
| # - PHP 8.3 needs PHPCS 3.8.0+ to run without errors (though the errors don't affect this package). | |
| # | |
| # The matrix is set up so as not to duplicate the builds which are run for code coverage. | |
| php: ['5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2'] | |
| phpcs_version: ['3.8.0', 'dev-master'] | |
| include: | |
| # Experimental builds. | |
| - php: '8.4' # Nightly. | |
| phpcs_version: 'dev-master' | |
| name: "Test: PHP ${{ matrix.php }} on PHPCS ${{ matrix.phpcs_version }}" | |
| continue-on-error: ${{ matrix.php == '8.4' }} | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Setup ini config | |
| id: set_ini | |
| run: | | |
| # On stable PHPCS versions, 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. | |
| if [ "${{ matrix.phpcs_version }}" != "dev-master" ]; then | |
| echo 'PHP_INI=error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On, zend.assertions=1' >> $GITHUB_OUTPUT | |
| else | |
| echo 'PHP_INI=error_reporting=-1, display_errors=On, zend.assertions=1' >> $GITHUB_OUTPUT | |
| fi | |
| - name: Install PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php }} | |
| ini-values: ${{ steps.set_ini.outputs.PHP_INI }} | |
| coverage: none | |
| - name: 'Composer: adjust dependencies' | |
| run: | | |
| # Remove dev dependencies which are not compatible with all supported PHP versions. | |
| composer remove --dev --no-update sirbrillig/phpcs-import-detection phpstan/phpstan | |
| # Set the PHPCS version for this test run. | |
| composer require --no-update phpcsstandards/php_codesniffer:"${{ matrix.phpcs_version }}" | |
| # Install dependencies and handle caching in one go. | |
| # @link https://github.com/marketplace/actions/install-php-dependencies-with-composer | |
| - name: Install Composer dependencies - normal | |
| if: ${{ matrix.php != '8.4' }} | |
| uses: "ramsey/composer-install@v2" | |
| with: | |
| # Bust the cache at least once a month - output format: YYYY-MM. | |
| custom-cache-suffix: $(date -u "+%Y-%m") | |
| # For the PHP "nightly", we need to install with ignore platform reqs as not all dependencies allow it yet. | |
| - name: Install Composer dependencies - with ignore platform | |
| if: ${{ matrix.php == '8.4' }} | |
| uses: "ramsey/composer-install@v2" | |
| with: | |
| composer-options: --ignore-platform-req=php | |
| custom-cache-suffix: $(date -u "+%Y-%m") | |
| - name: Run the unit tests | |
| run: composer test | |
| #### CODE COVERAGE STAGE #### | |
| # N.B.: Coverage is only checked on the lowest and highest stable PHP versions | |
| # and low/high for PHPCS. | |
| coverage: | |
| # No use running the coverage builds if there are failing test builds. | |
| needs: test | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| include: | |
| - php: '8.3' | |
| phpcs_version: 'dev-master' | |
| - php: '8.3' | |
| phpcs_version: '3.8.0' | |
| - php: '5.4' | |
| phpcs_version: 'dev-master' | |
| - php: '5.4' | |
| phpcs_version: '3.8.0' | |
| name: "Coverage: PHP ${{ matrix.php }} on PHPCS ${{ matrix.phpcs_version }}" | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Setup ini config | |
| id: set_ini | |
| run: | | |
| # On stable PHPCS versions, 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. | |
| if [ "${{ matrix.phpcs_version }}" != "dev-master" ]; then | |
| echo 'PHP_INI=error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On, zend.assertions=1' >> $GITHUB_OUTPUT | |
| else | |
| echo 'PHP_INI=error_reporting=-1, display_errors=On, zend.assertions=1' >> $GITHUB_OUTPUT | |
| fi | |
| - name: Install PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php }} | |
| ini-values: ${{ steps.set_ini.outputs.PHP_INI }} | |
| coverage: xdebug | |
| - name: 'Composer: adjust dependencies' | |
| run: | | |
| # Remove dev dependencies which are not compatible with all supported PHP/PHPCS versions. | |
| composer remove --dev --no-update phpcsstandards/phpcsdevcs sirbrillig/phpcs-import-detection phpstan/phpstan | |
| composer require --no-update phpcsstandards/php_codesniffer:"${{ matrix.phpcs_version }}" | |
| - name: Install Composer dependencies | |
| uses: "ramsey/composer-install@v2" | |
| with: | |
| # Bust the cache at least once a month - output format: YYYY-MM. | |
| custom-cache-suffix: $(date -u "+%Y-%m") | |
| - name: Grab PHPUnit version | |
| id: phpunit_version | |
| run: echo "VERSION=$(vendor/bin/phpunit --version | grep --only-matching --max-count=1 --extended-regexp '\b[0-9]+\.[0-9]+')" >> $GITHUB_OUTPUT | |
| - name: "DEBUG: Show grabbed version" | |
| run: echo ${{ steps.phpunit_version.outputs.VERSION }} | |
| # PHPUnit 9.3 started using PHP-Parser for code coverage which can cause interference. | |
| # As of PHPUnit 9.3.4, a cache warming option is available. | |
| # Using that option prevents issues with PHP-Parser backfilling PHP tokens when PHPCS does not (yet), | |
| # which would otherwise cause tests to fail on tokens being available when they shouldn't be. | |
| - name: "Warm the PHPUnit cache (PHPUnit 9.3+)" | |
| if: ${{ steps.phpunit_version.outputs.VERSION >= '9.3' }} | |
| run: vendor/bin/phpunit --coverage-cache ./build/phpunit-cache --warm-coverage-cache | |
| - name: "Run the unit tests with code coverage (PHPUnit < 9.3)" | |
| if: ${{ steps.phpunit_version.outputs.VERSION < '9.3' }} | |
| run: composer coverage | |
| - name: "Run the unit tests with code coverage (PHPUnit 9.3+)" | |
| if: ${{ steps.phpunit_version.outputs.VERSION >= '9.3' }} | |
| run: composer coverage -- --coverage-cache ./build/phpunit-cache | |
| - name: Upload coverage results to Coveralls | |
| if: ${{ success() }} | |
| uses: coverallsapp/github-action@v2 | |
| with: | |
| format: clover | |
| file: build/logs/clover.xml | |
| flag-name: php-${{ matrix.php }}-phpcs-${{ matrix.phpcs_version }} | |
| parallel: true | |
| coveralls-finish: | |
| needs: coverage | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Coveralls Finished | |
| uses: coverallsapp/github-action@v2 | |
| with: | |
| parallel-finished: true |