| 1 | module.exports = {
|
| 2 | description: 'cancel a source deployment',
|
| 3 | longDescription: 'Cancels an asynchronous source deployment.',
|
| 4 | help: `Use this command to cancel a specified asynchronous source deployment. You can also specify a wait time (in minutes) to check for updates to the canceled deploy status.
|
| 5 |
|
| 6 | To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue to use the CLI.
|
| 7 | To check the status of the job, use force:source:deploy:report.
|
| 8 |
|
| 9 | Examples:
|
| 10 |
|
| 11 | Deploy a directory of files to the org
|
| 12 | $ sfdx force:source:deploy -d <directory>
|
| 13 | Now cancel this deployment and wait two minutes
|
| 14 | $ sfdx force:source:deploy:cancel -w 2
|
| 15 |
|
| 16 | If you have multiple deployments in progress and want to cancel a specific one, specify the job ID
|
| 17 | $ sfdx force:source:deploy:cancel -i <jobid>
|
| 18 | Check the status of the cancel job
|
| 19 | $ sfdx force:source:deploy:report`,
|
| 20 |
|
| 21 | jobId: 'job ID of the deployment you want to cancel; defaults to your most recent CLI deployment if not specified',
|
| 22 | jobIdLong: 'The job ID (requestId) of the deployment you want to cancel. If not specified, the default value is the ID of the most recent source deployment you ran using Salesforce CLI.',
|
| 23 |
|
| 24 | MissingRequiredParameter: 'A required parameter [jobid] is missing.',
|
| 25 | CancelFailed: 'The cancel command failed due to: %s'
|
| 26 | };
|