Promote work items or a pipeline stage to a target pipeline stage.
Description for devops promote
Promote specific work items or all approved work items from a source stage to the target pipeline stage.
Pass --work-item-id to promote one or more specific work items to the target stage.
Pass --stage-id to promote all approved work items from that source stage to the target stage.
Exactly one of --work-item-id or --stage-id must be provided.
Use --deploy-all to deploy all metadata in the branch rather than only changes not yet in the target stage.
Flags
| Flag Name (Long) | Flag Name (Short) | Description |
|---|---|---|
| <code>‑‑api‑version</code> | N/A | Type: Value<br><br>Override the api version used for api requests made by this command |
| <code>‑‑deploy‑all</code> | <code>‑a</code> | Type: Boolean<br><br>Deploy all metadata in the branch to the stage's org.<br><br>If you don’t specify this flag, only changes in the stage’s branch are deployed. |
| <code>‑‑flags‑dir</code> | N/A | Type: Value<br><br>Import flag values from a directory. |
| <code>‑‑json</code> | N/A | Type: Boolean<br><br>Format output as json. |
| <code>‑‑skip‑validation</code> | N/A | Type: Boolean<br><br>Skip pre-promote validation. By default, promotion is validated before proceeding to prevent promoting work items without an associated PR. Use this flag to bypass validation. |
| <code>‑‑stage‑id</code> | <code>‑s</code> | Type: Value<br><br>ID of the source pipeline stage whose approved work items will be promoted. Mutually exclusive with --work-item-id. |
| <code>‑‑target‑org</code> | <code>‑o</code> | Type: Value<br>Required<br><br>Username or alias of the target org. Not required if the target-org configuration variable is already set. |
| <code>‑‑target‑stage‑id</code> | <code>‑t</code> | Type: Value<br>Required<br><br>ID of the pipeline stage to promote to. |
| <code>‑‑test‑level</code> | <code>‑l</code> | Type: Value<br>Valid Values: NoTestRun, RunSpecifiedTests, RunLocalTests, RunAllTestsInOrg<br><br>Deployment Apex testing level.<br><br>Valid values are:<br><br><ul><li>NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.</li><li>RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.</li><li>RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.</li><li>RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.</li></ul><br><br>If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section "Running Tests in a Deployment" in the "Metadata API Developer Guide". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) |
| <code>‑‑tests</code> | N/A | Type: Value<br><br>Apex tests to run when --test-level is RunSpecifiedTests.<br><br>Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces. |
| <code>‑‑work‑item‑id</code> | <code>‑i</code> | Type: Value<br><br>ID of the work item to promote. Mutually exclusive with --stage-id.<br><br>Specify this flag multiple times to promote multiple work items in a single operation. |
Examples for devops promote
Promote all approved work items from a source stage to a target stage:
sf devops promote --target-org my-devops-org --stage-id 1QVxx0000000001 --target-stage-id 1QVxx0000000002
Promote a specific work item to a stage:
sf devops promote --target-org my-devops-org --work-item-id 1fkxx0000000001 --target-stage-id 1QVxx0000000001
Promote multiple work items:
sf devops promote --target-org my-devops-org --work-item-id 1fkxx0000000001 --work-item-id 1fkxx0000000002 --target-stage-id 1QVxx0000000001
Promote a stage with full deploy:
sf devops promote --target-org my-devops-org --stage-id 1QVxx0000000001 --target-stage-id 1QVxx0000000002 --deploy-all