The Releases is in beta version, which means we are working to improve it. This feature is only available for stores using FastStore.

The Releases module allows you to manage releases so that you can coordinate the creation, schedule and publication of the changes in your store. A release is a change or a group of changes that can be published together.

In the Releases, you can view all the information about releases, follow the status of the releases and perform a series of actions. In this article, we will present you those actions and how to perform them.

The feature can be accessed through the VTEX Admin Releases navigation menu, where you’ll find the following pages:

• Calendar
• Releases

Each page displays a view of the releases and allows you to perform different actions depending on the release status. The main actions are:

• Create a release
• Search for a release
• Schedule, reschedule or unschedule a release
• Publish a release
• Delete a release

In the beta version, releases must be CMS-related, because other VTEX platform modules are not yet included. To use the Releases, you must configure the CMS as described in Installing Releases on VTEX Headless CMS.

To create a release through the Releases, follow these steps:

1. In the Calendar or Releases page, click on Create Release.
2. Fill in the Name field with a name for the release.
3. In Publish date, choose a date to publish the release (optional).
4. In Time, choose the time of the publication (optional).
5. Click on Create.

The following confirmation message will appear: The release was created and scheduled.

When you create a release, it is not mandatory to define the Publish date and Time because you can create a release with the Unscheduled status and it can be Scheduled afterwards.

In the Releases page, you can search for releases using different tools:

• Search bar: Enter the name of the release you want to find.
• Filters: To filter by release status, click on Filters, then use the All statuses button and choose the desired option. To filter by scheduled date, click use the All periods to choose the desired date.

There are three possible actions you can perform when you set the publication date:

• Schedule: Define a publication date for the release when there is no one.
• Unschedule: Cancel a publication date, which will move the release to the Unscheduled status.
• Reschedule: Define a new date for a release that already had a set date.

To schedule a release with the Unscheduled status, follow these steps:

1. In the Releases page, click on the three-dots menu icon of the desired release.

2. Choose the Schedule option.

3. In Publish date, choose a date to publish the release.

4. In Time, choose the time of the publication.

5. Click on Schedule.

   Once you’ve scheduled a release, there will appear the following confirmation message: Release scheduled.

When the release is in the Scheduled status, you can reschedule it. The steps to reschedule it are similar to the ones in the previous section. The only difference is that you'll see the option Reschedule instead of Schedule.

Once you've rescheduled a release, there will appear the following confirmation message: Release scheduled.

To unschedule a release and move it to the Unscheduled status, follow these steps:

1. In the Releases page, click on the three-dots menu icon of the desired release.
2. Choose the Unschedule option.
3. Click on the Unschedule button.

In order to publish a release, it needs to be in one of the following status:

• Unscheduled
• Scheduled
• Publish failed

In order to publish a release and make the changes available in the storefront of your store, follow these step-by-step instructions:

1. In the Releases page, click on the three-dots menu icon of the desired release.
2. Click on Publish Now.
3. Click on Publish.

A release can be deleted in every release status, i.e., it can be deleted permanently.

If instead of deleting a release you want to archive it, you should unpublish it so that it is not deleted and you can republish it at any time.

When you delete a release in the Published status, its changes remain in the storefront of the store, the only thing that no longer exists is the release with the changes.

To delete a release, follow these step-by-step instructions:

1. In the Releases page, click on the three-dots menu icon of the desired release.
2. Click on Delete.
3. Click on Delete again.

• Releases: Release concept
• Releases: Calendar page
• Releases: Releases page