Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 2.82 KB

RELEASING.md

File metadata and controls

95 lines (65 loc) · 2.82 KB
Raw

Releasing Theme Check

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

  2. Run the following command to update the version in lib/theme_check/version.rb and replace the THEME_CHECK_VERSION placeholder in the documentation for new rules:

    VERSION="X.X.X"
rake prerelease[$VERSION]

  3. Run git changelog to update CHANGELOG.md.

  4. Commit your changes and make a PR.

    git checkout -b "bump/theme-check-$VERSION"
git add docs/checks CHANGELOG.md lib/theme_check/version.rb
git commit -m "Bump theme-check version to $VERSION"
hub compare "main:bump/theme-check-$VERSION"

  5. Merge your PR to main.

  6. On Shipit, deploy your commit.

  7. Create a GitHub release for the change.

    VERSION=v1.X.Y
git fetch origin
git fetch origin --tags
git reset origin $VERSION
gh release create -t $VERSION

    (It's a good idea to copy parts of the CHANGELOG in there)

Homebrew Release Process

  1. Release theme-check on RubyGems by following the steps in the previous section.

  2. Generate the homebrew formula.

    rake package

  3. Copy the formula over in the homebrew-shopify repository.

    VERSION=X.X.X
cp packaging/builds/$VERSION/theme-check.rb ../homebrew-shopify

  4. Create a branch + a commit on the homebrew-shopify repository.

    git checkout -b "bump/theme-check-$VERSION"
git add theme-check.rb
git commit -m "Bump theme-check version to $VERSION"

  5. Create a pull-request for those changes on the homebrew-shopify repository.

    # shortcut if you have `hub` installed
hub compare "main:bump/theme-check-$VERSION"

Shopify CLI Release Process

  1. Release theme-check on RubyGems by following the steps in the previous section.

  2. Update the theme-check version in shopify-cli's shopify-cli.gemspec file.

  3. Run bundle update theme-check and get an updated Gemfile.lock

  4. Create a branch + a commit on the shopify-cli repository.

    VERSION=X.X.X
git checkout -b "bump/theme-check-$VERSION"
git add Gemfile.lock
git add shopify-cli.gemspec
git commit -m "Bump theme-check version to $VERSION"

  5. Create a pull-request for those changes on the shopify-cli repository.

    # shortcut if you have `hub` installed
hub compare "main:bump/theme-check-$VERSION"