New upgrade CLI command

[juanpprieto]

Hydrogen upgrade command

Upgrading Hydrogen projects today is not as simple as running npm install @shopify/hydrogen because of the coupling between Hydrogen, Oxygen and Remix dependencies.

To determine an upgrade command for a specific Hydrogen version requires you need to know:

• A compatible @shopify/cli-hydrogen version
• A compatible @shopify/remix-oxygen version
• A compatible @remix-run/react and @remix-run/dev version (and other optional
  remix packages)

Currently, the best approach to figure out this command is by looking at the package.json
dependencies inside the skeleton template or by visiting the releases notes
for a given hydrogen version and then manually writing down all the other package
versions compatible with a given hydrogen release.

This is not only cumbersome, but also prone to errors.

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

Getting started

Basic use

# from the base of the project run

h2 upgrade

Alternatively, you can upgrade from another folder by using the --path flag

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

h2 upgrade --version 2023.10.0

Dev upgrade notice

Simply run dev as normal

npm run dev

# or
h2 dev

---no-version-check flag

If you want to disable the development notice, simply run

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

h2 upgrade --dry-run

# this will output a new .md file inside the .shopify/ folder for a given upgrade

Preview

Version selection prompt

Preview of Features and Fixes for a selected version

Upgrade success notice

Example instructions/TODO file

---

🎩 tophat:

1. Checkout this branch

git checkout juanpprieto/upgrade-command

2. Watch cli by running dev at /src/packages/cli

npm run dev

2. On a separate terminal run:

h2 [dev|upgrade] [--dry-run|--disable-version-check|--version] --path /to-an-outdated-hydrogen-project