This page contains instructions for CLI 2.0. If you are looking for instructions for CLI 3.0, please visit the CLI 3.0 documentation.
We release the CLI with a series of Rake tasks run locally, interspersed with PR-based checkpoints. The steps are:
export GITHUB_ACCESS_TOKEN=$(dev github print-auth | grep Password | awk '{print $NF}')
rake "release:prepare[2.x.x]"
(where 2.x.x is the version being released)- PR to shopify-cli will open in your browser. Sanity-check and merge.
- Trigger Shipit on your version commit to release on RubyGems
rake release:package
- Homebrew PR will open in your browser. Sanity-check and merge.
- Release will also be opened in your browser, check that it includes debian and rpm files.
- Go through all the PRs labeled with includes-post-release-steps and follow the post-release steps described in those PRs. Delete the labels afterward.
In case the automation goes wrong, try with the manual instructions.
-
Check the Semantic Versioning page for info on how to version the new release: http://semver.org
-
Make sure you're on the most recent
main
$ git checkout main $ git pull
-
Create a branch named
release_X_Y_Z
(replacingX_Y_Z
with the intended release version)$ git checkout -b release_X_Y_Z
-
Update the version of Shopify CLI in
lib/shopify_cli/version.rb
-
Update the version of Shopify CLI at the top of
Gemfile.lock
(failing to do so causes the CI build to fail) -
Add an entry for the new release to
CHANGELOG.md
-
Commit the changes with a commit message like "Packaging for release X.Y.Z"
$ git commit -am "Packaging for release vX.Y.Z"
-
Push out the changes
$ git push -u origin release_X_Y_Z
-
Open a PR for the branch, get necessary approvals from code owners and merge into main branch. Note that the PR title will be the release note in Shipit, so make sure it mentions the release
-
Deploy to RubyGems using Shipit
-
Update your
main
branch to the latest version
$ git checkout main
$ git pull
- On local machine and AFTER gem has been published to https://rubygems.org/gems/shopify-cli, run
$ rake package
This will generate the .deb
, .rpm
and brew formula files, which will be located in packaging/builds/X.Y.Z/
.
-
Clone the
Shopify/homebrew-shopify
repository (if not already cloned), and then- update your
master
branch to the latest version:git checkout master && git pull
- create a new branch:
git checkout -b release_X_Y_Z_of_shopify-cli
- update the brew formula in
shopify-cli.rb
with the generated formula inpackaging/builds/X.Y.Z/
in theShopify/shopify-cli
repo (from therake package
step above) - commit the change and create a PR on the Shopify Homebrew repository
- when PR is approved, merge into main branch
- update your
-
Go to releases page of
Shopify/shopify-cli
repo and create a new release:- use the tag created by Shipit (should be "vX.Y.Z")
- release title = "Version X.Y.Z"
- description should be the content of the section in the
CHANGELOG.md
- upload the
.deb
and.rpm
files frompackaging/builds/X.Y.Z/
(generated in step 9) - if it's a pre-release version, select the "This is a pre-release" checkbox
- and click "Publish release".
-
Go through all the PR labeled with
includes-post-release-steps
and follow the post-release steps described in those PRs. Delete the labels afterward.