Release Labels
Last updated
Last updated
A Release Label is a combination of multiple commit labels. Creating a release label will allow you to combine a group of single revisions, allowing all the revisions to be deployed all at one time. This article will discuss creating a new release label in the ARM application.
Before you begin:
Confirm you have the Manage Label permissions to create a new release label.
Commit revisions were made to the version control branch to combine them under a single release label. For more information, refer to the article: Commit Labels.
Log in to your ARM account.
Hover your mouse over the Version Control module and click on the Change Labels > Release Labels or directly go to the Change Labels tab and select Release Labels from the dropdown. The Release Label screen is best viewed when the zoom setting is set to 80% on your Chrome/Firefox browser.
Click on Create Release Label.
On the next screen, give the release label creation process a Label Name and enter a short Description.
Select the Repository and Branch containing the commit labels.
Note: For the version control repository registered in the SFDX structure, you must choose an additional option—Package Directory—to specify the type. We have added a refresh button in both the Create Release Label and Release Label Filter sections, allowing users to refresh and select the appropriate Package Directory.
To learn more about a Package Directory, refer to the article: Salesforce DX Metadata Format.
Select the commit Label Type, i.e., Salesforce or Vlocity.
Known Limitations: If a branch-to-branch merge involves multiple commits that include data from Vlocity and Salesforce components, ARM cannot classify those commits as Vlocity or Salesforce components.
From the No of Days dropdown list, you can choose to retrieve the commit history for the previous 30, 60, 90, 120, 180, or 365 days, or ALL the commits at once. Please note that selecting ALL may result in a slight delay in fetching the entire commit history.
Info: With the ARM 22.3 release, you can create a release label and start the artifact preparation immediately by selecting the Create package manifest for Deployment checkbox for Salesforce labels. If you do not select this checkbox on this screen, you can still click the Create Artifact button on the Release Label Summary screen to create and run a package manually.
Click Fetch Commit History to retrieve all the revisions available on your selected repo and branch. If no records appear, then no revisions have been committed to the branch.
Select two or more revisions from the left column to group them into a single release label. The Selected Revisions are displayed in a second column on the right side to make it easier to see. You can also unselect revisions from this section.
Important Note: If you choose just one revision while creating a new release label, a notification message asks you to select at least two revisions. You can choose the Single Revision option directly from the dropdown on the New Merge screen to perform a merge using only one revision. This helps in avoiding the creation of needless release labels.
Click OK. The newly created release label will be displayed on the Release Labels Summary screen.
It's always a good idea to break data into multiple pages when dealing with multiple-label records. You can browse 25, 50, 75, or 100 records on a single page or navigate to the previous or next page using the Previous and Next buttons.
With the ARM 22.3 release, the Release Labels Summary screen has been redesigned to enhance user experience and displays the following detailed information for each release label that is created:
At the top left is where you can see the Repository dropdown. You can choose a different repository from the dropdown list.
The release label name, the date and time it was last updated, and the version control branch.
The release label description.
Click on View Dataset to view the components in that release label package. You can view the components in JSON View or Tree View.
Click on the Merge icon (
) to merge the release label to a branch.
Click on the Edit icon (
) to update the Release Label information if required. You can also use the Search box to filter the results based on the label name.
Click on the Delete icon (
) to delete a Release Label. This process cannot be undone.
Click Create Artifact to manually create a package that got failed or was not prepared. This option will not be clickable if the package creation has been completed or is in progress. This option will be available for orange and red release labels but not for green.
Important Note:
On the New Deployment page, for the Release Label dropdown, the new release labels for which the package has been successfully prepared will be shown. The dropdown menu will not show release labels created before the ARM 22.3 release.
To manually prepare the package, use the Create Artifact button. The release label will then be available for deployment.
The release label package status: Completed, Failed, Package Not Prepared, In-progress, or Aborted. Abort an ongoing package preparation using theicon, theicon indicates an aborted process, and theicon indicates the release label package creation is a success.
Click on theicon to view the latest version log.
Click on theicon to download the package.xml file in a .zip format.
