All Tutorials

Version and publish your product subscription app extension

All Tutorials

Version and publish your product subscription app extension

Version and publish your product subscription app extension

To create a stable and consistent experience for partners and merchants, app extensions are versioned. This allows control over when an extension is published, and a way to rollback changes if issues occur. Publishing an app extension version replaces the current live version served to shops that have your app installed.

This tutorial explains how to add versioning to your app extension.

Register your extension with an app

Before you can upload your extension to Shopify, you need to register your extension to an app in your Partner Dashboard. If you don’t have an app, then you can create one with the Shopify App CLI.

Registration connects your extension to your app, allowing you to push your extension code to Shopify and run the app extension in the Shopify admin.

To register your extension:

  1. Run the following command in your app extension directory:
Terminal
  $ shopify register
  1. When prompted, select the app that you want to register the extension to. You can only register one Product subscription app extension per app.

Push your extension to Shopify

After your extension is registered to an app, you can push your extension code to Shopify.

In your terminal, run the following command to push your extension code to Shopify:

Terminal
$ shopify push

If the push is successful, then the CLI will display a timestamp and URL to the extension versioning page in the Partner dashboard. Open the URL to begin creating a version.

Preview your draft

Create a version

When you're ready to release your extension to merchants, you can create a version using the following steps:

  1. Click Create version.
  2. In the modal, select Minor or Major version depending on the nature of your code changes.

    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.

Publish a version

When you're ready to release your extension to merchants, you can publish it. Publishing an extension version replaces the current Live version served to shops that have your app installed.

To publish an app extension version:

  1. Open the extension versioning page in your Partner Dashboard.
  2. Click Publish beside the version that you want to publish.

The new version is now served to all shops with your app installed.

Next steps