New upgrade CLI command

.changeset/honest-apricots-fail.md

@@ -0,0 +1,68 @@
+---
+'@shopify/cli-hydrogen': patch
+---
+
+# New `h2 upgrade` command
+
+We are introducing a new hydrogen cli `upgrade` command that:
+
+- Makes upgrading hydrogen as easy as typing `h2 upgrade` in your terminal
+- Provides a quick summary of the key `features` and `fixes` of any available
+  hydrogen version(s)
+- Generates a `TODO` instructions file detailing all cumulative code changes required
+  to adopt a given hydrogen version
+- Provides a gentle notice during development detailing when a hydrogen is outdated, as well as a quick glance into the number of hydrogen version available
+
+## Basic use
+
+```bash
+# from the base of the project run
+
+h2 upgrade
+```
+
+Alternatively, you can upgrade from another folder by using the `--path` flag
+
+```bash
+h2 upgrade --path /path-to-a-outdated-hydrogen-project
+```
+
+### `--version` flag
+
+The version flag let's you upgrade to a specific release version without any further
+prompts. If an invalid version is provided you will be prompted to choose a hydrogen
+version via a CLI prompt
+
+```bash
+h2 upgrade --version 2023.10.0
+```
+
+### Dev upgrade notice
+
+Simply run dev as normal
+
+```bash
+npm run dev
+
+# or
+h2 dev
+```
+
+### `---no-version-check` flag
+
+If you want to disable the development notice, simply run
+
+```bash
+h2 dev --no-version-check
+```
+
+### `--dry-run` flag
+
+If your are unsure about upgrading or just want to preview the TODO list of
+changes to a given hydrogen version you can run
+
+```bash
+h2 upgrade --dry-run
+
+# this will output a new .md file inside the .shopify/ folder for a given upgrade
+```

packages/cli/oclif.manifest.json

@@ -308,6 +308,13 @@
           "char": "e",
           "description": "Specify an environment's branch name when using remote environment variables.",
           "multiple": false
+        },
+        "disable-version-check": {
+          "name": "disable-version-check",
+          "type": "boolean",
+          "description": "Skip the version check when running `hydrogen dev`",
+          "required": false,
+          "allowNo": false
         }
       },
       "args": {}
@@ -625,6 +632,47 @@
       },
       "args": {}
     },
+    "hydrogen:upgrade": {
+      "id": "hydrogen:upgrade",
+      "description": "Upgrade Remix and Hydrogen npm dependencies.",
+      "strict": true,
+      "pluginName": "@shopify/cli-hydrogen",
+      "pluginAlias": "@shopify/cli-hydrogen",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "path": {
+          "name": "path",
+          "type": "option",
+          "description": "The path to the directory of the Hydrogen storefront. The default is the current directory.",
+          "multiple": false
+        },
+        "version": {
+          "name": "version",
+          "type": "option",
+          "char": "v",
+          "description": "A target hydrogen version to update to",
+          "required": false,
+          "multiple": false
+        },
+        "dry-run": {
+          "name": "dry-run",
+          "type": "boolean",
+          "char": "d",
+          "description": "Generate a summary and .md file with upgrade instructions without actually upgrading the dependencies",
+          "required": false,
+          "allowNo": false
+        },
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "char": "f",
+          "description": "Ignore warnings and force the upgrade to the target version",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
     "hydrogen:debug:cpu": {
       "id": "hydrogen:debug:cpu",
       "description": "Builds and profiles the server startup time the app.",

packages/cli/package.json

@@ -23,11 +23,11 @@
     "@types/recursive-readdir": "^2.2.1",
     "@types/stack-trace": "^0.0.30",
     "@types/tar-fs": "^2.0.1",
-    "devtools-protocol": "^0.0.1177611",
-    "get-port": "^7.0.0",
     "@vitest/coverage-v8": "^0.33.0",
+    "devtools-protocol": "^0.0.1177611",
     "fast-glob": "^3.2.12",
     "flame-chart-js": "2.3.1",
+    "get-port": "^7.0.0",
     "type-fest": "^3.6.0",
     "vitest": "^0.33.0"
   },
@@ -40,6 +40,7 @@
     "@shopify/mini-oxygen": "^2.2.3",
     "@shopify/oxygen-cli": "2.6.1",
     "ansi-escapes": "^6.2.0",
+    "cli-truncate": "^4.0.0",
     "diff": "^5.1.0",
     "fs-extra": "^11.1.0",
     "get-port": "^7.0.0",