Creates a scratch org.
It executes the org create scratch command.
In addition to the attributes used by every ant-sf task, this task uses the following attributes:
| Attribute | Command line equivalent | Description | Required |
|---|---|---|---|
| alias | --alias | An alias for the created scratch org. | No |
| clientid | --client-id | Consumer key of the Dev Hub connected app. | No |
| default | --set-default | If true, set the created org as the default org. |
No; defaults to false |
| definitionfile | --definition-file | A scratch org definition file. | No |
| durationdays | --duration-days | Sets the duration of the scratch org, in days. Valid values are from 1-30. | No; defaults to 7 |
| noancestors | --no-ancestors | If true, do not include second-generation package (2GP) ancestors in the scratch org. |
No; defaults to false |
| nonamespace | --no-namespace | If true, creates the scratch org with no namespace. Useful when using a scratch org to test installations of packages with namespaces. |
No; defaults to false |
| notracksource | --no-track-source | If true, creates the scratch org with no source tracking. Useful in CI/CD jobs when you probably don't want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations). |
No; defaults to false |
| orgadminemail | --admin-email | Email address that will be applied to the org's admin user. Overrides the value of the "adminEmail" option in the definition file, if set. | No |
| orgdescription | --description | Description of the scratch org in the Dev Hub. Overrides the value of the "description" option in the definition file, if set. | No |
| orgedition | --edition | Specifies the type of org to create. Acceptable values are:
|
No |
| orgname | --name | Name of the org, such as "Acme Company". Overrides the value of the "orgName" option in the definition file, if set. | No |
| orgrelease | --release |
Release of the scratch org as compared to the Dev Hub release. By default, scratch orgs are on the same release as the Dev Hub. During Salesforce release transition periods, you can override this default behavior and opt in or out of the new release. Acceptable values are:
|
No |
| orgsourceorg | --source-org | 15-character ID of the org whose shape the new scratch org will be based on. Overrides the value of the "sourceOrg" option in the definition file, if set. | No |
| orgusername | --username |
Username of the scratch org admin user. Overrides the value of the "username" option in the definition file, if set. The username must be unique within the entire scratch org and sandbox universe. You must add your own logic to ensure uniqueness. |
No |
| targetdevhub | --target-dev-hub | A username or alias for the target Dev Hub org. | No |
| wait | -w | Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently. | No; defaults to 5 |
Version: 0.0.0-master