RELEASING.md

Releasing Shopify CLI

1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org

2. Make sure you're on the most recent master

   $ git checkout master
   $ git pull
   

3. Create a branch named release_X_Y_Z (replacing X_Y_Z with the intended release version)

   $ git checkout -b release_X_Y_Z
   

4. Update the version of Shopify CLI in lib/shopify-cli/version.rb

5. Add an entry for the new release to CHANGELOG.md

6. Commit the changes with a commit message like "Packaging for release X.Y.Z"

   $ git commit -am "Packaging for release vX.Y.Z"
   

7. Push out the changes

   $ git push -u origin release_X_Y_Z
   

8. 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

9. Deploy using Shipit

10. Check the "Actions" tab to see if the Create Release workflow is successful. The workflow will automatically create a release with the latest tag and .deb, .rpm assets attached.

11. Check the Shopify/homebrew-shopify repository for new PR shopify-cli {version}

    • rename PR to Packaging for release of v{version} of shopify-cli
    • when PR is approved, merge into main branch