Changeset 59673

Timestamp:

01/21/2025 03:40:51 PM (3 months ago)

Author:

johnbillion

Message:

Build/Test Tools: Switch to using local references for reusable workflows.

The benefit of this is that when PRs are made to make changes to a reusable workflow, the references doesn't need to be updated to point to the fork in order for the changed workflow to run.

A npm run grunt replace:workflow-references-local-to-remote command has also been introduced in order to convert these local references back to remote ones. This command can be used to switch release branches over to using remote workflows, as they are currently, so they continue to benefit from workflow changes in trunk without the need for continual backporting to all the branches.

Props desrosj, johnbillion

Fixes #62416

Location:

trunk

Files:

• .github/workflows/coding-standards.yml (modified) (3 diffs)
• .github/workflows/end-to-end-tests.yml (modified) (2 diffs)
• .github/workflows/install-testing.yml (modified) (2 diffs)
• .github/workflows/javascript-tests.yml (modified) (2 diffs)
• .github/workflows/local-docker-environment.yml (modified) (3 diffs)
• .github/workflows/performance.yml (modified) (2 diffs)
• .github/workflows/php-compatibility.yml (modified) (2 diffs)
• .github/workflows/phpunit-tests.yml (modified) (5 diffs)
• .github/workflows/test-and-zip-default-themes.yml (modified) (1 diff)
• .github/workflows/test-build-processes.yml (modified) (5 diffs)
• .github/workflows/test-coverage.yml (modified) (2 diffs)
• .github/workflows/test-old-branches.yml (modified) (1 diff)
• .github/workflows/upgrade-testing.yml (modified) (8 diffs)
• Gruntfile.js (modified) (2 diffs)

trunk/.github/workflows/coding-standards.yml

@@ -50 +50 @@
   phpcs:
     name: PHP coding standards
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-coding-standards-php.yml@trunk
+    uses: ./.github/workflows/reusable-coding-standards-php.yml
     permissions:
       contents: read
@@ -58 +58 @@
   jshint:
     name: JavaScript coding standards
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-coding-standards-javascript.yml@trunk
+    uses: ./.github/workflows/reusable-coding-standards-javascript.yml
     permissions:
       contents: read
@@ -65 +65 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/.github/workflows/end-to-end-tests.yml

@@ -39 +39 @@
   e2e-tests:
     name: Test with SCRIPT_DEBUG ${{ matrix.LOCAL_SCRIPT_DEBUG && 'enabled' || 'disabled' }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-end-to-end-tests.yml@trunk
+    uses: ./.github/workflows/reusable-end-to-end-tests.yml
     permissions:
       contents: read
@@ -52 +52 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/.github/workflows/install-testing.yml

@@ -44 +44 @@
   build-test-matrix:
     name: Build Test Matrix
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-support-json-reader-v1.yml@trunk
+    uses: ./.github/workflows/reusable-support-json-reader-v1.yml
     permissions:
       contents: read
@@ -133 +133 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/.github/workflows/javascript-tests.yml

@@ -48 +48 @@
   test-js:
     name: QUnit Tests
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-javascript-tests.yml@trunk
+    uses: ./.github/workflows/reusable-javascript-tests.yml
     permissions:
       contents: read
@@ -55 +55 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/.github/workflows/local-docker-environment.yml

@@ -64 +64 @@
   build-test-matrix:
     name: Build Test Matrix
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-support-json-reader-v1.yml@trunk
+    uses: ./.github/workflows/reusable-support-json-reader-v1.yml
     permissions:
       contents: read
@@ -75 +75 @@
   environment-tests-mysql:
     name: PHP ${{ matrix.php }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-test-local-docker-environment-v1.yml@trunk
+    uses: ./.github/workflows/reusable-test-local-docker-environment-v1.yml
     permissions:
       contents: read
@@ -109 +109 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/.github/workflows/performance.yml

@@ -34 +34 @@
   performance:
     name: ${{ matrix.multisite && 'Multisite' || 'Single site' }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-performance.yml@trunk
+    uses: ./.github/workflows/reusable-performance.yml
     permissions:
       contents: read
@@ -51 +51 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/.github/workflows/php-compatibility.yml

@@ -45 +45 @@
   php-compatibility:
     name: Check PHP compatibility
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-php-compatibility.yml@trunk
+    uses: ./.github/workflows/reusable-php-compatibility.yml
     permissions:
       contents: read
@@ -52 +52 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/.github/workflows/phpunit-tests.yml

@@ -37 +37 @@
   test-with-mysql:
     name: PHP ${{ matrix.php }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-phpunit-tests-v3.yml@trunk
+    uses: ./.github/workflows/reusable-phpunit-tests-v3.yml
     permissions:
       contents: read
@@ -108 +108 @@
   test-with-mariadb:
     name: PHP ${{ matrix.php }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-phpunit-tests-v3.yml@trunk
+    uses: ./.github/workflows/reusable-phpunit-tests-v3.yml
     permissions:
       contents: read
@@ -158 +158 @@
   test-innovation-releases:
     name: PHP ${{ matrix.php }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-phpunit-tests-v3.yml@trunk
+    uses: ./.github/workflows/reusable-phpunit-tests-v3.yml
     permissions:
       contents: read
@@ -201 +201 @@
   specific-test-groups:
     name: ${{ matrix.phpunit-test-groups }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-phpunit-tests-v3.yml@trunk
+    uses: ./.github/workflows/reusable-phpunit-tests-v3.yml
     permissions:
       contents: read
@@ -221 +221 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/.github/workflows/test-and-zip-default-themes.yml

@@ -199 +199 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

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

@@ -32 +32 @@
   test-core-build-process:
     name: Core running from ${{ matrix.directory }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-test-core-build-process.yml@trunk
+    uses: ./.github/workflows/reusable-test-core-build-process.yml
     permissions:
       contents: read
@@ -64 +64 @@
   test-core-build-process-macos:
     name: Core running from ${{ matrix.directory }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-test-core-build-process.yml@trunk
+    uses: ./.github/workflows/reusable-test-core-build-process.yml
     permissions:
       contents: read
@@ -80 +80 @@
   test-gutenberg-build-process:
     name: Gutenberg running from ${{ matrix.directory }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-test-gutenberg-build-process.yml@trunk
+    uses: ./.github/workflows/reusable-test-gutenberg-build-process.yml
     permissions:
       contents: read
@@ -103 +103 @@
   test-gutenberg-build-process-macos:
     name: Gutenberg running from ${{ matrix.directory }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-test-gutenberg-build-process.yml@trunk
+    uses: ./.github/workflows/reusable-test-gutenberg-build-process.yml
     permissions:
       contents: read
@@ -118 +118 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/.github/workflows/test-coverage.yml

@@ -50 +50 @@
   test-coverage-report:
     name: ${{ matrix.multisite && 'Multisite' || 'Single site' }} report
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-phpunit-tests-v3.yml@trunk
+    uses: ./.github/workflows/reusable-phpunit-tests-v3.yml
     permissions:
       contents: read
@@ -68 +68 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/.github/workflows/test-old-branches.yml

@@ -133 +133 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/.github/workflows/upgrade-testing.yml

@@ -58 +58 @@
   upgrade-tests-last-two-releases:
     name: ${{ matrix.wp }} to ${{ inputs.new-version && inputs.new-version || 'latest' }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-upgrade-testing.yml@trunk
+    uses: ./.github/workflows/reusable-upgrade-testing.yml
     if: ${{ github.repository == 'WordPress/wordpress-develop' || github.event_name == 'pull_request' }}
     permissions:
@@ -95 +95 @@
   upgrade-tests-wp-6x-mysql:
     name: ${{ matrix.wp }} to ${{ inputs.new-version && inputs.new-version || 'latest' }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-upgrade-testing.yml@trunk
+    uses: ./.github/workflows/reusable-upgrade-testing.yml
     if: ${{ github.repository == 'WordPress/wordpress-develop' || github.event_name == 'pull_request' }}
     permissions:
@@ -127 +127 @@
   upgrade-tests-wp-5x-php-7x-mysql:
     name: ${{ matrix.wp }} to ${{ inputs.new-version && inputs.new-version || 'latest' }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-upgrade-testing.yml@trunk
+    uses: ./.github/workflows/reusable-upgrade-testing.yml
     if: ${{ github.repository == 'WordPress/wordpress-develop' || github.event_name == 'pull_request' }}
     strategy:
@@ -161 +161 @@
   upgrade-tests-wp-5x-php-8x-mysql:
     name: ${{ matrix.wp }} to ${{ inputs.new-version && inputs.new-version || 'latest' }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-upgrade-testing.yml@trunk
+    uses: ./.github/workflows/reusable-upgrade-testing.yml
     if: ${{ github.repository == 'WordPress/wordpress-develop' || github.event_name == 'pull_request' }}
     strategy:
@@ -186 +186 @@
   upgrade-tests-wp-4x-php-7x-mysql:
     name: ${{ matrix.wp }} to ${{ inputs.new-version && inputs.new-version || 'latest' }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-upgrade-testing.yml@trunk
+    uses: ./.github/workflows/reusable-upgrade-testing.yml
     if: ${{ github.repository == 'WordPress/wordpress-develop' || github.event_name == 'pull_request' }}
     strategy:
@@ -222 +222 @@
   upgrade-tests-wp-4x-php-8x-mysql:
     name: ${{ matrix.wp }} to ${{ inputs.new-version && inputs.new-version || 'latest' }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-upgrade-testing.yml@trunk
+    uses: ./.github/workflows/reusable-upgrade-testing.yml
     if: ${{ github.repository == 'WordPress/wordpress-develop' || github.event_name == 'pull_request' }}
     strategy:
@@ -246 +246 @@
   upgrade-tests-oldest-wp-mysql:
     name: ${{ matrix.wp }} to ${{ inputs.new-version && inputs.new-version || 'latest' }}
-    uses: WordPress/wordpress-develop/.github/workflows/reusable-upgrade-testing.yml@trunk
+    uses: ./.github/workflows/reusable-upgrade-testing.yml
     if: ${{ github.repository == 'WordPress/wordpress-develop' || github.event_name == 'pull_request' }}
     strategy:
@@ -280 +280 @@
   slack-notifications:
     name: Slack Notifications
-    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+    uses: ./.github/workflows/slack-notifications.yml
     permissions:
       actions: read

trunk/Gruntfile.js

@@ -457 +457 @@
                     }
                 }
+            },
+            'workflow-references-local-to-remote': {
+                options: {
+                    processContent: function( src ) {
+                        return src.replace( /uses: \.\/\.github\/workflows\/([^\.]+)\.yml/g, function( match, $1 ) {
+                            return 'uses: WordPress/wordpress-develop/.github/workflows/' + $1 + '.yml@trunk';
+                        } );
+                    }
+                },
+                src: '.github/workflows/*.yml',
+                dest: './'
+            },
+            'workflow-references-remote-to-local': {
+                options: {
+                    processContent: function( src ) {
+                        return src.replace( /uses: WordPress\/wordpress-develop\/\.github\/workflows\/([^\.]+)\.yml@trunk/g, function( match, $1 ) {
+                            return 'uses: ./.github/workflows/' + $1 + '.yml';
+                        } );
+                    }
+                },
+                src: '.github/workflows/*.yml',
+                dest: './'
             }
         },
@@ -1514 +1536 @@
     ] );
 
+    grunt.registerTask( 'replace:workflow-references-local-to-remote', [
+        'copy:workflow-references-local-to-remote',
+    ]);
+
+    grunt.registerTask( 'replace:workflow-references-remote-to-local', [
+        'copy:workflow-references-remote-to-local',
+    ]);
+
     /**
      * Build verification tasks.