shopify-cli 1.3.1 → 1.7.0

data/RELEASING.md

@@ -2,50 +2,40 @@
 
 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)
+1. Make sure you're on the most recent `master`
+   ```
+   $ git checkout master
+   $ git pull
+   ```
+
+1. 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`
+1. Update the version of Shopify CLI in `lib/shopify-cli/version.rb`
 
-4. Add an entry for the new release to `CHANGELOG.md`
+1. 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"
+1. 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
+1. 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
+1. 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
+1. 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/`.
+1. Check the "Actions" tab to see if the _Create Release_ workflow is successful. 
+   The workflow will automatically create a [release](https://github.com/Shopify/shopify-app-cli/releases) with the latest tag and `.deb`, `.rpm` assets attached.
+
+2. 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
 
-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".

data/Rakefile

@@ -1,11 +1,11 @@
-require_relative 'bin/load_shopify'
-require 'rake/testtask'
-require 'rubocop/rake_task'
-require 'bundler/gem_tasks'
+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)
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = false
   t.warning = false
 end
@@ -16,33 +16,37 @@ task(default: [:test, :rubocop])
 
 desc("Start up irb with cli loaded")
 task :console do
-  exec('irb', '-r', './bin/load_shopify.rb', '-r', 'byebug')
+  exec("irb", "-r", "./bin/load_shopify.rb", "-r", "byebug")
 end
 
 namespace :rdoc do
-  repo = 'https://github.com/Shopify/shopify-app-cli.wiki.git'
-  intermediate = 'markdown_intermediate'
+  repo = "https://github.com/Shopify/shopify-app-cli.wiki.git"
+  intermediate = "markdown_intermediate"
   file_to_doc = [
-    'lib/shopify-cli/admin_api.rb',
-    'lib/shopify-cli/context.rb',
-    'lib/shopify-cli/db.rb',
-    'lib/shopify-cli/git.rb',
-    'lib/shopify-cli/heroku.rb',
-    'lib/shopify-cli/js_deps.rb',
-    'lib/shopify-cli/partners_api.rb',
-    'lib/shopify-cli/process_supervision.rb',
-    'lib/shopify-cli/project.rb',
-    'lib/shopify-cli/tunnel.rb',
+    "lib/shopify-cli/admin_api.rb",
+    "lib/shopify-cli/context.rb",
+    "lib/shopify-cli/db.rb",
+    "lib/shopify-cli/git.rb",
+    "lib/shopify-cli/heroku.rb",
+    "lib/shopify-cli/js_deps.rb",
+    "lib/shopify-cli/method_object.rb",
+    "lib/shopify-cli/partners_api.rb",
+    "lib/shopify-cli/process_supervision.rb",
+    "lib/shopify-cli/project.rb",
+    "lib/shopify-cli/result.rb",
+    "lib/shopify-cli/transform_data_structure.rb",
+    "lib/shopify-cli/tunnel.rb",
+    "lib/shopify-cli/lazy_delegator.rb",
   ]
 
   task all: [:markdown, :wiki, :cleanup]
 
   desc("Generate markdown files from rdoc comments")
   task :markdown do
-    require 'rdoc/rdoc'
-    require 'docgen/markdown'
+    require "rdoc/rdoc"
+    require "docgen/markdown"
     options = RDoc::Options.new
-    options.setup_generator('markdown')
+    options.setup_generator("markdown")
     options.op_dir = intermediate
     options.files = file_to_doc
     RDoc::RDoc.new.document(options)
@@ -50,14 +54,14 @@ namespace :rdoc do
 
   desc("Copy markdown documentation to the wiki and commit them")
   task :wiki do
-    require 'tmpdir'
+    require "tmpdir"
     Dir.mktmpdir do |temp_dir|
       system("git clone --depth=1 #{repo} #{temp_dir}")
-      FileUtils.cp(Dir[File.join(intermediate, '*.md')], temp_dir)
+      FileUtils.cp(Dir[File.join(intermediate, "*.md")], temp_dir)
       Dir.chdir(temp_dir) do
-        system('git add --all')
+        system("git add --all")
         system('git commit -am "auto doc update"')
-        system('git push')
+        system("git push")
       end
     end
   end
@@ -69,10 +73,10 @@ namespace :rdoc do
 end
 
 desc("Generate markdown documentation and update the wiki")
-task(rdoc: 'rdoc:all')
+task(rdoc: "rdoc:all")
 
 namespace :package do
-  require 'shopify-cli/packager'
+  require "shopify-cli/packager"
 
   task all: [:debian, :rpm, :homebrew]
 
@@ -93,4 +97,4 @@ namespace :package do
 end
 
 desc("Builds all distribution packages of the CLI")
-task(package: 'package:all')
+task(package: "package:all")

data/bin/load_shopify.rb

@@ -3,20 +3,20 @@
 lib_path = File.expand_path("../../lib", __FILE__)
 $LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 
-ENV['SHELLPID'] ||= Process.ppid.to_s
-ENV['USER_PWD'] ||= Dir.pwd
+ENV["SHELLPID"] ||= Process.ppid.to_s
+ENV["USER_PWD"] ||= Dir.pwd
 
 # Prune non-absolute paths from PATH to prevent non-deterministic behavior
 # i.e. If user has "." or "./bin" in their PATH
 # Note that this logic is duplicated in lib/shopify.rb
-ENV['PATH'] = ENV['PATH'].split(File::PATH_SEPARATOR).select do |p|
-  p.start_with?('/', '~', /[A-Z]:\\/)
+ENV["PATH"] = ENV["PATH"].split(File::PATH_SEPARATOR).select do |p|
+  p.start_with?("/", "~", /[A-Z]:\\/)
 end.join(File::PATH_SEPARATOR)
 
 $original_env = ENV.to_hash
 
-require 'shopify_cli'
+require "shopify_cli"
 
-if ENV['PRINT_LOADED_FEATURES']
+if ENV["PRINT_LOADED_FEATURES"]
   puts $LOADED_FEATURES
 end

data/bin/shopify

@@ -14,7 +14,7 @@ module Kernel
     raise if name == "#{RUBY_VERSION[/\d+\.\d+/]}/psych.so"
     STDERR.puts "[Note] You cannot use gems with Shopify App CLI."
     STDERR.puts "[LoadError] #{e.message}"
-    if ENV['DEBUG']
+    if ENV["DEBUG"]
       STDERR.puts e.backtrace
       STDERR.puts "\n"
     end
@@ -27,7 +27,7 @@ module Kernel
   end
 end
 
-require_relative './load_shopify'
+require_relative "./load_shopify"
 
 exit(ShopifyCli::ErrorHandler.call do
   ShopifyCli::Core::EntryPoint.call(ARGV.dup)

data/dev.yml

@@ -11,7 +11,7 @@ test:
   run: |
     if [ "$#" -eq 1 ] && [[ -f $1 ]];
     then
-      rake test TEST=$1
+      bundle exec rake test TEST=$1
     else
-      rake test $@
+      bundle exec rake test $@
     fi

data/docs/_config.yml

@@ -1,19 +1,2 @@
-title: Shopify App CLI
-markdown: kramdown
-url: https://shopify.github.io
-baseurl: /shopify-app-cli
-
-exclude: [
-  'heroku/',
-  'Gemfile',
-  'Gemfile.lock'
-]
-
-defaults:
-  - scope:
-      path: ""
-    values:
-      toc: true
-
 plugins:
-  - jekyll-redirect-from
+  - jekyll-redirect-from

data/docs/app/node/commands/index.md

@@ -1,82 +1,4 @@
 ---
-title: Node.js app project command reference
-section: node
+title: Node.js app commands
+redirect_to: https://shopify.dev/tools/cli/reference/node-app
 ---
-
-## `deploy`
-
-Deploy the current Node.js app to a hosting service. Currently, the only option is [Heroku](https://www.heroku.com).
-
-```console
-$ shopify deploy heroku
-```
-
-## `generate`
-
-Generate boilerplate code inside your app project. Node.js apps support generating new **pages**, **Billing API calls**, and **webhooks**.
-
-```console
-$ shopify generate page
-$ shopify generate billing
-$ shopify generate webhook
-```
-
-## `open`
-
-Open your local development app in your default browser.
-
-```console
-$ shopify open
-```
-
-## `populate`
-
-Add example data to your development store. This is useful for testing your app’s behavior. You can create the following types of example store records:
-
-- Products
-- Customers
-- Orders
-
-```console
-$ shopify populate products
-$ shopify populate customers
-$ shopify populate draftorders
-```
-
-By default, the `populate` command adds 5 records. Use the `--count` option to specify a different number:
-
-```console
-$ shopify populate products --count 10
-```
-
-## `serve`
-
-Start a local development server for your project, as well as a public [ngrok](https://ngrok.com/) tunnel to your localhost.
-
-```console
-$ shopify serve
-```
-
-## `tunnel`
-
-Control an HTTP tunnel to your local development app using [ngrok](https://ngrok.com). With the `tunnel` command you can authenticate with ngrok and start or stop the tunnel. (Note that the `serve` command will automatically run `tunnel start` for you.)
-
-To authenticate with ngrok, you need an authentication token. You can find it in [your ngrok dashboard](https://dashboard.ngrok.com/auth/your-authtoken). Copy your token and use it with the `tunnel auth` command:
-
-```console
-$ shopify tunnel auth <token>
-```
-
-This will write your ngrok auth token to `~/.ngrok2/ngrok.yml`. To learn more about ngrok configuration, [consult ngrok’s documentation](https://ngrok.com/docs#config).
-
-To start an ngrok tunnel to your app in your localhost development environment:
-
-```console
-$ shopify tunnel start
-```
-
-To stop the running ngrok tunnel:
-
-```console
-$ shopify tunnel stop
-```

data/docs/app/node/index.md

@@ -1,35 +1,4 @@
 ---
-title: Getting started with Node.js app projects
-section: node
-toc: false
+title: Getting started with Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/getting-started
 ---
-
-## Create a new Node.js app project
-
-To create a new Node.js project, type `shopify create node`. This will scaffold a new Node.js app in a subdirectory.
-
-```console
-$ shopify create node
-? App Name
->
-```
-
-## Start a local development server
-
-Once your app is created, you can work with it immediately by running `shopify serve` to start a local development server. Shopify App CLI uses [ngrok](https://ngrok.com) to create a tunnel. ngrok will choose a unique URL for you. The server will stay open until you type **Ctrl-C**.
-
-```console
-$ shopify serve
-✓ ngrok tunnel running at https://example.ngrok.io
-✓ writing .env file...
-```
-
-## Install your app on your development store
-
-With the server running, open a new terminal window and run `shopify open` to open your app in your browser and install it on a development store.
-
-```console
-$ shopify open
-```
-
-For more information, consult the [Node.js project command reference]({{ site.baseurl }}{% link app/node/commands/index.md %}).

data/docs/app/rails/commands/index.md

@@ -1,80 +1,4 @@
 ---
-title: Rails app project command reference
-section: rails
+title: Ruby on Rails app commands
+redirect_to: https://shopify.dev/tools/cli/reference/ruby-on-rails-app
 ---
-
-## `deploy`
-
-Deploy the current Rails project to a hosting service. Currently, the only option is [Heroku](https://www.heroku.com).
-
-```console
-$ shopify deploy heroku
-```
-
-## `generate`
-
-Generate boilerplate code inside your app project. Rails projects support generating new webhooks.
-
-```console
-$ shopify generate webhook
-```
-
-## `open`
-
-Open your local development app in your default browser.
-
-```console
-$ shopify open
-```
-
-## `populate`
-
-Add example data to your development store. This is useful for testing your app’s behavior. You can create the following types of example store records:
-
-- Products
-- Customers
-- Orders
-
-```console
-$ shopify populate products
-$ shopify populate customers
-$ shopify populate draftorders
-```
-
-By default, the `populate` command adds 5 records. Use the `--count` option to specify a different number:
-
-```console
-$ shopify populate products --count 10
-```
-
-## `serve`
-
-Start a local development server for your project, as well as a public [ngrok](https://ngrok.com/) tunnel to your localhost.
-
-```console
-$ shopify serve
-```
-
-## `tunnel`
-
-Control an HTTP tunnel to your local development app using [ngrok](https://ngrok.com). With the `tunnel` command you can authenticate with ngrok and start or stop the tunnel. (Note that the `serve` command will automatically run `tunnel start` for you.)
-
-To authenticate with ngrok, you need an authentication token. You can find it in [your ngrok dashboard](https://dashboard.ngrok.com/auth/your-authtoken). Copy your token and use it with the `tunnel auth` command:
-
-```console
-$ shopify tunnel auth <token>
-```
-
-This will write your ngrok auth token to `~/.ngrok2/ngrok.yml`. To learn more about ngrok configuration, [consult ngrok’s documentation](https://ngrok.com/docs#config).
-
-To start an ngrok tunnel to your app in your localhost development environment:
-
-```console
-$ shopify tunnel start
-```
-
-To stop the running ngrok tunnel:
-
-```console
-$ shopify tunnel stop
-```