Merge pull request #737 from Shopify/convert_to_gem_feature

Convert to installer-based CLI

Author: paulomarg

.github/CONTRIBUTING.md

@@ -42,4 +42,10 @@ We’ll review your pull request and either merge it, request changes to it, or
 
 ### Contributor License Agreement (CLA)
 
-Each contributor is required to [sign a CLA](https://cla.shopify.com/). This process is automated as part of your first pull request and is only required once. If any contributor has not signed or does not have an associated GitHub account, the CLA check will fail and the pull request is unable to be merged.
+Each contributor is required to [sign a CLA](https://cla.shopify.com/). This process is automated as part of your first pull request and is only required once. If any contributor has not signed or does not have an associated GitHub account, the CLA check will fail and the pull request is unable to be merged.
+
+## Releasing a new version
+
+If you are changing the CLI version, please make sure to update all the places that use it:
+* ShopifyCLI::VERSION
+* Debian package version under `packaging/debian`

.gitignore

@@ -1,9 +1,7 @@
 .rubocop-*
 .tmp/*
-ngrok*
 .bundle/*
 .DS_Store
-heroku
 *.gz
 .vagrant/
 *.log
@@ -13,3 +11,9 @@ tmp/
 markdown_intermediate
 .idea
 vendor/bundle
+*.gem
+packaging/builds
+packaging/debian/shopify-cli
+packaging/debian/shopify-cli.deb
+packaging/rpm/build
+packaging/rpm/shopify-cli.spec

.rubocop.yml

@@ -5,6 +5,7 @@ AllCops:
   Exclude:
     - 'vendor/**/*'
     - 'docs/**/*'
+    - 'packaging/**/*'
   TargetRubyVersion: 2.4
 
 Layout/EmptyLines:
@@ -24,6 +25,11 @@ Layout/HeredocIndentation:
 Style/EmptyLiteral:
   Enabled: false
 
+# allow String.new to create mutable strings
+Style/HashSyntax:
+  Exclude:
+    - 'Rakefile'
+
 # allow using %r{} for regexes
 Style/RegexpLiteral:
   Enabled: false

CHANGELOG.md

@@ -0,0 +1,18 @@
+Version 0.9.3
+------
+* Rebased to master
+* Removed auto-generated files from builds directory
+
+Version 0.9.2
+------
+* Rebased to master, to pull in 7+ Pull Requests
+* Updates to dependencies to package files (updated Ruby version)
+
+Version 0.9.1
+------
+* Updated required Ruby version for the CLI
+* Minor fixes for the build / release process
+
+Version 0.9.0
+------
+* Initial test release of gem-based CLI

LICENSE.md LICENSELICENSE.md renamed to LICENSE

@@ -0,0 +1,51 @@
+## Releasing Shopify CLI
+
+1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
+
+2. Create a branch named `release_X_Y_Z` (replacing `X_Y_Z` with the intended release version)
+   ```
+   $ git checkout -b release_X_Y_Z
+   ```
+
+3. Update the version of Shopify CLI in `lib/shopify-cli/version.rb`
+
+4. Add an entry for the new release to `CHANGELOG.md`
+
+5. Commit the changes with a commit message like "Packaging for release X.Y.Z"
+   ```
+   $ git commit -am "Packaging for release vX.Y.Z"
+   ```
+
+6. Push out the changes
+   ```
+   $ git push -u origin release_X_Y_Z
+   ```
+
+7. 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
+
+8. Deploy using Shipit
+
+9. On local machine and _AFTER_ gem has been published to https://rubygems.org, run
+   ```
+   $ rake package
+   ```
+   This will generate the `.deb`, `.rpm` and brew formula files, which will be located in `packaging/builds/X.Y.Z/`.
+
+10. Clone the `Shopify/homebrew-shopify` repository (if not already cloned), and then
+    * create a branch named `release_X_Y_Z_of_shopify-cli`
+    * update the brew formula in `shopify-cli.rb` with the generated formula in `packaging/builds/X.Y.Z/` in the `Shopify/shopify-app-cli` repo (from step 9)
+    * commit the change and create a PR on the [Shopify Homebrew repository](https://github.com/Shopify/homebrew-shopify)
+    * when PR is approved, merge into main branch
+
+11. Go to [releases](https://github.com/Shopify/shopify-app-cli/releases) page of `Shopify/shopify-app-cli` repo and create a new release:
+    * use the tag created in step 8 by Shipit (should be "vX.Y.Z")
+    * release title = "Version X.Y.Z"
+    * description should be 
+      ```
+      Release of version X.Y.Z of Shopify App CLI
+    
+      Please refer to [CHANGELOG](https://github.com/Shopify/shopify-app-cli/blob/master/CHANGELOG.md) for details.
+      ```
+    * upload the `.deb` and `.rpm` files from `packaging/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".

RELEASING.md

@@ -1,6 +1,7 @@
-require_relative 'bin/support/load_shopify'
+require_relative 'bin/load_shopify'
 require 'rake/testtask'
 require 'rubocop/rake_task'
+require 'bundler/gem_tasks'
 
 Rake::TestTask.new do |t|
   t.libs += %w(test)
@@ -15,7 +16,7 @@ task(default: [:test, :rubocop])
 
 desc("Start up irb with cli loaded")
 task :console do
-  exec('irb', '-r', './bin/support/load_shopify.rb', '-r', 'byebug')
+  exec('irb', '-r', './bin/load_shopify.rb', '-r', 'byebug')
 end
 
 namespace :rdoc do
@@ -69,3 +70,27 @@ end
 
 desc("Generate markdown documentation and update the wiki")
 task(rdoc: 'rdoc:all')
+
+namespace :package do
+  require 'shopify-cli/packager'
+
+  task all: [:debian, :rpm, :homebrew]
+
+  desc("Builds a Debian package of the CLI")
+  task :debian do
+    ShopifyCli::Packager.new.build_debian
+  end
+
+  desc("Builds an RPM package of the CLI")
+  task :rpm do
+    ShopifyCli::Packager.new.build_rpm
+  end
+
+  desc("Builds a Homebrew package of the CLI")
+  task :homebrew do
+    ShopifyCli::Packager.new.build_homebrew
+  end
+end
+
+desc("Builds all distribution packages of the CLI")
+task(package: 'package:all')

Rakefile

@@ -1,6 +1,6 @@
-#!/usr/bin/ruby --disable-gems
+#!/usr/bin/env ruby --disable=gems
 
-lib_path = File.expand_path("../../../lib", __FILE__)
+lib_path = File.expand_path("../../lib", __FILE__)
 $LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 
 ENV['SHELLPID'] ||= Process.ppid.to_s

bin/support/load_shopify.rb bin/load_shopify.rbbin/support/load_shopify.rb renamed to bin/load_shopify.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby --disable-gems
+#!/usr/bin/env ruby --disable=gems
 
 module Kernel
   # make an alias of the original require
@@ -10,28 +10,22 @@ module Kernel
   rescue LoadError => e
     # Special case for psych (yaml), which rescues this itself
     raise if name == "#{RUBY_VERSION[/\d+\.\d+/]}/psych.so"
-    STDERR.puts "[Note] You cannot use gems in shopify-cli."
+    STDERR.puts "[Note] You cannot use gems with Shopify App CLI."
     STDERR.puts "[LoadError] #{e.message}"
     if ENV['DEBUG']
       STDERR.puts e.backtrace
       STDERR.puts "\n"
     end
     STDERR.puts "       They are disabled."
-    STDERR.puts "       If you are modifying /opt/shopify-cli, please don't."
-    STDERR.puts "       TODO with contribution instructions"
+    STDERR.puts "       Please don't modify the CLI locally."
+    STDERR.puts "       If you would like to contribute to the CLI project, please refer to"
+    STDERR.puts "       https://github.com/Shopify/shopify-app-cli/blob/master/.github/CONTRIBUTING.md"
     STDERR.puts "\n"
     raise
   end
 end
 
-require_relative 'support/load_shopify'
-
-# before we've loaded any gems, unset the GEM_HOME etc.
-# this is important because we're specifically using /usr/bin/ruby.
-# Though we don't use gems here, it's not uncommon for other rubies
-# to install alternative json or yaml libraries that take precedence,
-# but don't have binary compatibility with this ruby version.
-# Dev::Helpers::ChrubyReset.call(ENV)
+require_relative './load_shopify'
 
 exit(ShopifyCli::ErrorHandler.call do
   ShopifyCli::Core::EntryPoint.call(ARGV.dup)