Changeset 58274

Timestamp:

05/31/2024 06:11:30 PM (4 months ago)

Author:

desrosj

Message:

Build/Test Tools: Make the logic around Playground testing reusable.

The workflow responsible for testing the build process is currently responsible for creating a ZIP file of the WordPress build and storing it as an artifact. This can be used for manual testing, but is mainly used for spinning up a Playground instance.

Because of how comments with Playground testing instructions are left pull requests. the pull request number needs to be stored as a workflow artifact as well. This moves the logic responsible for this to the reusable workflow, which allows older branches to make use of Playground testing without additional maintenance burden.

See #59416.

Location:

trunk/.github/workflows

Files:

• reusable-test-core-build-process.yml (modified) (3 diffs)
• test-build-processes.yml (modified) (2 diffs)

trunk/.github/workflows/reusable-test-core-build-process.yml

@@ -22 +22 @@
         type: 'boolean'
         default: true
+      prepare-playground:
+        description: 'Whether to prepare the artifacts needed for Playground testing.'
+        required: false
+        type: 'boolean'
+        default: false
 
 env:
@@ -40 +45 @@
   # - Ensures version-controlled files are not modified or deleted.
   # - Uploads the ZIP as a GitHub Actions artifact (when building to the build directory).
+  # - Saves the pull request number to a text file.
+  # - Uploads the pull request number as an artifact.
   build-process-tests:
     name: Core running from ${{ inputs.directory }} / ${{ inputs.os == 'macos-latest' && 'MacOS' || inputs.os == 'windows-latest' && 'Windows' || 'Linux' }}
@@ -91 +98 @@
       - name: Upload ZIP as a GitHub Actions artifact
         uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
-        if: ${{ inputs.directory == 'build' && 'ubuntu-latest' == inputs.os }}
+        if: ${{ inputs.prepare-playground }}
         with:
           name: wordpress-build-${{ github.event_name == 'pull_request' && github.event.number || github.sha }}
           path: wordpress.zip
           if-no-files-found: error
+
+      - name: Save PR number
+        if: ${{ inputs.prepare-playground && github.repository == 'WordPress/wordpress-develop' && github.event_name == 'pull_request' }}
+        run: |
+          mkdir -p ./pr-number
+          echo ${{ github.event.number }} > ./pr-number/NR
+
+      # Uploads the PR number as an artifact for the Pull Request Commenting workflow to download and then
+      # leave a comment detailing how to test the PR within WordPress Playground.
+      - name: Upload PR number as artifact
+        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
+        if: ${{ inputs.prepare-playground && github.repository == 'WordPress/wordpress-develop' && github.event_name == 'pull_request' }}
+        with:
+          name: pr-number
+          path: pr-number/

trunk/.github/workflows/test-build-processes.yml

@@ -41 +41 @@
         os: [ ubuntu-latest, windows-latest ]
         directory: [ 'src', 'build' ]
+        include:
+          # Only prepare artifacts for Playground once.
+          - os: ubuntu-latest
+            directory: 'build'
+            prepare-playground: true
     with:
       os: ${{ matrix.os }}
       directory: ${{ matrix.directory }}
+      prepare-playground: ${{ matrix.prepare-playground && matrix.prepare-playground || false }}
 
   # Tests the WordPress Core build process on MacOS.
@@ -107 +113 @@
       directory: ${{ matrix.directory }}
 
-  # Uploads the PR number as an artifact for the Pull Request Commenting workflow to download and then
-  # leave a comment detailing how to test the PR within WordPress Playground.
-  playground-comment:
-    name: Leave WordPress Playground details
-    runs-on: ubuntu-latest
-    permissions:
-      actions: write
-    continue-on-error: true
-    needs: [ test-core-build-process, test-core-build-process-macos, test-gutenberg-build-process, test-gutenberg-build-process-macos ]
-    if: ${{ github.repository == 'WordPress/wordpress-develop' && github.event_name == 'pull_request' }}
-
-    steps:
-      - name: Save PR number
-        run: |
-          mkdir -p ./pr-number
-          echo ${{ github.event.number }} > ./pr-number/NR
-
-      - name: Upload PR number as artifact
-        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
-        with:
-          name: pr-number
-          path: pr-number/
-
   slack-notifications:
     name: Slack Notifications