Compatibility with PHP_CodeSniffer 4.0 #379
This file contains hidden or 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: Quicktest | |
| on: | |
| # Run on pushes, including merges, to all branches except `stable`. | |
| push: | |
| branches-ignore: | |
| - stable | |
| # 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: | |
| # Run CI checks/tests which have no dependency on the PHPCS version used. | |
| quicktest-php: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| php: ['5.4', 'latest'] | |
| name: "QTest + Lint: PHP ${{ matrix.php }}" | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| # Updating the lists can fail intermittently, typically after Microsoft has released a new package. | |
| # This should not be blocking for this job, so ignore any errors from this step. | |
| # Ref: https://github.com/dotnet/core/issues/4167 | |
| - name: Update the available packages list | |
| continue-on-error: true | |
| run: sudo apt-get update | |
| - name: Install xmllint | |
| run: sudo apt-get install --no-install-recommends -y libxml2-utils | |
| - name: Install PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: ${{ matrix.php }} | |
| ini-values: error_reporting=-1, display_errors=On | |
| coverage: none | |
| # Install dependencies and handle caching in one go. | |
| # @link https://github.com/marketplace/actions/install-php-dependencies-with-composer | |
| - 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: Lint against parse errors (PHP 7.2+) | |
| if: ${{ matrix.php >= '7.2' }} | |
| run: composer lint | |
| - name: Lint against parse errors (PHP < 7.2) | |
| if: ${{ matrix.php < '7.2' }} | |
| run: composer lintlt72 | |
| # Check that any sniffs available are feature complete. | |
| # This acts as an integration test for the feature completeness script, | |
| # which is why it is run against various PHP versions. | |
| - name: Check for feature completeness | |
| run: composer check-complete | |
| - name: Grab PHPUnit version | |
| id: phpunit_version | |
| # yamllint disable rule:line-length | |
| run: echo "VERSION=$(vendor/bin/phpunit --version | grep --only-matching --max-count=1 --extended-regexp '\b[0-9]+\.[0-9]+')" >> "$GITHUB_OUTPUT" | |
| # yamllint enable rule:line-length | |
| - name: Determine PHPUnit composer script to use | |
| id: phpunit_script | |
| run: | | |
| if [ "${{ startsWith( steps.phpunit_version.outputs.VERSION, '11.' ) }}" == "true" ]; then | |
| echo 'SUFFIX=' >> "$GITHUB_OUTPUT" | |
| elif [ "${{ startsWith( steps.phpunit_version.outputs.VERSION, '10.' ) }}" == "true" ]; then | |
| echo 'SUFFIX=' >> "$GITHUB_OUTPUT" | |
| else | |
| echo 'SUFFIX=-lte9' >> "$GITHUB_OUTPUT" | |
| fi | |
| - name: Run the unit tests for the DevTools | |
| run: composer test-tools${{ steps.phpunit_script.outputs.SUFFIX }} | |
| # Run CI checks/tests which have a dependency on the PHPCS version used. | |
| quicktest-phpcs: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| php: ['5.4', 'latest'] | |
| phpcs_version: ['3.1.0', 'dev-master'] | |
| include: | |
| - php: '7.2' | |
| phpcs_version: '4.0.0' | |
| - php: 'latest' | |
| phpcs_version: 'dev-4.x' | |
| name: "QTest: PHP ${{ matrix.php }} - PHPCS ${{ matrix.phpcs_version }}" | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| # 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. | |
| - name: Setup ini config | |
| id: set_ini | |
| run: | | |
| if [ "${{ startsWith( matrix.phpcs_version, 'dev-' ) }}" == "true" ]; 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" | |
| 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 the PHPCSDevCS dependency as it has different PHPCS requirements and would block installs. | |
| composer remove --no-update --dev phpcsstandards/phpcsdevcs --no-scripts --no-interaction | |
| # Set the PHPCS version to be used in the tests. | |
| composer require --no-update squizlabs/php_codesniffer:"${{ matrix.phpcs_version }}" --no-scripts --no-interaction | |
| # Install dependencies and handle caching in one go. | |
| # @link https://github.com/marketplace/actions/install-php-dependencies-with-composer | |
| - 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: Grab PHPUnit version | |
| id: phpunit_version | |
| # yamllint disable rule:line-length | |
| run: echo "VERSION=$(vendor/bin/phpunit --version | grep --only-matching --max-count=1 --extended-regexp '\b[0-9]+\.[0-9]+')" >> "$GITHUB_OUTPUT" | |
| # yamllint enable rule:line-length | |
| - name: Determine PHPUnit composer script to use | |
| id: phpunit_script | |
| run: | | |
| if [ "${{ startsWith( steps.phpunit_version.outputs.VERSION, '11.' ) }}" == "true" ]; then | |
| echo 'SUFFIX=' >> "$GITHUB_OUTPUT" | |
| elif [ "${{ startsWith( steps.phpunit_version.outputs.VERSION, '10.' ) }}" == "true" ]; then | |
| echo 'SUFFIX=' >> "$GITHUB_OUTPUT" | |
| else | |
| echo 'SUFFIX=-lte9' >> "$GITHUB_OUTPUT" | |
| fi | |
| - name: Run the unit tests for the PHPCSDebug sniff | |
| run: composer test-sniff${{ steps.phpunit_script.outputs.SUFFIX }} |