| Attribute | Type | Required | Description |
| version | enum | true | CI Configuration version. Values: - 1.x |
| inputs | Input[] | false | User input data. Supported by CLI tools |
| vars | Variable[] | false | Configuration variables |
| steps | Step[] | true | Job steps |
| Attribute | Type | Required | $ref syntax | Description |
| id | string | true | - | Input id. Must be unique for configuration. Pattern: [A-Za-z][0-9A-Za-z_-]{0,78}[0-9A-Za-z]? |
| description | string | false | - | Input variable description. Used bu CLI tool as input question. |
| required | boolean | false | - | Mark input as required (default: false) |
| default | string | number | boolean | null | false | yes, only $env | Default value of input variable (default: null). |
| Attribute | Type | Required | $ref syntax | Description |
| id | string | true | - | Variable id. Must be unique for configuration. Pattern: [A-Za-z][0-9A-Za-z_-]{0,78}[0-9A-Za-z]? |
| description | string | false | - | Variable description |
| value | string | number | boolean | null | true | yes, only $env and $input | Value of variable |
| Attribute | Type | Required | $ref syntax | Description |
| type | enum | true | - | Type of step. Values: \n- ci.changeSet.create - Create change sets to deploy and revert Pull Requests \n- ci.data.transfer - Transfer data form one Salesforce org to Another using bulk data API \n- sfdx.auth.accessToken - Authorize an org using an access token \n- sfdx.auth.list - List auth connection information \n- sfdx.auth.logout - Log out from authorized orgs \n- sfdx.auth.sfdxUrl - Authorize an org using sfdxurl \n- sfdx.force.apex.execute - Executes anonymous Apex code \n- sfdx.force.apex.test.run - Invoke Apex tests \n- sfdx.force.data.bulk.delete - Bulk delete records from a CSV file \n- sfdx.force.data.bulk.upsert - Bulk upsert records from a CSV file \n- sfdx.force.data.tree.import - Import data into an org \n- sfdx.force.data.soql.query.csv - Import data into an org \n- sfdx.force.mdApi.deploy - Deploy metadata to an org using Metadata API \n- sfdx.force.mdApi.retrieve - Retrieve metadata from an org using Metadata API \n- sfdx.force.org.create.scratch - Create a scratch org \n- sfdx.force.org.delete - Mark a scratch or sandbox org for deletion \n- sfdx.force.org.display - Get the description for the current or target org \n- sfdx.force.package.install - Install a package in the target org \n- sfdx.force.source.push - Push source to a scratch org from the project \n |
| id | string | true | - | Step ID to be referenced in output. Must be unique for configuration. Pattern: [A-Za-z][0-9A-Za-z-_]{0,39} |
| description | string | false | - | Step description. |
| continueOnError | string | false | - | Continue configuration execution on step error (default: false) |
| Attribute | Type | Required | $ref syntax | Description |
| headSha | string | true | yes | The hash number of the commit that contains the changes to merge. Pattern: [a-f0-9]{5,40} |
| baseSha | string | true | yes | The hash number of the target commit into which the changes will be merged. Pattern: [a-f0-9]{5,40} |
| destructiveChangeSetMode | enum | false | - | Specify whether removed components should be deleted before or after component additions. Enum values: - pre - post - default value |
| changeSetDir | string | true | yes | Output directory to store the Metadata API–formatted files for deploy |
| createRevertChangeSet | boolean | false | - | Specify whether to create a Change Set to revert changes (default: false) |
| revertDestructiveChangeSetMode | enum | false | - | Specify whether removed components should be deleted before or after component additions. Enum values: - pre - post - default value |
| revertChangeSetDir | string | true, if createRevertChangeSet=true | yes | Output directory to store the Metadata API–formatted files for revert changes |
| Attribute | Type | Required | $ref syntax | Description |
| sourceOrgAlias | string | true | yes | Alias of the Salesforce org from which data will be loaded for transfer. Pattern: [0-9A-Za-z_-]{1,40} |
| targetOrgAlias | string | true | yes | Salesforce org alias for data transfer. Pattern: [0-9A-Za-z_-]{1,40} |
| sObjectType | string | sObjectItem | true | - | Salesforce object. Specify 'source' and 'target' object if they are different. Pattern: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z] |
| sObjectFields | string | sObjectItem | true | - | Array of Salesforce object fields. Specify 'source' and 'target' fields if they are different. Pattern: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z](\\.[A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z]){0,4} |
| queryFilter | string | false | - | Query filter for Source org data. Allowed WHERE and LIMIT |
| externalId | string | true | - | Column name of the external ID in Target Salesforce Org. Pattern: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z] |
| allowNoMoreFailedBatches | number | false | - | Mark a step as successful if the number of Failed Batches is less than the specified number (default: 0). |
| allowNoMoreFailedRecords | number | false | - | Mark a step as successful if the number of Failed Records is less than the specified number (default: 0). |
| Attribute | Type | Required | $ref syntax | Description |
| source | string | true | yes | Source Salesforce org object|field. Pattern for fields: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z] Pattern for fields: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z](\\.[A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z]){0,4} |
| target | string | true | yes | Target Salesforce org object|field. Pattern for fields: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z] Pattern for fields: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z](\\.[A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z]){0,4} |
| Attribute | Type | Required | $ref syntax | Description |
| alias | string | true | yes | Alias for the authenticated org. Pattern: [0-9A-Za-z_-]{1,40} |
| instanceUrl | string | true | yes | Login URL of the instance the org lives on. Pattern: https://[a-zA-Z0-9][a-zA-Z0-9.-]{1,255}\\.salesforce\\.com/? |
| accessToken | string | true | yes | Active access token. Pattern: 00D[0-9A-Za-z]{12}![0-9A-Za-z_.]{96} |
| Attribute | Type | Required | $ref syntax | Description |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| Attribute | Type | Required | $ref syntax | Description |
| alias | string | true | yes | Alias for the authenticated org. Pattern: [0-9A-Za-z_-]{1,40} |
| sfdxUrlFile | string | true | yes | Path to a file containing the sfdx url |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| apexCodeFile | string | true | yes | Path to a local file that contains Apex code |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| testLevel | enum | true | - | Specifies which tests to run, using one of these TestLevel enum values: - RunSpecifiedTests—Only the tests that you specify are run (not supported yet) - RunLocalTests—All tests in your org are run, except the ones that originate from installed managed packages - RunAllTestsInOrg—All tests are in your org and in installed managed packages are run |
| outputDir | string | true | yes | Directory to store test run files |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| csvFile | string | true | yes | Path to the CSV file that defines the records to delete |
| sObjectType | string | true | - | SObject type of the records you want to delete. Pattern: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z] |
| allowNoMoreFailedBatches | number | false | - | Mark a step as successful if the number of Failed Batches is less than the specified number (default: 0). |
| allowNoMoreFailedRecords | number | false | - | Mark a step as successful if the number of Failed Records is less than the specified number (default: 0). |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| csvFile | string | true | yes | Path to the CSV file that defines the records to upsert |
| externalId | string | true | - | Column name of the external ID. Pattern: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z] |
| sObjectType | string | true | - | SObject type of the records you want to upsert. Pattern: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z] |
| allowNoMoreFailedBatches | number | false | - | Mark a step as successful if the number of Failed Batches is less than the specified number (default: 0). |
| allowNoMoreFailedRecords | number | false | - | Mark a step as successful if the number of Failed Records is less than the specified number (default: 0). |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| csvFile | string | true | yes | Path to the CSV file name to save output data |
| sObjectType | string | true | - | Salesforce object to query data. Pattern: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z] |
| sObjectFields | string[] | true | - | Array of Salesforce object fields to query. Pattern: [A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z](\\.[A-Za-z][0-9A-Za-z_]{0,38}[0-9A-Za-z]){0,4} |
| queryFilter | string | false | - | Query filter for Source org data. Allowed WHERE and LIMIT |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| planFile | string | true | yes | Path to plan to insert multiple data files that have master-detail relationships |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| testLevel | string | true | - | Specifies which tests to run, using one of these TestLevel enum values: - NoTestRun-No one test runs. - RunSpecifiedTests — Only the tests that you specify are run (not supported yet). - RunLocalTests — All tests in your org are run, except the ones that originate from installed managed packages. - RunAllTestsInOrg — All tests are in your org and in installed managed packages are run |
| checkOnly | boolean | false | - | Validate deploy but don’t save to the org |
| deployDir | string | false | yes | Root of directory tree of files to deploy. deployDir or deployZip is required. deployDir will be used if specified both parameters |
| deployZip | string | false | yes | Path to Zip of files to deploy. deployDir or deployZip is required. deployDir will be used if specified both parameters |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| retrieveTargetDir | string | true | yes | Directory for the retrieved metadata |
| manifestFile | string | false | yes | File path of manifest of components to retrieve |
| packageNames | string[] | false | - | List of packages to retrieve |
| Attribute | Type | Required | $ref syntax | Description |
| alias | string | true | yes | Alias for the created org. Pattern: [0-9A-Za-z_-]{1,40} |
| noAncestors | boolean | false | - | Do not include second-generation package ancestors in the scratch org (default: false) |
| definitionFile | string | true | yes | Path to an org definition file |
| devHubUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| duration | number | false | yes | Duration of the scratch org (in days) (default: 1, min:1, max:30) |
| overrideDefinition.adminEmail | string | false | yes | Administrator Email address of the Dev Hub user making the scratch org creation request. |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| devHubUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| packageId | string | true | yes | ID (starts with 04t) or alias of the package version to install. Pattern: 04t([0-9A-Za-z]{12}|[0-9A-Za-z]{15} |
| Attribute | Type | Required | $ref syntax | Description |
| targetUserName | string | true | yes | Username or alias for the target org. Pattern: [0-9A-Za-z_-]{1,40} |
| forceOverwrite | boolean | false | - | Ignore conflict warnings and overwrite changes to scratch org (default: false) |