Branching Baseline
Last updated
Last updated
Note: This article is for the Org Administrator in particular. The actions discussed in the article are not available to general users.
Components are retrieved and committed from a Salesforce org to a version control branch using Branching Baseline. This helpful feature can deal with a lot of metadata and is ideal for (but not limited to) the following two scenarios:
Branching Baseline will sync the branch to its mapped Salesforce org, so they are in sync.
Users can create a new branch and update it with an existing Salesforce Org.
Log in to your ARM account.
Hover your mouse over the Admin module and click on Branching Baseline.
From the Branching Baseline screen, click on New Branching Baseline.
The Branching Baseline screen appears where you need to fill in the details listed below:
Give a Label Name.
Select your Salesforce Org as the source of the commit.
Select your Repository and Branch to which you would like to commit code.
Important Note: For Version Control registered in the SFDX structure, specify the Source Folder from where the metadata will get fetched. If you cannot view the source folder in the drop-down, the source folder is not listed in the Package Directory under the sfdx-project.json file in your local directory. For a detailed procedure of adding the source folder in the Package Directory, do refer to the article: Salesforce DX metadata format.
Exclude baseline managed package changes: This option will ensure that only unpackaged components are retrieved into your version control branch.
Important Note: If a managed package is installed in a Salesforce org on a date, but a different date is given on the CI Job created, then the installed managed package numbers are also loaded. We can exclude baseline managed package changes to skip those installed managed packages. As all installed packages in a Salesforce org come from a Managed source (AppExchange, etc.), such managed components can be excluded from a baseline operation.
Delete existing metadata and commit new changes: This option will delete all existing metadata and commit all the metadata members from the Salesforce org to the Version Control repository, thereby deleting the existing contents of a branch before the Baseline operation. In short, if you want zero components in your repository, then this option will allow you to delete all the existing metadata and commit all the metadata members from the salesforce org to the version control repository.
Use Bulk Retrieve: This option retrieves the components in batches. The users need to specify the batch size for Profile components and other components in which they will get retrieved.
Specify the batch size for both profile and remaining components to retrieve records: You need to specify for profile components and other components in which ARM will retrieve. So, the default size for the profile is 500, and for other components is 2,000. You can modify it as per your requirement. Bulk retrieval helps run large jobs that would exceed normal processing limits—you can deploy up to 10,000 files at once or a maximum size of 14MB. Using Batch Size, you can process records in batches to stay within platform limits. If you have a lot of records, processing records through batches is the best option.
When the user selects Salesforce as the retrieval type in the Branching Baseline screen, the system automatically fetches the Automatically Exclude Salesforce Option along with the metadata list based on the global configuration set by the Admin. The user can review these settings and, if necessary, modify the metadata exclusions by adjusting the list according to their specific requirements.
Click OK. A notification pops up displaying that the branching baseline operation is initiated.
You will be redirected to the Branching Baseline summary page, where you can find the status of your branching baseline operation recently created. The status column will indicate whether your baseline operation was completed or failed.
Point to Note: Branching baseline commits for the SVN repository may take 10 minutes to complete.
More Options
Info: This will give information about the Salesforce Org and the Version Control Repository/ Branch selected for the Branching Baseline operation.
Revision: View the revision generated at the Version Control along with the filename status. You can even download the report if required.
Status: View the status of the Branching Baseline operation.
Log: View the execution log of the Branching Baseline operation.
Status Details: The system now displays the status of the branching baseline, indicating whether it has partially succeeded or failed. In cases of partial success, detailed, batch-wise information is provided, including the reasons for failure within each batch. Additionally, an XML file is available for download for each batch, allowing users to review the details or troubleshoot as needed.
Status | Description |
The branching baseline operation is in progress | |
The branching baseline is completed | |
The baseline operation got failed | |
The branching baseline has been timed out | |
The branching baseline has been partially successful | |
The branching baseline has no modifications |
Run: This option allows you to run your branching baseline operation at a later stage. It iterates a new baseline operation to update your branch with the latest metadata from your Salesforce Org.
Delete: Deletes the branching baseline operation when you don’t require one, like older ones. Once deleted, this cannot be undone.
