Changeset 53311

Timestamp:

04/29/2022 01:59:49 PM (3 years ago)

Author:

gziolo

Message:

Tools: Further automate backporting from Gutenberg to Core

Follow-up for #51491.

Updating WordPress packages is currently a manual process that takes some reading and trial & error to figure out. This PR adds a single npm task called sync-gutenberg-packages that automates this entire process.

Props zieladam.
Fixes #55642.

Location:

trunk

Files:

• Gruntfile.js (modified) (4 diffs)
• package.json (modified) (1 diff)
• tools/release (added)
• tools/release/sync-gutenberg-packages.js (added)

trunk/Gruntfile.js

@@ -14 +14 @@
         BUILD_DIR = 'build/',
         WORKING_DIR = grunt.option( 'dev' ) ? SOURCE_DIR : BUILD_DIR,
-        BANNER_TEXT = '/*! This file is auto-generated */',
+        BANNER_TEXT = '/*! This file is auto-generated */',
         autoprefixer = require( 'autoprefixer' ),
         sass = require( 'sass' ),
@@ -81 +81 @@
             }
         },
-        usebanner: {
+        usebanner: {
             options: {
                 position: 'top',
@@ -1217 +1217 @@
     ] );
 
+    grunt.registerTask( 'sync-gutenberg-packages', function() {
+        if ( grunt.option( 'update-browserlist' ) ) {
+            // Updating the browserlist database is opt-in and up to the release lead.
+            //
+            // Browserlist database should be updated:
+            // * In each release cycle up until RC1
+            // * If Webpack throws a warning about an outdated database
+            //
+            // It should not be updated:
+            // * After the RC1
+            // * When backporting fixes to older WordPress releases.
+            //
+            // For more context, see:
+            // https://github.com/WordPress/wordpress-develop/pull/2621#discussion_r859840515
+            // https://core.trac.wordpress.org/ticket/55559
+            grunt.task.run( 'browserslist:update' );
+        }
+
+        // Install the latest version of the packages already listed in package.json.
+        grunt.task.run( 'wp-packages:update' );
+
+        // Install any new @wordpress packages that are now required.
+        // Update any non-@wordpress deps to the same version as required in the @wordpress packages (e.g. react 16 -> 17).
+        grunt.task.run( 'wp-packages:refresh-deps' );
+
+        // Build the files stored in the src/ directory.
+        grunt.task.run( 'build:dev' );
+    } );
+
     grunt.renameTask( 'watch', '_watch' );
 
@@ -1638 +1667 @@
     } );
 
+    grunt.registerTask( 'wp-packages:update', 'Update WordPress packages', function() {
+        const distTag = grunt.option('dist-tag') || 'latest';
+        grunt.log.writeln( `Updating WordPress packages (--dist-tag=${distTag})` );
+        spawn( 'npx', [ 'wp-scripts', 'packages-update', '--', `--dist-tag=${distTag}` ], {
+            cwd: __dirname,
+            stdio: 'inherit',
+        } );
+    } );
+
+    grunt.registerTask( 'browserslist:update', 'Update the local database of browser supports', function() {
+        grunt.log.writeln( `Updating browsers list` );
+        spawn( 'npx', [ 'browserslist@latest', '--update-db' ], {
+            cwd: __dirname,
+            stdio: 'inherit',
+        } );
+    } );
+
+    grunt.registerTask( 'wp-packages:refresh-deps', 'Update version of dependencies in package.json to match the ones listed in the latest WordPress packages', function() {
+        const distTag = grunt.option('dist-tag') || 'latest';
+        grunt.log.writeln( `Updating versions of dependencies listed in package.json (--dist-tag=${distTag})` );
+        spawn( 'node', [ 'tools/release/sync-gutenberg-packages.js', `--dist-tag=${distTag}` ], {
+            cwd: __dirname,
+            stdio: 'inherit',
+        } );
+    } );
+
     // Patch task.
     grunt.renameTask('patch_wordpress', 'patch');

trunk/package.json

@@ -175 +175 @@
         "test:e2e": "node ./tests/e2e/run-tests.js",
         "test:visual": "node ./tests/visual-regression/run-tests.js",
-        "wp-packages-update": "wp-scripts packages-update"
+        "sync-gutenberg-packages": "grunt sync-gutenberg-packages"
     }
 }