Merge pull request #387 from Yoast/feature/various-minor-tweaks #528
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: | |
| paths-ignore: | |
| - '**.md' | |
| branches-ignore: | |
| - 'main' | |
| 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 | |
| # Use the WIP/develop branches of all CS dependencies as an early detection system for bugs upstream. | |
| - name: 'Composer: adjust dependencies - use dev versions of CS dependencies' | |
| run: > | |
| composer require --no-update --no-scripts --no-interaction | |
| squizlabs/php_codesniffer:"dev-master" | |
| phpcsstandards/phpcsutils:"dev-develop" | |
| phpcsstandards/phpcsextra:"dev-develop" | |
| wp-coding-standards/wpcs:"dev-develop as 3.99" # Alias needed to prevent composer conflict with VIPCS. | |
| slevomat/coding-standard:"dev-master" | |
| sirbrillig/phpcs-variable-analysis:"2.x" | |
| automattic/vipwpcs:"dev-develop" | |
| # 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 | |
| - name: Install xmllint | |
| run: sudo apt-get install --no-install-recommends -y libxml2-utils | |
| # 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 ruleset XML file. | |
| # @link http://xmlsoft.org/xmllint.html | |
| - name: Validate ruleset against XML schema | |
| run: xmllint --noout --schema ./vendor/squizlabs/php_codesniffer/phpcs.xsd ./Yoast/ruleset.xml | |
| # Validate the Docs XML files. | |
| # @link http://xmlsoft.org/xmllint.html | |
| - name: Validate the XML sniff docs against schema | |
| run: xmllint --noout --schema vendor/phpcsstandards/phpcsdevtools/DocsXsd/phpcsdocs.xsd ./Yoast/Docs/*/*Standard.xml | |
| # Check the code-style consistency of the XML ruleset files. | |
| - name: Check XML ruleset code style | |
| run: diff -B --tabsize=4 ./Yoast/ruleset.xml <(xmllint --format "./Yoast/ruleset.xml") | |
| # Check the codestyle of the files within YoastCS. | |
| # The results of the CS check will be shown inline in the PR via the CS2PR tool. | |
| # @link https://github.com/staabm/annotate-pull-request-from-checkstyle/ | |
| - name: Check PHP code style | |
| id: phpcs | |
| run: composer check-cs -- --no-cache --report-full --report-checkstyle=./phpcs-report.xml | |
| - name: Show PHPCS results in PR | |
| if: ${{ always() && steps.phpcs.outcome == 'failure' }} | |
| run: cs2pr ./phpcs-report.xml | |
| # Check that the sniffs available are feature complete. | |
| - name: Check sniff feature completeness | |
| run: composer check-complete | |
| phpstan: | |
| name: "PHPStan" | |
| 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: phpstan:1.x | |
| # Install dependencies and handle caching in one go. | |
| # Dependencies need to be installed to make sure the PHPCS and PHPUnit classes are recognized. | |
| # @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: Run PHPStan | |
| run: phpstan analyse |