Skip to content

Commit 8336a34

Browse files
authored
Merge pull request #359 from salesforcecli/ekapner-doce-cli-help
Update deploy pipeline command descriptions
2 parents 00e124e + 776d3bb commit 8336a34

5 files changed

+11
-1
lines changed

messages/project.deploy.pipeline.quick.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Quickly deploy a validated deployment to an org.
44

55
# description
66

7-
Before you run this command, first create a validated deployment with the "sf project deploy pipeline validate" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.
7+
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.
8+
9+
Before you run this command, create a validated deployment with the "project deploy pipeline validate" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.
810

911
Executing this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.
1012

messages/project.deploy.pipeline.report.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Check the status of a pipeline deploy operation.
44

55
# description
66

7+
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.
8+
79
Run this command by either indicating a job ID or specifying the —use-most-recent flag to use the job ID of the most recent deploy operation.
810

911
# examples

messages/project.deploy.pipeline.resume.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Resume watching a pipeline deploy operation.
44

55
# description
66

7+
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.
8+
79
Use this command to resume watching a pipeline deploy operation if the original command times out or you specified the --async flag.
810

911
Run this command by either indicating a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.

messages/project.deploy.pipeline.start.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Deploy changes from a branch to the pipeline stage’s org.
44

55
# description
66

7+
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.
8+
79
Before you run this command, changes in the pipeline stage's branch must be merged in the source control repository.
810

911
# examples

messages/project.deploy.pipeline.validate.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Perform a validate-only deployment from a branch to the pipeline stage’s org.
44

55
# description
66

7+
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.
8+
79
A validation runs Apex tests to verify whether a deployment will succeed without actually deploying the metadata to your environment, so you can then quickly deploy the changes later without re-running the tests.
810

911
# examples

0 commit comments

Comments
 (0)