Salesforce DX Metadata Format
  • 14 Nov 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Salesforce DX Metadata Format

  • Dark
    Light

Overview

For AutoRABIT to detect your repository as being in DX format, it looks for an sfdx-project.json file in your local directory. sfdx-project.json

AutoRABIT scans for the sfdx-project.json in your local directory which is the configuration file. Here you will find an array named 'packageDirectories'; this setting is called the Package Directory which contains the default directory of the source code/metadata where source code is pushed and pulled to and from scratch org. Package Directory

For the SFDX repository created outside and registered later with AutoRABIT, the source folder has to be declared in an sfdx-project.json file under the array named packageDirectories. This will allow you to pick the source folder that you have declared in the sfdx-project.json during commit/ CI Job operation or while creating unlocked packages. If you are in trouble finding the declared source folder yet, press the Refresh button to re-scan the Package Directories for the new source folder path.

Places to find the Source SFDX Folder Path

EZ-Commit screen

While committing metadata components from a Salesforce org to an SFDX repository/branch, you need to select the source folder under Package Directory drop-down field.Salesforce org

During CI Job

While deploying the SFDX source from a Version Control branch to a Salesforce Org, you need to choose the source folder for your SFDX repository.SFDX repositorySFDX repository

During Branching Baseline operation

While retrieving and committing all the metadata components from a Salesforce org to SDFX Branch, you need to select the source folder under the Package Directory field.Package Directory field

While creating Unlocked/Managed Packages

In the process of creating unlocked packages via AutoRABIT, you need to select the source folder under the Package Directory field.Managed Packages

While creating a new Commit Label

While creating commit labels for SFDX repositories, you need to select the source folder under the Package Directory field.Commit Label

During Release Label creation

During release label creation for SFDX repositories, you need to select the source folder under the Package Directory field.Release Label creation


Was this article helpful?