VTEX Developer Portal

Promoting a workspace to Master

Promoting a workspace to Master

Promoting a workspace to Master means making your code changes usable to the end user, in other words, making them publicly available.

According to the different types of workspaces in the platform, only Production workspaces can be promoted to Master. [Developer workspaces], in turn,(https://vtex.io/docs/recipes/development/creating-a-development-workspace/) only must be used for code development and testings.

Step by step

  1. Make sure you are logged into an VTEX account and using the desired Production workspace to be promoted;
  2. Run the following command:

vtex workspace promote

You can not make changes to a Master workspace because it corresponds to the version that is available to the end user. Instead, work on the new code in a Development workspace, reproduce it in a Production workspace in order to test your changes with user traffic and then promote it to Master.

Notice the following: whenever you promote a Production workspace to Master, other account's workspaces will also be impacted with the new changes.

This is due to the fact that the account's workspaces work as a copy of the version available to the end user. Therefore, the Master settings will always prevail over the settings of the other account's workspaces.

Promoting a Master workspace is one of the steps to making your code's new version public, meaning that it will become available to your end users. For more details on the next steps and to better understand the full flow, access the recipe on Making your new app version publicly available.

Updated about 6 hours ago

Promoting a workspace to Master

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.