Changeset 57124

Timestamp:

11/17/2023 06:22:49 PM (13 months ago)

Author:

desrosj

Message:

Build/Test Tools: Comment on PRs with WordPress Playground information.

After [56958], pull requests to wordpress-develop can be tested within a WordPress Playground instance. However this capability is not obvious.

This makes several updates to GitHub action workflows to avoid unnecessary extra runs/jobs while also commenting on pull requests with proper context for testing in Playground once a build is available for the PR.

Changes:

• The build.yml workflow has been deleted. The WordPress build process is already being tested within the test-build-processes.yml workflow. Now that workflow will produce and upload the built artifact for the given PR.
• A pull-request-comments.yml workflow has been added to handle the commenting. To avoid having multiple workflows that comment on PRs, the logic within the welcome-new-contributors.yml workflow has been merged into this one.
• The pull_request event trigger lacks the needed permission to comment on or update pull requests. Instead of using pull_request_target to navigate around this, the test-build-processes.yml workflow will now use workflow_dispatch to initiate a run of the commenting workflow. This adds the ability to only comment on the PR when a build has been successfully created and uploaded as an artifact.

Props swissspidy, zieladam, jeffpaul.
See #59416.

Location:

trunk/.github/workflows

Files:

• build.yml (deleted)
• callable-test-core-build-process.yml (modified) (2 diffs)
• pull-request-comments.yml (added)
• test-build-processes.yml (modified) (4 diffs)
• welcome-new-contributors.yml (deleted)

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

@@ -33 +33 @@
   # - Cleans up after building WordPress.
   # - Ensures version-controlled files are not modified or deleted.
+  # - Creates a ZIP of the built WordPress files (when building to the build directory).
+  # - Uploads the ZIP as a GitHub Actions artifact (when building to the build directory).
   build-process-tests:
     name: Core running from ${{ inputs.directory }} / ${{ inputs.os == 'macos-latest' && 'MacOS' || inputs.os == 'windows-latest' && 'Windows' || 'Linux' }}
@@ -72 +74 @@
       - name: Ensure version-controlled files are not modified or deleted during cleaning
         run: git diff --exit-code
+
+      - name: Create ZIP of built files
+        if: ${{ inputs.directory == 'build' && 'ubuntu-latest' == inputs.os }}
+        run: zip -r wordpress.zip build/.
+
+      - name: Upload ZIP as a GitHub Actions artifact
+        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        if: ${{ inputs.directory == 'build' && 'ubuntu-latest' == inputs.os }}
+        with:
+          name: wordpress-build-${{ github.event_name == 'pull_request' && github.event.number || github.sha }}
+          path: wordpress.zip
+          if-no-files-found: error

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

@@ -15 +15 @@
       - '3.[7-9]'
       - '[4-9].[0-9]'
-    paths:
-      # These files configure npm. Changes could affect the outcome.
-      - 'package*.json'
-      # JavaScript files are built using npm.
-      - '**.js'
-      # CSS and SCSS files are built using npm.
-      - '**.scss'
-      - '**.css'
-      # Changes to workflow files should always verify all workflows are successful.
-      - '.github/workflows/**.yml'
   workflow_dispatch:
 
@@ -117 +107 @@
       directory: ${{ matrix.directory }}
 
+  # Calls the Pull Request Commenting workflow to 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
+    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: Dispatch workflow run
+        uses: actions/github-script@d7906e4ad0b1822421a7e6a35d5ca353c962f410 # v6.4.1
+        with:
+          retries: 2
+          retry-exempt-status-codes: 418
+          script: |
+            github.rest.actions.createWorkflowDispatch({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              workflow_id: 'pull-request-comments.yml',
+              ref: 'trunk',
+              inputs: {
+                pr_number: '${{ github.event.number }}'
+              }
+            });
+
   slack-notifications:
     name: Slack Notifications
@@ -123 +139 @@
       actions: read
       contents: read
-    needs: [ test-core-build-process, test-core-build-process-macos, test-gutenberg-build-process, test-gutenberg-build-process-macos ]
+    needs: [ test-core-build-process, test-core-build-process-macos, test-gutenberg-build-process, test-gutenberg-build-process-macos, playground-comment ]
     if: ${{ github.repository == 'WordPress/wordpress-develop' && github.event_name != 'pull_request' && always() }}
     with:
@@ -138 +154 @@
     permissions:
       actions: write
-    needs: [ slack-notifications ]
+    needs: [ playground-comment ]
     if: |
       always() &&