Shopify / cli

Build apps, themes, and hydrogen storefronts for Shopify
https://shopify.dev
MIT License
430 stars 130 forks source link

[Feature]: Show me why and how to update #698

Closed vfonic closed 1 year ago

vfonic commented 2 years ago

What area(s) will this request affect?

Other

What type of change do you want to see?

New feature

Overview

I just switched from Shopify CLI 2.x for theme development to Shopify CLI 3.x. I have 3.20.1 version and, when I ran shopify version, I got the following output:

> shopify version
Current Shopify CLI version: 3.20.1
💡 Version 3.21.0 available!

What can I do with this information? What changed? The number went from 3.20.1 to 3.21.0? Anything else? How can I update?

Motivation

It's great to see the new version available. However, I don't know what I can do with this information, aside from spending 5-10+ minutes to figure out what I could/should do.

I suggest:

  1. Show some changelog, some "incentive" of why I should update
  2. Show instructions how I can update.

For 1. you could at least print out the URL to the CHANGELOG.md

For 2. you can print out the URL to "updating guide" (I assume you have one?). I understand that there are several ways to install the CLI so that's why it could be difficult to print the updating instructions, but you can at least show me where I can read more about updating, instead of me having to find where the updating documentation is - is it in the GitHub repo or is it somewhere on shopify.dev or...? Please improve the DX (developer experience) here.

Thank you! 🙏

vfonic commented 2 years ago

I discovered that there's shopify upgrade command:

> shopify upgrade
Upgrading CLI from 3.20.1 to 3.21.0...
Homebrew installation detected. Attempting to upgrade via brew upgrade...
Warning: shopify/shopify/shopify-cli 3.20.1 already installed
✅ Success! Upgraded Shopify CLI to version 3.21.0.
> shopify version
Current Shopify CLI version: 3.20.1
💡 Version 3.21.0 available!

https://xkcd.com/986/ https://xkcd.com/986/

shauns commented 1 year ago

@vfonic thanks for raising this. Looks like upgrade + homebrew installs have an issue.

On the changelog/instructions point -- that's something on the radar (We'd like to give you every reason to upgrade!). What you might also find is tools like dependabot will let you know about what's on the CLI's changelog when there's a new version available.

vfonic commented 1 year ago

@shauns re: homebrew installs have issue: https://github.com/Shopify/homebrew-shopify/issues/446

I try to freeze (pin) my Homebrew installed packages because I don't feel the need to be on the latest versions of everything. I prefer being on working version rather than latest version. Homebrew doesn't allow for choosing non-latest version so easily so I probably disabled updating Homebrew formulas hence why the upgrade still thinks I have the latest version.

I'm not sure how I can use dependabot locally. 🤔

shauns commented 1 year ago

I think for homebrew the best bet is to leave that to the developer to manage, though I suppose we could suggest to them to brew update && brew upgrade as the most likely command. Thanks for bringing this to our attention!

github-actions[bot] commented 1 year ago

This issue seems inactive. If it's still relevant, please add a comment saying so. Otherwise, take no action. → If there's no activity within a week, then a bot will automatically close this. Thanks for helping to improve Shopify's dev tooling and experience.