shopify-cli 0.9.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c41d92242b50f6d361cd7ad137799bffe507581437f25a1eb1bd183cc206c63
-  data.tar.gz: '06887cc6c8442a754bf9a9d60e10968c5c59325b98a50d452e6f849a80db7226'
+  metadata.gz: 3355ade46f06f8fad98098842f7b68bb0a154a53921a498ca4aba18379512ff6
+  data.tar.gz: 57617469febb8905d737a9991f4da4a578e0f87bc8cad17bfc3d674e28cd40c2
 SHA512:
-  metadata.gz: 23260cf14a8e617539fedb1bddf1beb5f91604fc5db87d147335649dd01f7fb9859c87da6a01bba5c19743dabc8aa0c1c55bf269cdaec57943f076a88fffcff9
-  data.tar.gz: eddd93f62bb2bd7f8364c4c423847568838d08fdbf77f777f03f2adb9fbfa67f7a3af83bedc48025f217e1787288f5b6e10424e5dbdad1156a8faaf80ddb041c
+  metadata.gz: a71cd8e3f4f9409f0c527ab6da9152e592d7cd1be173d9fe4e1499713998cf245541504151a1e63fa5901cf0c83b1d41302bc6628defff86042908b5e63d37af
+  data.tar.gz: 2d16c25b44bd21abbcd154abd0ff5d3b3e9e464b7c89377b523299855800cd65bf3357d89b3d92d8a66137e8316d64de755263a1bc21f30df1c5ad3b8e492492

data/.github/CODEOWNERS

@@ -1 +1,4 @@
 *       @shopify/platform-dev-tools-education
+
+/lib/project_types/script/ @shopify/scripts
+/test/project_types/script/ @shopify/scripts

data/CHANGELOG.md

@@ -1,8 +1,30 @@
-Version 0.9.1
+Version 1.0.2
+------
+* Fix missing shop parameter to AdminAPI.query() call (impacting populate and generate commands)
+
+Version 1.0.1
+------
+* Fixed an issue with RVM taking over the shell shim fd when it was not in use
+
+Version 1.0.0
+------
+* Release the installer-based version of the CLI
+
+Version 0.9.3 - Internal Test Version
+------
+* Rebased to master
+* Removed auto-generated files from builds directory
+
+Version 0.9.2 - Internal Test Version
+------
+* Rebased to master, to pull in 7+ Pull Requests
+* Updates to dependencies to package files (updated Ruby version)
+
+Version 0.9.1 - Internal Test Version
 ------
 * Updated required Ruby version for the CLI
 * Minor fixes for the build / release process
 
-Version 0.9.0
+Version 0.9.0 - Internal Test Version
 ------
 * Initial test release of gem-based CLI

data/RELEASING.md

@@ -13,7 +13,7 @@
 
 5. Commit the changes with a commit message like "Packaging for release X.Y.Z"
    ```
-   $ git commit -am "Packaging for release X.Y.Z"
+   $ git commit -am "Packaging for release vX.Y.Z"
    ```
 
 6. Push out the changes
@@ -21,7 +21,7 @@
    $ 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
+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
 
@@ -34,8 +34,8 @@
 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
-    * when PR is approved, merge into main branch of `Shopify/homebrew-shopify` repository
+    * 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")

data/docs/_config.yml

@@ -14,3 +14,6 @@ defaults:
       path: ""
     values:
       toc: true
+
+plugins:
+  - jekyll-redirect-from

data/docs/_data/nav.yml

@@ -5,6 +5,15 @@ sidebar:
   - title: Getting started
     section: getting-started
     url: /getting-started/
+    subnav:
+      - title: Install
+        url: /getting-started/install/
+      - title: Upgrade
+        url: /getting-started/upgrade/
+      - title: Uninstall
+        url: /getting-started/uninstall/
+      - title: Migrate from a legacy version
+        url: /getting-started/migrate/
   - title: Core commands
     section: core
     url: /core/

data/docs/getting-started/index.md

@@ -1,6 +1,7 @@
 ---
 title: Getting started
 section: getting-started
+toc: false
 ---
 
 Developers should have some prior knowledge of the [Shopify app ecosystem](https://shopify.dev/concepts/apps). Shopify App CLI creates apps using either [Node.js](https://nodejs.org/) or [Ruby on Rails](https://rubyonrails.org/).
@@ -8,11 +9,8 @@ Developers should have some prior knowledge of the [Shopify app ecosystem](https
 ## Requirements
 
 - [Ruby](https://www.ruby-lang.org) 2.5.1+ 
-- [Node.js](https://nodejs.org) 10.0.0+
-- [curl](https://curl.haxx.se)
 - A [Shopify partner account](https://partners.shopify.com/signup)
 - A [Shopify development store](https://help.shopify.com/en/partners/dashboard/development-stores#create-a-development-store) to install and test apps
-- An [ngrok](https://ngrok.com/) account (free or paid) for local development
 
 ### Windows requirements
 
@@ -21,41 +19,8 @@ You’ll need to install the following tools to use Shopify App CLI on Windows:
 - [Linux Subsystem for Windows](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
 - [Ubuntu VM](https://www.microsoft.com/en-ca/p/ubuntu/9nblggh4msv6)
 
-## Install
+## Next steps
 
-Shopify App CLI installs using a shell script. Download and run it in your terminal with one command:
-
-```console
-eval "$(curl -sS https://raw.githubusercontent.com/Shopify/shopify-app-cli/master/install.sh)"
-```
-
-[View shell script source](https://raw.githubusercontent.com/Shopify/shopify-app-cli/master/install.sh)
-
-
-## Uninstall
-
-There are two steps to completely uninstall Shopify App CLI:
-
-1. Delete the CLI files
-1. Remove the `shopify` command from your shell profile
-
-### 1. Delete the CLI files
-
-By default, Shopify App CLI is installed in your home directory. All the files are contained in a hidden directory called `.shopify-app-cli`. Delete that directory to uninstall.
-
-### 2. Remove the `shopify` command from your shell
-
-During the install process, Shopify App CLI adds a line to your shell configuration. This line is typically located in the `.bash_profile` file in your home directory (depending on your system, it may also be found in `.bash_login` or `.profile`). It will look similar to this:
-
-```sh
-# The line won’t look exactly like this. `HOME_DIR` will instead be the absolute path to your home directory.
-if [[ -f /HOME_DIR/.shopify-cli/shopify.sh ]]; then source /HOME_DIR/.shopify-cli/shopify.sh; fi
-```
-
-You can use `grep` to search for the correct file in your home directory. This command will return the name of the relevant file, and the line number where it appears:
-
-```console
-$ grep -Ens "^if.+\.shopify-app-cli/shopify\.sh.+fi$" ~/\.*
-```
-
-Deleting or commenting out the relevant line in your shell profile will remove `shopify` as a command. You may need to reload your shell.
+- [Install the CLI]({{ site.baseurl }}/getting-started/install/)
+- [Upgrade]({{ site.baseurl }}/getting-started/upgrade/)
+- [Uninstall]({{ site.baseurl }}/getting-started/uninstall/)

data/docs/getting-started/install/index.md

@@ -0,0 +1,75 @@
+---
+title: Install Shopify App CLI
+section: getting-started
+toc: false
+redirect_from: "/install/"
+---
+
+Shopify App CLI can be installed using a variety of package managers.
+
+### Homebrew (macOS)
+
+You’ll need to run `brew tap` first to add Shopify’s third-party repositories to Homebrew.
+
+```console
+$ brew tap shopify/shopify
+$ brew install shopify-cli
+```
+
+### apt (Debian, Ubuntu)
+
+You’ll need to install a downloaded .deb file with an explicit version number. Check the [releases page](https://github.com/Shopify/shopify-app-cli/releases) to make sure you install the latest package.
+
+```console
+$ sudo apt install shopify-cli-x.y.z.deb
+```
+
+### yum (CentOS 8+, Fedora, Red Hat, SUSE)
+
+You’ll need to install a downloaded .rpm file with an explicit version number. Check the [releases page](https://github.com/Shopify/shopify-app-cli/releases) to make sure you install the latest package.
+
+```console
+$ sudo yum install shopify-cli-x.y.x.rpm
+```
+
+### Ruby gem
+
+```console
+$ gem install shopify-cli
+```
+
+### To check that Shopify App CLI is installed correctly:
+
+```console
+$ shopify version
+1.0.0
+$
+```
+
+> Note 1: the version displayed may be newer.
+
+> Note 2: If you have the `shopify_api` gem installed, you may see the following response:
+> ```console
+> shopify command is no longer bundled with shopify_api.
+> if you need these tools, install the shopify_cli gem
+> ```
+> 
+> If so, then you will also need to upgrade the `shopify_api` gem to v9.2.0+ to remove a deprecated `shopify` command that is contained in that gem.
+>
+> If you also have the `shopify_app` gem (which depends on `shopify_api` gem), you'll need to install or update `shopify_api` first, then uninstall the older version.
+> 
+> To get a list of the version(s) of `shopify_api` currently installed:
+> ```console
+> $ gem list shopify_api
+> ```
+> 
+> To install the latest version:
+> ```console
+> $ gem install shopify_api
+> ```
+> 
+> To uninstall the older version:
+> ```console
+> $ gem uninstall shopify_api -v x.y.z
+> ```
+> Replace x.y.z with a version number listed from the `gem list` command.  Repeat as needed.

data/docs/getting-started/migrate/index.md

@@ -0,0 +1,96 @@
+---
+title: Migrate from the legacy Shopify App CLI
+section: getting-started
+redirect_from: "/migrate/"
+---
+
+As of version 0.9.0, Shopify App CLI is installed and managed as a software package, instead of as a git repository. If you’re using a legacy version, you’ll need to perform a one-time migration to keep using the CLI. Follow these steps to remove the legacy version and reinstall as a package.
+
+## Check whether you’re using the legacy version
+
+Prior to version 0.9.0, Shopify App CLI was installed as a Git repository. You can determine if you’re running a legacy version by running this command:
+
+```console
+$ shopify version
+```
+
+If you get a “Command not found” error, then you’re using a legacy version and will need to uninstall it manually.
+
+## 1. Uninstall the legacy Shopify App CLI
+
+There are two steps to completely uninstall the legacy version of Shopify App CLI:
+
+1. Delete the legacy CLI files
+1. Remove the legacy `shopify` command from your shell profile
+1. Reload your terminal
+
+### 1. Delete the CLI files
+
+By default, Shopify App CLI was installed in your home directory. All the files are contained in a hidden directory called `.shopify-app-cli`. Delete it to uninstall:
+
+```console
+$ rm -rf ~/.shopify-app-cli/
+```
+
+### 2. Remove the `shopify` command from your shell
+
+During the install process, Shopify App CLI added a line to your shell configuration. This line could be located in one of a few possible files in your home directory:
+
+- `~/.bash_profile`
+- `~/.zshrc`
+- `~/.bash_login`
+- `~/.profile`
+- `~/.config/fish/config.fish`
+
+It will look similar to one of the lines below. The exact syntax may vary depending on your system:
+
+```sh
+# The line won’t look *exactly* like this. `HOME_DIR` will instead be the absolute path to your home directory.
+if [[ -f /HOME_DIR/.shopify-cli/shopify.sh ]]; then source /HOME_DIR/.shopify-cli/shopify.sh; fi
+
+# The line might not be wrapped in an `if` statement. Example:
+[ -f "/HOME_DIR/.shopify-app-cli/shopify.sh" ] && source "/HOME_DIR/.shopify-app-cli/shopify.sh"
+```
+
+Deleting or commenting out the relevant line in your shell profile will remove `shopify` as a command.
+
+### 3. Reload your terminal
+
+For the changes above to take effect, exit your terminal, and start a new one.
+
+If you try running `shopify` now, you should get a `command not found` error.
+
+> If you have the `shopify_api` gem installed, you may see the following response:
+> ```console
+> shopify command is no longer bundled with shopify_api.
+> if you need these tools, install the shopify_cli gem
+> ```
+> 
+> If so, then you will also need to upgrade the `shopify_api` gem to v9.2.0+ to remove a deprecated `shopify` command that is contained in that gem.
+>
+> If you also have the `shopify_app` gem (which depends on `shopify_api` gem), you'll need to install or update `shopify_api` first, then uninstall the older version.
+> 
+> To get a list of the version(s) of `shopify_api` currently installed:
+> ```console
+> $ gem list shopify_api
+> ```
+> 
+> To install the latest version:
+> ```console
+> $ gem install shopify_api
+> ```
+> 
+> To uninstall the older version:
+> ```console
+> $ gem uninstall shopify_api -v x.y.z
+> ```
+> Replace x.y.z with a version number listed from the `gem list` command.  Repeat as needed.
+
+## 2. Install the new version
+
+Next, install the most recent version of Shopify App CLI. Follow the [install directions]({{ site.baseurl }}/getting-started/install/) for your platform.
+
+## 3. Re-authenticate the CLI
+
+The migration process moves some configuration files, so you’ll need to re-authenticate the CLI with your Shopify Partner Dashboard. The CLI will automatically prompt you to re-authenticate when needed.
+

data/docs/getting-started/uninstall/index.md

@@ -0,0 +1,37 @@
+---
+title: Uninstall Shopify App CLI
+section: getting-started
+toc: false
+redirect_from: "/uninstall/"
+---
+
+Shopify App CLI can be removed from your system using the same package manager you used to install it.
+
+### Homebrew (macOS)
+
+```console
+$ brew uninstall shopify-cli
+```
+
+### apt (Debian, Ubuntu)
+
+```console
+$ sudo apt remove shopify-cli
+```
+
+### yum (CentOS 8+, Fedora, Red Hat, SUSE)
+
+```console
+$ sudo yum remove shopify-cli
+```
+
+### Ruby gem
+
+```console
+$ gem uninstall shopify-cli
+```
+
+## Uninstall a legacy version
+
+If you’re using a legacy version of the CLI (`<0.9.0`), you’ll need to [uninstall it manually]({{ site.baseurl }}/getting-started/migrate/#1-uninstall-the-old-cli).
+

data/docs/getting-started/upgrade/index.md

@@ -0,0 +1,37 @@
+---
+title: Upgrade Shopify App CLI
+section: getting-started
+toc: false
+redirect_from: "/upgrade/"
+---
+
+You can manage upgrades to Shopify App CLI with the package manager for your platform.
+
+### Homebrew (macOS)
+
+```console
+$ brew update
+$ brew upgrade shopify-cli
+```
+
+### apt (Debian, Ubuntu)
+
+On Debian-based Linux distributions, download the latest `.deb` file for Shopify App CLI from the [releases page](https://github.com/Shopify/shopify-app-cli/releases) and install it to update.
+
+```console
+$ sudo apt install shopify-cli-x.y.z.deb
+```
+
+### yum (CentOS 8+, Fedora, Red Hat, SUSE)
+
+On Red Hat–based Linux distributions, download the latest `.rpm` file for Shopify App CLI from the [releases page](https://github.com/Shopify/shopify-app-cli/releases) and install it to update.
+
+```console
+$ sudo yum install shopify-cli-x.y.z.rpm
+```
+
+### Ruby gem
+
+```console
+$ gem update shopify-cli
+```

data/docs/index.md

@@ -10,18 +10,17 @@ Shopify App CLI helps you build Shopify apps faster. It quickly scaffolds Node.j
 
 ## Quick start
 
-1. Install Shopify App CLI:
-    ```console
-    $ eval "$(curl -sS https://raw.githubusercontent.com/Shopify/shopify-app-cli/master/install.sh)"
-    ```
+1. [Install Shopify App CLI]({{ site.baseurl }}{% link getting-started/install/index.md %}).
 2. Create an app:
     ```console
     $ shopify create
     ```
-3. Start and install your app on a Shopify Development store:
+3. Start and install your app on a Shopify development store:
     ```console
     $ shopify serve
     ```
     ```console
     $ shopify open
-    ```
+    ```
+
+**[Learn more in our Getting Started guide]({{ site.baseurl }}{% link getting-started/index.md %})**

data/lib/project_types/extension/cli.rb

@@ -30,6 +30,7 @@ module Extension
   module Tasks
     autoload :UserErrors, Project.project_filepath('tasks/user_errors')
     autoload :GetApps, Project.project_filepath('tasks/get_apps')
+    autoload :GetApp, Project.project_filepath('tasks/get_app')
     autoload :CreateExtension, Project.project_filepath('tasks/create_extension')
     autoload :UpdateDraft, Project.project_filepath('tasks/update_draft')
 
@@ -37,6 +38,7 @@ module Extension
       autoload :RegistrationConverter, Project.project_filepath('tasks/converters/registration_converter')
       autoload :VersionConverter, Project.project_filepath('tasks/converters/version_converter')
       autoload :ValidationErrorConverter, Project.project_filepath('tasks/converters/validation_error_converter')
+      autoload :AppConverter, Project.project_filepath('tasks/converters/app_converter')
     end
   end
 
@@ -51,7 +53,6 @@ module Extension
     autoload :ArgoSetupStep, Project.project_filepath('features/argo_setup_step')
     autoload :ArgoSetupSteps, Project.project_filepath('features/argo_setup_steps')
     autoload :ArgoDependencies, Project.project_filepath('features/argo_dependencies')
-    autoload :TunnelUrl, Project.project_filepath('features/tunnel_url')
   end
 
   module Models