CS #553
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: 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 | |
| env: | |
| XMLLINT_INDENT: ' ' | |
| 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") | |
| # 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 | |
| # @link http://xmlsoft.org/xmllint.html | |
| - name: Install xmllint | |
| run: sudo apt-get install --no-install-recommends -y libxml2-utils | |
| - name: Download the XSD schema | |
| run: curl http://www.w3.org/2001/XMLSchema.xsd --output XMLSchema.xsd | |
| # Show XML violations inline in the file diff. | |
| # @link https://github.com/marketplace/actions/xmllint-problem-matcher | |
| - name: Enable showing XML issues inline | |
| uses: korelstar/xmllint-problem-matcher@v1 | |
| # Validate the XSD and XML files against schema. | |
| - name: Validate Docs XSD against schema | |
| run: xmllint --noout --schema XMLSchema.xsd DocsXsd/phpcsdocs.xsd | |
| - name: Validate PHPCSDebug ruleset against schema | |
| run: xmllint --noout --schema vendor/squizlabs/php_codesniffer/phpcs.xsd PHPCSDebug/ruleset.xml | |
| - name: Validate docs against schema | |
| run: xmllint --noout --schema DocsXsd/phpcsdocs.xsd ./PHPCSDebug/Docs/*/*Standard.xml | |
| # 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") | |
| # 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 | |
| phpstan: | |
| uses: PHPCSStandards/.github/.github/workflows/reusable-phpstan.yml@main |