Salesforce DX Metadata Format
Last updated
Last updated
For AutoRABIT to detect your repository as being in DX format, it looks for an sfdx-project.json file in your local directory.
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.
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.
ARM does not currently support custom SFDX directory structures. As per the standard SFDX directory structure, we follow and accept only the <force-app*>/main/default/* structure. This is the default structure created when we run the project generate command, as follows:
There can be multiple package directories, and all of them should follow the same structure. The sfdx-project.json file is used to identify the list of package directories, and all ARM functionalities work with the <package-directory>/main/default structure.
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.
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.
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.
In the process of creating unlocked packages via AutoRABIT, you need to select the source folder under the Package Directory field.
While creating commit labels for SFDX repositories, you need to select the source folder under the Package Directory field.
During release label creation for SFDX repositories, you need to select the source folder under the Package Directory field.
