project deploy pipeline start (Beta)

Deploy changes from a branch to the pipeline stage’s org.

This feature is a Beta Service. Customers may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

The first time you run any “project deploy pipeline” command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the “org login web” command.

Before you run this command, changes in the pipeline stage’s branch must be merged in the source control repository.

Flag Name (Long)Flag Name (Short)Description
‑‑asyncN/AType: Boolean

Run the command asynchronously.

The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run “sf project deploy pipeline resume”. To check the status of the deployment, run “sf project deploy pipeline report”.
‑‑branch‑name‑bType: Value
Required

Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.
‑‑bundle‑version‑name‑vType: Value

Version name of the bundle.

You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.
‑‑conciseN/AType: Boolean

Show concise output of the command result.
‑‑deploy‑all‑aType: Boolean

Deploy all metadata in the branch to the stage’s org.

If you don’t specify this flag, only changes in the stage’s branch are deployed.
‑‑devops‑center‑project‑name‑pType: Value
Required

Name of the DevOps Center project.
‑‑devops‑center‑username‑cType: Value
Required

Username or alias of the DevOps Center org.
‑‑jsonN/AType: Boolean

Format output as json.
‑‑test‑level‑lType: Value
Valid Values: NoTestRun, RunSpecifiedTests, RunLocalTests, RunAllTestsInOrg

Deployment Apex testing level.

Valid values are:

  • 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.
  • 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.
  • 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.
  • RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.


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)
‑‑tests‑tType: Value

Apex tests to run when –test-level is RunSpecifiedTests.

Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.
‑‑verboseN/AType: Boolean

Show verbose output of the command result.
‑‑wait‑wType: Value
Default value: 33 minutes

Number of minutes to wait for command to complete and display results.

If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run “sf project deploy pipeline report”.

Deploy changes in the Staging branch to the Staging environment (sandbox), if the previous stage is the bundling stage:

Deploy all changes in the main branch to the release environment: