Deploy and release extensions
After you create one or more app extensions, you can release those extensions to users by creating and releasing an app version. An app version is a snapshot of all of your app extensions. You can revert to a previous app version at any time by releasing an older app version.
Releasing an app version doesn't release your web app. When you're ready to deploy your app to production, you need to deploy your web app to your own hosting solution. For more information, refer to Deploy your web app.
If you have an app extension that you want to deploy to Shopify regularly, then you can integrate Shopify CLI into your CI/CD pipeline to programmatically deploy your app components using the deploy
command.
Requirements
Anchor link to section titled "Requirements"- You've created an app extension using Shopify CLI or the Partner Dashboard.
Create and release an app version
Anchor link to section titled "Create and release an app version"When you're ready to release your changes to users, you can create and release an app version. An app version is a snapshot of all of your app extensions.
The contents of your app version depend on the tool that you use to create it. You can create an app version using Shopify CLI or the Partner Dashboard. However, to create an app version that updates your CLI-managed extensions, you need to create the app version using Shopify CLI.
Before you create a new app version, you might want to preview one or more of your extensions. To learn how to preview and test your app extension, refer to the documentation for your extension type.
Some app versions need to be reviewed by Shopify before they can be released. You can submit an app version for review through the Partner Dashboard.
You can also set up your CI/CD pipeline to deploy your app extensions programmatically.
Release an app version using Shopify CLI
Anchor link to section titled "Release an app version using Shopify CLI"Follow these steps to create an app version using Shopify CLI:
- Navigate to your app directory.
Run one of the following commands.
Optionally, you can provide a name or message for the version using the
--version
and--message
flags.
Releasing an app version replaces the current active version that's served to stores that have your app installed. It might take several minutes for app users to be upgraded to the new version.
After you release your new app version, you can view the version details and distribution progress in the Partner Dashboard, or by running the versions list
command in Shopify CLI.
Create an app version using the Partner Dashboard
Anchor link to section titled "Create an app version using the Partner Dashboard"Follow these steps to create an app version using the Partner Dashboard:
- From the Partner Dashboard, go to Apps.
Select your app from the list.
Click Versions.
From the Versions page, click Release version.
Optional: enter a name and message for the version.
Click Release. If you don't want to release right away, then you can click Create version.
Releasing an app version replaces the current active version that's served to stores that have your app installed. It might take several minutes for app users to be upgraded to the new version.
After you release your new app version, you can view the version details and distribution progress in the Partner Dashboard, or by running the versions list
command in Shopify CLI.
Integrate Shopify CLI into your CI/CD pipeline
Anchor link to section titled "Integrate Shopify CLI into your CI/CD pipeline"You can deploy any app extensions that you generated using Shopify CLI in a CI/CD pipeline.
All of the extensions in your app, including extensions created in the Partner Dashboard, are versioned together as a single app version.
Release an existing app version
Anchor link to section titled "Release an existing app version"If you created an app version without releasing it, or you want to roll back to a previous app version, then you can release it using Shopify CLI or the Partner Dashboard.
Release an existing app version using Shopify CLI
Anchor link to section titled "Release an existing app version using Shopify CLI"- Navigate to your app directory.
Run one of the following commands. Replace
VERSION
with the name of the version that you want to release.
Release an existing app version through the Partner Dashboard
Anchor link to section titled "Release an existing app version through the Partner Dashboard"- From the Partner Dashboard, go to Apps and then select your app from the list.
- Click Versions.
- From the Versions page, select the app version that you want to release.
- On the app version page, click Release.
Submit an app version for review
Anchor link to section titled "Submit an app version for review"Depending on the extension types included in your app version, your version might need to be reviewed by Shopify. To understand which extension types require a review, refer to the list of extension types.
- From the Partner Dashboard, go to Apps.
- Select your app from the list.
- Click Versions.
- Select the version that you want to release.
Click Submit for review.
When Shopify has reviewed and approved the app version, click Release to release the new app version to users.