shopify-cli 1.3.0 → 1.6.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

@@ -29,9 +29,11 @@ namespace :rdoc do
     '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/tunnel.rb',
   ]
 

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
-```

data/docs/app/rails/index.md

@@ -1,36 +1,4 @@
 ---
-title: Getting started with Rails app projects
-section: rails
-toc: false
+title: Getting started with Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/getting-started
 ---
-
-## Create a new Rails app project
-
-To create a new Rails project, type `shopify create rails`. This will scaffold a new Rails app in a subdirectory.
-
-```console
-$ shopify create rails
-? 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 [Rails project command reference]({{ site.baseurl }}{% link app/rails/commands/index.md %}).
-

data/docs/core/index.md

@@ -1,86 +1,4 @@
 ---
-title: Core commands
-section: core
+title: Shopify App CLI core commands
+redirect_to: https://shopify.dev/tools/cli/reference
 ---
-
-## `help`
-
-Lists the available commands and describes what they do. The commands available will vary depending on whether you are inside a project directory, and what kind of project it is.
-
-```console
-$ shopify help
-$ shopify -h
-$ shopify --help
-```
-
-You can also use the `help` command or options to get more detailed information about a specific command:
-
-```console
-$ shopify help [command]
-$ shopify [command] -h
-$ shopify [command] --help
-```
-
-## `connect`
-
-Connect an existing Shopify App CLI project with Shopify, such as a Partner account or a specific Shopify development store. This command re-creates the project’s `.env` file with your authentication tokens.
-
-This is useful if you are working on one project across multiple computers, or collaborating with other developers using a version control system like git.
-
-```console
-$ shopify connect
-```
-
-## `create`
-
-Create a new project of the specified type. The project will be created in a subdirectory of the current directory:
-
-```console
-$ shopify create
-```
-
-When running the `create` command on its own, the CLI will prompt you to choose a project type:
-
-```console
-$ shopify create
-? What type of project would you like to create? (Choose with ↑ ↓ ⏎, filter with 'f')
-> 1. Node.js App
-  2. Ruby on Rails App
-```
-
-You can also specify the type of app you want to create using a subcommand:
-- For a Node.js app: `node`
-- For a Ruby on Rails app: `rails`
-
-If you specify a type, then Shopify App CLI will skip ahead and prompt you to enter a name for your project:
-
-```console
-$ shopify create node
-? App Name
-> 
-```
-
-## `logout`
-
-Log out of the currently authenticated partner organization and store. The `logout` command clears any invalid credentials. You’ll need to re-authenticate the next time you connect your project to Shopify.
-
-```console
-$ shopify logout
-```
-
-## `config`
-
-Configure Shopify App CLI options. Currently there are two available options.
-
-### `analytics`
-
-Configure anonymous usage reporting by enabling or disabling analytics 
-```console
-$ shopify config analytics [ --status | --enable | --disable ]
-```
-
-### `feature`
-Configure active [feature sets](https://github.com/Shopify/shopify-app-cli/wiki/Feature-Sets) in the CLI. This command is used for development and debugging work on the CLI tool itself. Only alter it if you know what you're doing. Check the [Shopify App CLI development guide](https://github.com/Shopify/shopify-app-cli/wiki) for more information.
-```console
-$ shopify config feature [ feature_name ] [ --status | --enable | --disable ]
-```