test-and-zip-default-themes.yml

name: Test Default Themes & Create ZIPs

on:
  push:
    branches:
      - trunk
      - '3.[89]'
      - '[4-9].[0-9]'
    paths:
      # Changing the preferred version of Node.js could affect themes with build processes.
      - '.npmrc'
      - '.nvmrc'
      # Changes to any themes with a build script should be confirmed.
      - 'src/wp-content/themes/twentynineteen/**'
      - 'src/wp-content/themes/twentytwenty/**'
      - 'src/wp-content/themes/twentytwentyone/**'
      # Changes to this workflow file should always verify success.
      - '.github/workflows/test-and-zip-default-themes.yml'
  pull_request:
    branches:
      - trunk
      - '3.[89]'
      - '[4-9].[0-9]'
    paths:
      # Changing the preferred version of Node.js could affect themes with build processes.
      - '.npmrc'
      - '.nvmrc'
      # Changes to any themes with a build script should be confirmed.
      - 'src/wp-content/themes/twentynineteen/**'
      - 'src/wp-content/themes/twentytwenty/**'
      - 'src/wp-content/themes/twentytwentyone/**'
      # Changes to this workflow file should always verify success.
      - '.github/workflows/test-and-zip-default-themes.yml'
  workflow_dispatch:
    inputs:
      branch:
        description: 'The branch to create ZIP files from'
        required: true
        type: string
        default: 'trunk'

# 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

# Disable permissions for all available scopes by default.
# Any needed permissions should be configured at the job level.
permissions: {}

jobs:
  # Checks for zero-byte files.
  #
  # Occasionally, binary files such as images and fonts are added to themes incorrectly.
  # This checks that all files contain contents.
  #
  # Performs the following steps:
  # - Checks out the repository.
  # - Checks for zero-byte (empty) files.
  check-for-empty-files:
    name: ${{ matrix.theme }} empty file check
    runs-on: ubuntu-24.04
    permissions:
      contents: read
    timeout-minutes: 10
    if: ${{ github.repository == 'WordPress/wordpress-develop' || ( github.event_name == 'pull_request' && github.actor != 'dependabot[bot]' ) }}
    strategy:
      fail-fast: false
      matrix:
        theme: [
          'twentytwentyfive',
          'twentytwentyfour',
          'twentytwentythree',
          'twentytwentytwo',
          'twentytwentyone',
          'twentytwenty',
          'twentynineteen',
          'twentyseventeen',
          'twentysixteen',
          'twentyfifteen',
          'twentyfourteen',
          'twentythirteen',
          'twentytwelve',
          'twentyeleven',
          'twentyten'
        ]

    steps:
      - name: Checkout repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          ref: ${{ github.event_name == 'workflow_dispatch' && inputs.branch || github.ref }}
          show-progress: ${{ runner.debug == '1' && 'true' || 'false' }}
          persist-credentials: false

      - name: Check for zero-byte (empty) files
        run: |
          [[ ! $(find "src/wp-content/themes/${THEME}" -empty) ]]
        env:
          THEME: ${{ matrix.theme }}

  # Tests the build script for themes that have one.
  #
  # Performs the following steps:
  # - Checks out the repository.
  # - Sets up Node.js.
  # - Installs npm dependencies.
  # - Runs the theme build script.
  # - Ensures version-controlled files are not modified or deleted.
  test-build-scripts:
    name: Test ${{ matrix.theme }} build script
    runs-on: ubuntu-24.04
    permissions:
      contents: read
    timeout-minutes: 10
    if: ${{ github.repository == 'WordPress/wordpress-develop' || ( github.event_name == 'pull_request' && github.actor != 'dependabot[bot]' ) }}
    strategy:
      fail-fast: false
      matrix:
        theme: [
            'twentytwentyone',
            'twentytwenty',
            'twentynineteen',
        ]

    defaults:
      run:
        working-directory: src/wp-content/themes/${{ matrix.theme }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          ref: ${{ github.event_name == 'workflow_dispatch' && inputs.branch || github.ref }}
          show-progress: ${{ runner.debug == '1' && 'true' || 'false' }}
          persist-credentials: false

      - name: Set up Node.js
        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
        with:
          node-version-file: '.nvmrc'
          cache: npm
          cache-dependency-path: src/wp-content/themes/${{ matrix.theme }}/package-lock.json

      - name: Install npm dependencies
        run: npm ci

      - name: Build theme
        run: npm run build

      - name: Check for changes to versioned files
        id: built-file-check
        if: ${{ github.event_name == 'pull_request' }}
        run: |
          if git diff --quiet; then
            echo "uncommitted_changes=false" >> "$GITHUB_OUTPUT"
          else
            echo "uncommitted_changes=true" >> "$GITHUB_OUTPUT"
          fi

      - name: Display changes to versioned files
        if: ${{ steps.built-file-check.outputs.uncommitted_changes == 'true' }}
        run: git diff

      - name: Save diff to a file
        if: ${{ steps.built-file-check.outputs.uncommitted_changes == 'true' }}
        run: git diff > ./changes.diff

      # Uploads the diff file as an artifact.
      - name: Upload diff file as artifact
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
        if: ${{ steps.built-file-check.outputs.uncommitted_changes == 'true' }}
        with:
          name: pr-built-file-changes
          path: src/wp-content/themes/${{ matrix.theme }}/changes.diff

      - name: Ensure version-controlled files are not modified or deleted
        run: git diff --exit-code

  # Prepares bundled themes for release.
  #
  # Performs the following steps:
  # - Checks out the repository.
  # - Uploads the theme files as a workflow artifact (files uploaded as an artifact are automatically zipped).
  bundle-theme:
    name: Create ${{ matrix.theme }} ZIP file
    runs-on: ubuntu-24.04
    permissions:
      contents: read
    needs: [ check-for-empty-files, test-build-scripts ]
    timeout-minutes: 10
    if: ${{ github.repository == 'WordPress/wordpress-develop' }}
    strategy:
      fail-fast: false
      matrix:
        theme: [
            'twentytwentyfive',
            'twentytwentyfour',
            'twentytwentythree',
            'twentytwentytwo',
            'twentytwentyone',
            'twentytwenty',
            'twentynineteen',
            'twentyseventeen',
            'twentysixteen',
            'twentyfifteen',
            'twentyfourteen',
            'twentythirteen',
            'twentytwelve',
            'twentyeleven',
            'twentyten'
        ]

    steps:
      - name: Checkout repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          ref: ${{ github.event_name == 'workflow_dispatch' && inputs.branch || github.ref }}
          show-progress: ${{ runner.debug == '1' && 'true' || 'false' }}
          persist-credentials: false

      - name: Upload theme ZIP as an artifact
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
        with:
          name: ${{ matrix.theme }}
          path: src/wp-content/themes/${{ matrix.theme }}
          if-no-files-found: error
          include-hidden-files: true

  slack-notifications:
    name: Slack Notifications
    uses: ./.github/workflows/slack-notifications.yml
    permissions:
      actions: read
      contents: read
    needs: [ check-for-empty-files, bundle-theme, test-build-scripts ]
    if: ${{ github.repository == 'WordPress/wordpress-develop' && github.event_name != 'pull_request' && always() }}
    with:
      calling_status: ${{ contains( needs.*.result, 'cancelled' ) && 'cancelled' || contains( needs.*.result, 'failure' ) && 'failure' || 'success' }}
    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-24.04
    permissions:
      actions: write
    needs: [ slack-notifications ]
    if: |
      always() &&
      github.repository == 'WordPress/wordpress-develop' &&
      github.event_name != 'pull_request' &&
      github.run_attempt < 2 &&
      (
        contains( needs.*.result, 'cancelled' ) ||
        contains( needs.*.result, 'failure' )
      )

    steps:
      - name: Dispatch workflow run
        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
        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: `${context.runId}`,
              }
            });