misc(release): add script for updating critical dependencies (#16359)

connorjclark · web-flow · commit c17ed57292ac · 2025-02-26T10:33:30.000-08:00
diff --git a/core/scripts/upgrade-deps.sh b/core/scripts/upgrade-deps.sh
@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+##
+# @license Copyright 2025 Google LLC
+# SPDX-License-Identifier: Apache-2.0
+##
+
+DIRNAME="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+LH_ROOT="$DIRNAME/../.."
+cd $LH_ROOT
+
+set -ex
+
+yarn upgrade --latest \
+    axe-core \
+    chrome-devtools-frontend \
+    chrome-launcher \
+    csp_evaluator \
+    devtools-protocol \
+    js-library-detector \
+    lighthouse-logger \
+    lighthouse-stack-packs \
+    puppeteer \
+    puppeteer-core \
+    speedline-core \
+    third-party-web \
+
+node -e "
+    const pkg = require('$LH_ROOT/package.json');
+    const ver = pkg.dependencies['devtools-protocol'].replace('^', '');
+    pkg.resolutions['puppeteer/**/devtools-protocol'] = ver;
+    pkg.resolutions['puppeteer-core/**/devtools-protocol'] = ver;
+    require('fs').writeFileSync('$LH_ROOT/package.json', JSON.stringify(pkg, null, 2) + '\n');
+"
+
+# Do some stuff that may update checked-in files.
+yarn build-all
+yarn update:sample-json
+yarn type-check
+yarn lint --fix
+
+# Just print something nice to copy/paste as a PR description.
+
+set +x
+
+echo '```diff'
+git diff -U0 package.json | grep -E '^[-] ' | sort
+echo
+git diff -U0 package.json | grep -E '^[+] ' | sort
+echo '```'
diff --git a/docs/releasing.md b/docs/releasing.md
@@ -36,7 +36,11 @@ We follow [semver](https://semver.org/) versioning semantics (`vMajor.Minor.Patc
 
 ### Update various dependencies
 
-In general, Lighthouse should be using the latest version of all of these dependencies:
+In general, Lighthouse should be using the latest version of its critical dependencies. These are listed in the following script. It's ok to not be on the very latest, use your judgement.
+
+```sh
+bash core/scripts/upgrade-deps.sh
+```
 
 1. https://github.com/GoogleChrome/lighthouse-stack-packs
 1. `puppeteer` and `puppeteer-core`
diff --git a/package.json b/package.json
@@ -16,9 +16,10 @@
     "prepack": "yarn build-report --standalone --flow --esm && yarn build-types",
     "postpack": "yarn clean-types",
     "build-all": "npm-run-posix-or-windows build-all:task",
-    "build-all:task": "yarn build-report && yarn build-cdt-lib && yarn build-devtools && concurrently 'yarn build-extension' 'yarn build-lr' 'yarn build-viewer' 'yarn build-treemap' 'yarn build-smokehouse-bundle' && yarn build-pack",
-    "build-all:task:windows": "yarn build-report && yarn build-cdt-lib && yarn build-extension && yarn build-devtools && yarn build-lr && yarn build-viewer && yarn build-treemap && yarn build-smokehouse-bundle",
+    "build-all:task": "yarn build-report && yarn build-cdt-strings && yarn build-devtools && concurrently 'yarn build-extension' 'yarn build-lr' 'yarn build-viewer' 'yarn build-treemap' 'yarn build-smokehouse-bundle' && yarn build-pack",
+    "build-all:task:windows": "yarn build-report && yarn build-cdt-strings && yarn build-extension && yarn build-devtools && yarn build-lr && yarn build-viewer && yarn build-treemap && yarn build-smokehouse-bundle",
     "build-cdt-lib": "node ./build/build-cdt-lib.js",
+    "build-cdt-strings": "node ./build/build-cdt-strings.js",
     "build-extension": "yarn build-extension-chrome && yarn build-extension-firefox",
     "build-extension-chrome": "node ./build/build-extension.js chrome",
     "build-extension-firefox": "node ./build/build-extension.js firefox",
