Coding Standards #26982
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: Coding Standards | |
| on: | |
| # JSHint was introduced in WordPress 3.8. | |
| # PHPCS checking was introduced in WordPress 5.1. | |
| push: | |
| branches: | |
| - trunk | |
| - '3.[89]' | |
| - '[4-9].[0-9]' | |
| tags: | |
| - '[0-9]+.[0-9]' | |
| - '[0-9]+.[0-9].[0-9]+' | |
| - '!3.7.[0-9]+' | |
| pull_request: | |
| branches: | |
| - trunk | |
| - '3.[89]' | |
| - '[4-9].[0-9]' | |
| paths: | |
| # Any change to a PHP or JavaScript file should run checks. | |
| - '**.js' | |
| - '**.php' | |
| # These files configure npm. Changes could affect the outcome. | |
| - 'package*.json' | |
| # These files configure Composer. Changes could affect the outcome. | |
| - 'composer.*' | |
| # This file configures JSHint. Changes could affect the outcome. | |
| - '.jshintrc' | |
| # This file configures PHPCS. Changes could affect the outcome. | |
| - 'phpcs.xml.dist' | |
| # Changes to workflow files should always verify all workflows are successful. | |
| - '.github/workflows/*.yml' | |
| workflow_dispatch: | |
| # Cancels all previous workflow runs for pull requests that have not completed. | |
| concurrency: | |
| # The concurrency group contains the workflow name and the branch name for pull requests | |
| # or the commit hash for any other events. | |
| group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }} | |
| cancel-in-progress: true | |
| jobs: | |
| # Runs PHP coding standards checks. | |
| # | |
| # Violations are reported inline with annotations. | |
| # | |
| # Performs the following steps: | |
| # - Checks out the repository. | |
| # - Sets up PHP. | |
| # - Logs debug information. | |
| # - Configures caching for PHPCS scans. | |
| # - Installs Composer dependencies (use cache if possible). | |
| # - Make Composer packages available globally. | |
| # - Logs PHP_CodeSniffer debug information. | |
| # - Runs PHPCS on the full codebase with warnings suppressed. | |
| # - Runs PHPCS on the `tests` directory without warnings suppressed. | |
| # - Ensures version-controlled files are not modified or deleted. | |
| phpcs: | |
| name: PHP coding standards | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 20 | |
| if: ${{ github.repository == 'WordPress/wordpress-develop' || github.event_name == 'pull_request' }} | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0 | |
| - name: Set up PHP | |
| uses: shivammathur/setup-php@d30ad8b1843ace22e6698ab99bbafaa747b6bd0d # v2.24.0 | |
| with: | |
| php-version: '7.4' | |
| coverage: none | |
| tools: composer, cs2pr | |
| - name: Log debug information | |
| run: | | |
| php --version | |
| composer --version | |
| # This date is used to ensure that the PHPCS cache is cleared at least once every week. | |
| # http://man7.org/linux/man-pages/man1/date.1.html | |
| - name: "Get last Monday's date" | |
| id: get-date | |
| run: echo "date=$(/bin/date -u --date='last Mon' "+%F")" >> $GITHUB_OUTPUT | |
| - name: Cache PHPCS scan cache | |
| uses: actions/cache@69d9d449aced6a2ede0bc19182fadc3a0a42d2b0 # v3.2.6 | |
| with: | |
| path: .cache/phpcs.json | |
| key: ${{ runner.os }}-date-${{ steps.get-date.outputs.date }}-phpcs-cache-${{ hashFiles('**/composer.json', 'phpcs.xml.dist') }} | |
| - name: Install Composer dependencies | |
| uses: ramsey/composer-install@83af392bf5f031813d25e6fe4cd626cdba9a2df6 # v2.2.0 | |
| with: | |
| composer-options: "--no-progress --no-ansi" | |
| - name: Make Composer packages available globally | |
| run: echo "${PWD}/vendor/bin" >> $GITHUB_PATH | |
| - name: Log PHPCS debug information | |
| run: phpcs -i | |
| - name: Run PHPCS on all Core files | |
| run: phpcs -q -n --report=checkstyle | cs2pr | |
| - name: Check test suite files for warnings | |
| run: phpcs tests -q --report=checkstyle | cs2pr | |
| - name: Ensure version-controlled files are not modified during the tests | |
| run: git diff --exit-code | |
| # Runs the JavaScript coding standards checks. | |
| # | |
| # JSHint violations are not currently reported inline with annotations. | |
| # | |
| # Performs the following steps: | |
| # - Checks out the repository. | |
| # - Logs debug information about the GitHub Action runner. | |
| # - Installs Node.js. | |
| # - Logs updated debug information. | |
| # _ Installs npm dependencies. | |
| # - Run the WordPress JSHint checks. | |
| # - Ensures version-controlled files are not modified or deleted. | |
| jshint: | |
| name: JavaScript coding standards | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 20 | |
| if: ${{ github.repository == 'WordPress/wordpress-develop' || github.event_name == 'pull_request' }} | |
| env: | |
| PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: ${{ true }} | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0 | |
| - name: Log debug information | |
| run: | | |
| npm --version | |
| node --version | |
| git --version | |
| svn --version | |
| - name: Install Node.js | |
| uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 | |
| with: | |
| node-version-file: '.nvmrc' | |
| cache: npm | |
| - name: Log debug information | |
| run: | | |
| npm --version | |
| node --version | |
| - name: Install Dependencies | |
| run: npm ci | |
| - name: Run JSHint | |
| run: npm run grunt jshint | |
| - name: Ensure version-controlled files are not modified or deleted | |
| run: git diff --exit-code | |
| slack-notifications: | |
| name: Slack Notifications | |
| uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk | |
| needs: [ phpcs, jshint ] | |
| if: ${{ github.repository == 'WordPress/wordpress-develop' && github.event_name != 'pull_request' && always() }} | |
| with: | |
| calling_status: ${{ needs.phpcs.result == 'success' && needs.jshint.result == 'success' && 'success' || ( needs.phpcs.result == 'cancelled' || needs.jshint.result == 'cancelled' ) && 'cancelled' || 'failure' }} | |
| secrets: | |
| SLACK_GHA_SUCCESS_WEBHOOK: ${{ secrets.SLACK_GHA_SUCCESS_WEBHOOK }} | |
| SLACK_GHA_CANCELLED_WEBHOOK: ${{ secrets.SLACK_GHA_CANCELLED_WEBHOOK }} | |
| SLACK_GHA_FIXED_WEBHOOK: ${{ secrets.SLACK_GHA_FIXED_WEBHOOK }} | |
| SLACK_GHA_FAILURE_WEBHOOK: ${{ secrets.SLACK_GHA_FAILURE_WEBHOOK }} | |
| failed-workflow: | |
| name: Failed workflow tasks | |
| runs-on: ubuntu-latest | |
| needs: [ phpcs, jshint, slack-notifications ] | |
| if: | | |
| always() && | |
| github.repository == 'WordPress/wordpress-develop' && | |
| github.event_name != 'pull_request' && | |
| github.run_attempt < 2 && | |
| ( | |
| needs.phpcs.result == 'cancelled' || needs.phpcs.result == 'failure' || | |
| needs.jshint.result == 'cancelled' || needs.jshint.result == 'failure' | |
| ) | |
| steps: | |
| - name: Dispatch workflow run | |
| uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975 # v6.4.0 | |
| with: | |
| retries: 2 | |
| retry-exempt-status-codes: 418 | |
| script: | | |
| github.rest.actions.createWorkflowDispatch({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| workflow_id: 'failed-workflow.yml', | |
| ref: 'trunk', | |
| inputs: { | |
| run_id: '${{ github.run_id }}' | |
| } | |
| }); |