Merge pull request #690 from PHPCSStandards/feature/ruleinclusiontest… #2551
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: Validate | |
| on: | |
| # Run on all pushes and on all pull requests. | |
| push: | |
| pull_request: | |
| # Also run this workflow every Monday at 6:00 (to make sure the broken link check runs regularly). | |
| schedule: | |
| - cron: '0 6 * * 1' | |
| # 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: | |
| checkxml: | |
| name: Check XML files | |
| runs-on: ubuntu-latest | |
| # Don't run the cronjob in this workflow on forks. | |
| if: github.event_name != 'schedule' || (github.event_name == 'schedule' && github.repository_owner == 'PHPCSStandards') | |
| 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 | |
| - name: Retrieve XML Schema | |
| run: curl -O https://www.w3.org/2012/04/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 XML ruleset files. | |
| # @link http://xmlsoft.org/xmllint.html | |
| - name: Validate rulesets against schema | |
| run: xmllint --noout --schema phpcs.xsd ./src/Standards/*/ruleset.xml | |
| # Validate the XSD file. | |
| # @link http://xmlsoft.org/xmllint.html | |
| - name: Validate XSD against schema | |
| run: xmllint --noout --schema ./XMLSchema.xsd ./phpcs.xsd | |
| # Check the code-style consistency of the XML files. | |
| - name: Check XML code style | |
| run: | | |
| diff -B ./phpcs.xml.dist <(xmllint --format "./phpcs.xml.dist") | |
| diff -B ./src/Standards/Generic/ruleset.xml <(xmllint --format "./src/Standards/Generic/ruleset.xml") | |
| diff -B ./src/Standards/MySource/ruleset.xml <(xmllint --format "./src/Standards/MySource/ruleset.xml") | |
| diff -B ./src/Standards/PEAR/ruleset.xml <(xmllint --format "./src/Standards/PEAR/ruleset.xml") | |
| diff -B ./src/Standards/PSR1/ruleset.xml <(xmllint --format "./src/Standards/PSR1/ruleset.xml") | |
| diff -B ./src/Standards/PSR2/ruleset.xml <(xmllint --format "./src/Standards/PSR2/ruleset.xml") | |
| diff -B ./src/Standards/PSR12/ruleset.xml <(xmllint --format "./src/Standards/PSR12/ruleset.xml") | |
| diff -B ./src/Standards/Squiz/ruleset.xml <(xmllint --format "./src/Standards/Squiz/ruleset.xml") | |
| diff -B ./src/Standards/Zend/ruleset.xml <(xmllint --format "./src/Standards/Zend/ruleset.xml") | |
| # Validate the basic well-formedness of the Documentation XML files. | |
| - name: Validate documentation XML | |
| run: xmllint --noout ./src/Standards/*/Docs/*/*Standard.xml | |
| yamllint: | |
| name: 'Lint Yaml' | |
| # Don't run the cronjob in this workflow on forks. | |
| if: github.event_name != 'schedule' || (github.event_name == 'schedule' && github.repository_owner == 'PHPCSStandards') | |
| uses: PHPCSStandards/.github/.github/workflows/reusable-yamllint.yml@main | |
| with: | |
| strict: true | |
| markdownlint: | |
| name: 'Lint Markdown' | |
| # Don't run the cronjob in this workflow on forks. | |
| if: github.event_name != 'schedule' || (github.event_name == 'schedule' && github.repository_owner == 'PHPCSStandards') | |
| uses: PHPCSStandards/.github/.github/workflows/reusable-markdownlint.yml@main | |
| remark: | |
| name: 'QA Markdown' | |
| # Don't run the cronjob in this workflow on forks. | |
| if: github.event_name != 'schedule' || (github.event_name == 'schedule' && github.repository_owner == 'PHPCSStandards') | |
| uses: PHPCSStandards/.github/.github/workflows/reusable-remark.yml@main |