WAIT - PHPCSUtils | Compatibility with PHP_CodeSniffer 4.0 #628
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: CS | |
| on: | |
| # Run on all pushes and on all pull requests. | |
| # Prevent the build from running when there are only irrelevant changes. | |
| 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: | |
| checkcs: | |
| name: 'Basic CS and QA checks' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Install PHP | |
| uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: 'latest' | |
| coverage: none | |
| tools: cs2pr | |
| # Validate the composer.json file. | |
| # @link https://getcomposer.org/doc/03-cli.md#validate | |
| - 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 squizlabs/php_codesniffer:"dev-master" --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") | |
| # Validate the XSD and XML files against schema. | |
| - name: Validate Docs XSD against schema | |
| uses: phpcsstandards/xmllint-validate@v1 | |
| with: | |
| pattern: "DocsXsd/phpcsdocs.xsd" | |
| xsd-url: "https://www.w3.org/2012/04/XMLSchema.xsd" | |
| - name: Validate PHPCSDebug ruleset against schema | |
| uses: phpcsstandards/xmllint-validate@v1 | |
| with: | |
| pattern: "PHPCSDebug/ruleset.xml" | |
| xsd-file: "vendor/squizlabs/php_codesniffer/phpcs.xsd" | |
| - name: Validate docs against schema | |
| uses: phpcsstandards/xmllint-validate@v1 | |
| with: | |
| pattern: "PHPCSDebug/Docs/*/*Standard.xml" | |
| xsd-file: "DocsXsd/phpcsdocs.xsd" | |
| - name: Validate Project PHPCS ruleset against schema | |
| uses: phpcsstandards/xmllint-validate@v1 | |
| with: | |
| pattern: "phpcs.xml.dist" | |
| xsd-file: "vendor/squizlabs/php_codesniffer/phpcs.xsd" | |
| - name: "Validate PHPUnit < 10 config for use with PHPUnit 8" | |
| uses: phpcsstandards/xmllint-validate@v1 | |
| with: | |
| pattern: "phpunitlte9.xml.dist" | |
| xsd-file: "vendor/phpunit/phpunit/schema/8.5.xsd" | |
| - name: "Validate PHPUnit < 10 config for use with PHPUnit 9" | |
| uses: phpcsstandards/xmllint-validate@v1 | |
| with: | |
| pattern: "phpunitlte9.xml.dist" | |
| xsd-file: "vendor/phpunit/phpunit/schema/9.5.xsd" | |
| - name: "Validate PHPUnit 10+ config for use with PHPUnit 10" | |
| uses: phpcsstandards/xmllint-validate@v1 | |
| with: | |
| pattern: "phpunit.xml.dist" | |
| xsd-file: "vendor/phpunit/phpunit/schema/10.5.xsd" | |
| - name: "Validate PHPUnit 10+ config for use with PHPUnit 11" | |
| uses: phpcsstandards/xmllint-validate@v1 | |
| with: | |
| pattern: "phpunit.xml.dist" | |
| xsd-file: "vendor/phpunit/phpunit/phpunit.xsd" | |
| # Check the code-style consistency of the PHP files. | |
| - name: Check PHP code style | |
| id: phpcs | |
| run: composer checkcs -- --report-full --report-checkstyle=./phpcs-report.xml | |
| - name: Show PHPCS results in PR | |
| if: ${{ always() && steps.phpcs.outcome == 'failure' }} | |
| run: cs2pr ./phpcs-report.xml | |
| xml-cs: | |
| name: 'XML Code style' | |
| runs-on: ubuntu-latest | |
| env: | |
| XMLLINT_INDENT: ' ' | |
| 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 | |
| # Show XML violations inline in the file diff. | |
| - name: Enable showing XML issues inline | |
| uses: korelstar/xmllint-problem-matcher@v1 | |
| # Check code-style consistency of the XSD and XML files. | |
| - name: Check XSD code style | |
| run: diff -B ./DocsXsd/phpcsdocs.xsd <(xmllint --format "./DocsXsd/phpcsdocs.xsd") | |
| - name: Check Ruleset XML code style | |
| run: diff -B ./PHPCSDebug/ruleset.xml <(xmllint --format "./PHPCSDebug/ruleset.xml") | |
| phpstan: | |
| uses: PHPCSStandards/.github/.github/workflows/reusable-phpstan.yml@main | |
| markdownlint: | |
| name: 'Lint Markdown' | |
| uses: PHPCSStandards/.github/.github/workflows/reusable-markdownlint.yml@main | |
| remark: | |
| name: 'QA Markdown' | |
| uses: PHPCSStandards/.github/.github/workflows/reusable-remark.yml@main | |
| yamllint: | |
| name: 'Lint Yaml' | |
| uses: PHPCSStandards/.github/.github/workflows/reusable-yamllint.yml@main | |
| with: | |
| strict: true |