Deploy and publish an app extension
After you generate an extension using the Shopify CLI
generate command, you can deploy your extension code to Shopify.
You can use the CLI
deploy command to deploy any app extension that you've generated using Shopify CLI. This command deploys all of the extensions that are included in your app at the same time. However, you need to version and publish the extensions individually.
RequirementsAnchor link to section titled "Requirements"
You've created an app that uses Shopify CLI 3.0 or higher, or migrated your existing app so it's compatible with Shopify CLI 3.0 or higher.
To learn how to upgrade and check your Shopify CLI version, refer to Upgrade Shopify CLI.
You've created a development store to preview and test your app extension.
Step 1: Deploy your extension codeAnchor link to section titled "Step 1: Deploy your extension code"
- Navigate to your app directory.
Run one of the following commands:
When you run the
deploycommand, the CLI builds your app, bundles your app extensions, and deploys the extensions to Shopify as a draft. It also walks you through multiple configuration steps. If you've already run
deployfor this app, then some of these steps are skipped.
To learn about the processes that are executed when you run
deploy, refer to the Shopify CLI command reference.
Step 2: Preview and test your app extensionAnchor link to section titled "Step 2: Preview and test your app extension"
After deploying your extension code to Shopify, you can preview a draft of the extension on a development store before creating a version.
To learn how to preview and test your app extension, refer to the documentation for your extension type.
Step 3: Create a version and publishAnchor link to section titled "Step 3: Create a version and publish"
When you're ready to release your extension to merchants, you can create a version and publish it.
After you deploy the extension to Shopify, navigate to your app in the Partner Dashboard.
Click Create version.
Select Minor or Major version depending on the nature of your code changes, and click Create.
Minor versions introduce changes that are backwards compatible. Major version changes aren't backwards compatible and might affect users who are currently using your extension.
Click Publish beside the version that you want to publish, and click Publish in the popup modal to confirm. Publishing an extension version replaces the current Live version that's served to shops with your app installed.
It might take up to five minutes for merchants using the app to be upgraded to the new version.