After releasing an app version, you must publish your app so that you can install it in certain accounts to perform A/B tests and validate your changes. In other words, you must turn your app into a candidate version.

A candidate version of an app is a build distributed internally for testing purposes only. It's intended to check, before deployment, whether any critical problems have gone undetected earlier during development. Ideally, there shouldn't be many differences between your app's last candidate version and its final build.

Before you start

Before proceeding any further, make sure the app you are about to publish has already been released.

Notice that publishing an app is one of the steps to making your new app version publicly available. Please refer to this guide for more information.

Step by step

Step 1 - Publishing a candidate version

Until now, your app version exists only in a local environment. To make it possible to install it in specific accounts and run tests, you must first turn it into a candidate version.

  1. Open the terminal and log in to the account responsible for the app development, i.e., the account specified as the app's vendor in the Manifest file.
  2. Change to your app's root folder.
  3. Publish your app by running the following command:
vtex publish

Step 2 - Validating the candidate version

Before deploying your candidate version, you must install it in a new Production workspace and perform tests to check your app's behavior. Notice that production workspaces are ready to receive traffic and be accessed by other users.

  1. Change to a new Production workspace:
  • Remember to replace the values between the curly brackets according to your scenario.
vtex use {workspaceName} --production
  1. Install the candidate version by indicating the new app's exact version:
  • Remember to replace the values between the curly brackets according to your scenario.
vtex install {appvendor}.{appname}@{appversion}
  1. Start an A/B test to test your candidate version. Please refer to this guide for more information.

From this point onwards, you won't be able to link apps or make any code changes in your app's current version. Hence, if you need to make any modifications to your app, you will need to retreat and work on it in a development workspace.

️>⚠️ If you are developing a new store theme major, follow the steps in the Migrating CMS settings after a theme major update guide before proceeding any further. Otherwise, you may lose page templates set up via the Admin.

Next steps


Did this page help you?