@salesforce/plugin-devops-center 1.2.2 → 1.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -56,6 +56,383 @@ sf plugins
56
56
 
57
57
  <!-- commands -->
58
58
 
59
+ - [`sf project deploy pipeline quick`](#sf-project-deploy-pipeline-quick)
60
+ - [`sf project deploy pipeline report`](#sf-project-deploy-pipeline-report)
61
+ - [`sf project deploy pipeline resume`](#sf-project-deploy-pipeline-resume)
62
+ - [`sf project deploy pipeline start`](#sf-project-deploy-pipeline-start)
63
+ - [`sf project deploy pipeline validate`](#sf-project-deploy-pipeline-validate)
64
+
65
+ ## `sf project deploy pipeline quick`
66
+
67
+ Quickly deploy a validated deployment to an org.
68
+
69
+ ```
70
+ USAGE
71
+ $ sf project deploy pipeline quick -c <value> [--json] [--concise | --verbose] [-w <value> | --async] [-i <value>]
72
+ [-r]
73
+
74
+ FLAGS
75
+ -c, --devops-center-username=<value> (required) Username or alias of the DevOps Center org.
76
+ -i, --job-id=<value> Job ID of the validated deployment to quick deploy.
77
+ -r, --use-most-recent Use the job ID of the most recently validated deployment.
78
+ -w, --wait=<minutes> [default: 33 minutes] Number of minutes to wait for command to complete and
79
+ display results.
80
+ --async Run the command asynchronously.
81
+ --concise Show concise output of the command result.
82
+ --verbose Show verbose output of the command result.
83
+
84
+ GLOBAL FLAGS
85
+ --json Format output as json.
86
+
87
+ DESCRIPTION
88
+ Quickly deploy a validated deployment to an org.
89
+
90
+ Before you run this command, first create a validated deployment with the "sf project deploy pipeline validate"
91
+ command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this
92
+ command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most
93
+ recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have
94
+ succeeded.
95
+
96
+ Executing this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These
97
+ tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the
98
+ deployment to your production org take several hours and you don’t want to risk a failed deploy.
99
+
100
+ This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org.
101
+ This command doesn’t attempt to merge your source with the versions in your org.
102
+
103
+ EXAMPLES
104
+ Run a quick deploy using your default Devops Center org and a job ID:
105
+
106
+ $ sf project deploy pipeline quick --job-id 0Af0x000017yLUFCA2
107
+
108
+ Asynchronously run a quick deploy of the most recently validated deployment using an org with alias "my-prod-org":
109
+
110
+ $ sf project deploy pipeline quick --async --use-most-recent --devops-center-username my-prod-org
111
+
112
+ FLAG DESCRIPTIONS
113
+ -i, --job-id=<value> Job ID of the validated deployment to quick deploy.
114
+
115
+ The job ID is valid for 10 days from when you started the validation.
116
+
117
+ -r, --use-most-recent Use the job ID of the most recently validated deployment.
118
+
119
+ For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most
120
+ recent deployment validation was more than 3 days ago, this flag won't find the job ID.
121
+
122
+ -w, --wait=<minutes> Number of minutes to wait for command to complete and display results.
123
+
124
+ If the command continues to run after the wait period, the CLI returns control of the terminal window to you and
125
+ returns the job ID. To check the status of the operation, run "sf project deploy pipeline report".
126
+
127
+ --async Run the command asynchronously.
128
+
129
+ The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the
130
+ CLI. To resume the deployment, run "sf project deploy pipeline resume". To check the status of the deployment, run
131
+ "sf project deploy pipeline report".
132
+ ```
133
+
134
+ _See code: [src/commands/project/deploy/pipeline/quick.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.2.4/src/commands/project/deploy/pipeline/quick.ts)_
135
+
136
+ ## `sf project deploy pipeline report`
137
+
138
+ Check the status of a pipeline deploy operation.
139
+
140
+ ```
141
+ USAGE
142
+ $ sf project deploy pipeline report -c <value> [--json] [-i <value>] [-r]
143
+
144
+ FLAGS
145
+ -c, --devops-center-username=<value> (required) Username or alias of the DevOps Center org.
146
+ -i, --job-id=<value> Job ID of the pipeline deployment to check the status of.
147
+ -r, --use-most-recent Use the job ID of the most recent deploy operation.
148
+
149
+ GLOBAL FLAGS
150
+ --json Format output as json.
151
+
152
+ DESCRIPTION
153
+ Check the status of a pipeline deploy operation.
154
+
155
+ Run this command by either indicating a job ID or specifying the —use-most-recent flag to use the job ID of the most
156
+ recent deploy operation.
157
+
158
+ EXAMPLES
159
+ Check the status using a job ID:
160
+
161
+ $ sf project deploy pipeline report --devops-center-username MyStagingSandbox --job-id 0Af0x000017yLUFCA2
162
+
163
+ Check the status of the most recent deploy operation:
164
+
165
+ $ sf project deploy pipeline report --devops-center-username MyStagingSandbox --use-most-recent
166
+
167
+ FLAG DESCRIPTIONS
168
+ -i, --job-id=<value> Job ID of the pipeline deployment to check the status of.
169
+
170
+ The job ID is valid for 10 days from when you started the deploy operation.
171
+
172
+ -r, --use-most-recent Use the job ID of the most recent deploy operation.
173
+
174
+ For performance reasons, this flag uses job IDs for deploy operations that started in the past 3 days or fewer. If
175
+ your most recent operation was longer than 3 days ago, this flag won't find the job ID.
176
+ ```
177
+
178
+ _See code: [src/commands/project/deploy/pipeline/report.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.2.4/src/commands/project/deploy/pipeline/report.ts)_
179
+
180
+ ## `sf project deploy pipeline resume`
181
+
182
+ Resume watching a pipeline deploy operation.
183
+
184
+ ```
185
+ USAGE
186
+ $ sf project deploy pipeline resume -c <value> [--json] [-i <value>] [-r] [--concise | --verbose] [-w <value> | ]
187
+
188
+ FLAGS
189
+ -c, --devops-center-username=<value> (required) Username or alias of the DevOps Center org.
190
+ -i, --job-id=<value> Job ID of the pipeline deploy operation you want to resume.
191
+ -r, --use-most-recent Use the job ID of the most recent deploy operation.
192
+ -w, --wait=<minutes> [default: 33 minutes] Number of minutes to wait for command to complete and
193
+ display results.
194
+ --concise Show concise output of the command result.
195
+ --verbose Show verbose output of the command result.
196
+
197
+ GLOBAL FLAGS
198
+ --json Format output as json.
199
+
200
+ DESCRIPTION
201
+ Resume watching a pipeline deploy operation.
202
+
203
+ Use this command to resume watching a pipeline deploy operation if the original command times out or you specified the
204
+ --async flag.
205
+
206
+ Run this command by either indicating a job ID or specifying the --use-most-recent flag to use the job ID of the most
207
+ recent deploy operation.
208
+
209
+ EXAMPLES
210
+ Resume watching a deploy operation using a job ID:
211
+
212
+ $ sf project deploy pipeline resume --job-id 0Af0x000017yLUFCA2
213
+
214
+ Resume watching the most recent deploy operation:
215
+
216
+ $ sf project deploy pipeline resume --use-most-recent
217
+
218
+ FLAG DESCRIPTIONS
219
+ -i, --job-id=<value> Job ID of the pipeline deploy operation you want to resume.
220
+
221
+ These commands return a job ID if they time out or you specified the --async flag:
222
+
223
+ - sf project deploy pipeline start
224
+ - sf project deploy pipeline validate
225
+ - sf project deploy pipeline quick
226
+
227
+ The job ID is valid for 10 days from when you started the deploy operation.
228
+
229
+ -r, --use-most-recent Use the job ID of the most recent deploy operation.
230
+
231
+ For performance reasons, this flag uses job IDs for operations that started in the past 3 days or fewer. If your
232
+ most recent operation was longer than 3 days ago, this flag won't find a job ID.
233
+
234
+ -w, --wait=<minutes> Number of minutes to wait for command to complete and display results.
235
+
236
+ If the command continues to run after the wait period, the CLI returns control of the terminal window to you and
237
+ returns the job ID. To check the status of the operation, run "sf project deploy pipeline report".
238
+ ```
239
+
240
+ _See code: [src/commands/project/deploy/pipeline/resume.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.2.4/src/commands/project/deploy/pipeline/resume.ts)_
241
+
242
+ ## `sf project deploy pipeline start`
243
+
244
+ Deploy changes from a branch to the pipeline stage’s org.
245
+
246
+ ```
247
+ USAGE
248
+ $ sf project deploy pipeline start -b <value> -p <value> -c <value> [--json] [-v <value>] [-a] [-t <value>] [-l
249
+ NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-w <value> | --async] [--concise | --verbose]
250
+
251
+ FLAGS
252
+ -a, --deploy-all Deploy all metadata in the branch to the stage's org.
253
+ -b, --branch-name=<value> (required) Name of the branch in the source control repository that
254
+ corresponds to the pipeline stage that you want to deploy the changes to.
255
+ -c, --devops-center-username=<value> (required) Username or alias of the DevOps Center org.
256
+ -l, --test-level=<option> Deployment Apex testing level.
257
+ <options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
258
+ -p, --devops-center-project-name=<value> (required) Name of the DevOps Center project.
259
+ -t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
260
+ -v, --bundle-version-name=<value> Version name of the bundle.
261
+ -w, --wait=<minutes> [default: 33 minutes] Number of minutes to wait for command to complete and
262
+ display results.
263
+ --async Run the command asynchronously.
264
+ --concise Show concise output of the command result.
265
+ --verbose Show verbose output of the command result.
266
+
267
+ GLOBAL FLAGS
268
+ --json Format output as json.
269
+
270
+ DESCRIPTION
271
+ Deploy changes from a branch to the pipeline stage’s org.
272
+
273
+ Before you run this command, changes in the pipeline stage's branch must be merged in the source control repository.
274
+
275
+ EXAMPLES
276
+ Deploy changes in the Staging branch to the Staging environment (sandbox), if the previous stage is the bundling
277
+ stage:
278
+
279
+ $ sf project deploy pipeline start --devops-center-project-name “Recruiting App” --branch-name staging \
280
+ --devops-center-username MyStagingSandbox --bundle-version-name 1.0
281
+
282
+ Deploy all changes in the main branch to the release environment:
283
+
284
+ $ sf project deploy pipeline start --devops-center-project-name “Recruiting App” --branch-name main \
285
+ --devops-center-username MyReleaseOrg --deploy-all
286
+
287
+ FLAG DESCRIPTIONS
288
+ -a, --deploy-all Deploy all metadata in the branch to the stage's org.
289
+
290
+ If you don’t specify this flag, only changes in the stage’s branch are deployed.
291
+
292
+ -l, --test-level=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment Apex testing level.
293
+
294
+ Valid values are:
295
+
296
+ - NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as
297
+ sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.
298
+
299
+ - RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ
300
+ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75%
301
+ code coverage for each class and trigger in the deployment package. This coverage is computed for each class and
302
+ trigger individually and is different than the overall coverage percentage.
303
+
304
+ - RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked
305
+ packages. This test level is the default for production deployments that include Apex classes or triggers.
306
+
307
+ - RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
308
+
309
+ If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more
310
+ information, see [Running Tests in a
311
+ Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)
312
+ in the "Metadata API Developer Guide".
313
+
314
+ -t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
315
+
316
+ Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains
317
+ spaces.
318
+
319
+ -v, --bundle-version-name=<value> Version name of the bundle.
320
+
321
+ You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the
322
+ bundling stage.
323
+
324
+ -w, --wait=<minutes> Number of minutes to wait for command to complete and display results.
325
+
326
+ If the command continues to run after the wait period, the CLI returns control of the terminal window to you and
327
+ returns the job ID. To check the status of the operation, run "sf project deploy pipeline report".
328
+
329
+ --async Run the command asynchronously.
330
+
331
+ The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the
332
+ CLI. To resume the deployment, run "sf project deploy pipeline resume". To check the status of the deployment, run
333
+ "sf project deploy pipeline report".
334
+ ```
335
+
336
+ _See code: [src/commands/project/deploy/pipeline/start.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.2.4/src/commands/project/deploy/pipeline/start.ts)_
337
+
338
+ ## `sf project deploy pipeline validate`
339
+
340
+ Perform a validate-only deployment from a branch to the pipeline stage’s org.
341
+
342
+ ```
343
+ USAGE
344
+ $ sf project deploy pipeline validate -b <value> -p <value> -c <value> [--json] [-v <value>] [-a] [-t <value>] [-l
345
+ NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-w <value> | --async] [--concise | --verbose]
346
+
347
+ FLAGS
348
+ -a, --deploy-all Deploy all metadata in the branch to the stage's org.
349
+ -b, --branch-name=<value> (required) Name of the branch in the source control repository that
350
+ corresponds to the pipeline stage that you want to deploy the changes to.
351
+ -c, --devops-center-username=<value> (required) Username or alias of the DevOps Center org.
352
+ -l, --test-level=<option> Deployment Apex testing level.
353
+ <options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
354
+ -p, --devops-center-project-name=<value> (required) Name of the DevOps Center project.
355
+ -t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
356
+ -v, --bundle-version-name=<value> Version name of the bundle.
357
+ -w, --wait=<minutes> [default: 33 minutes] Number of minutes to wait for command to complete and
358
+ display results.
359
+ --async Run the command asynchronously.
360
+ --concise Show concise output of the command result.
361
+ --verbose Show verbose output of the command result.
362
+
363
+ GLOBAL FLAGS
364
+ --json Format output as json.
365
+
366
+ DESCRIPTION
367
+ Perform a validate-only deployment from a branch to the pipeline stage’s org.
368
+
369
+ A validation runs Apex tests to verify whether a deployment will succeed without actually deploying the metadata to
370
+ your environment, so you can then quickly deploy the changes later without re-running the tests.
371
+
372
+ EXAMPLES
373
+ Perform a validate-only deployment from the Staging branch to the Staging environment (sandbox):
374
+
375
+ $ sf project deploy pipeline validate --devops-center-project-name “Recruiting App” --branch-name staging \
376
+ --devops-center-username MyStagingSandbox
377
+
378
+ Perform a validate-only deployment of all changes from the main branch to the release environment:
379
+
380
+ $ sf project deploy pipeline validate --devops-center-project-name “Recruiting App” --branch-name main \
381
+ --devops-center-username MyReleaseOrg --deploy-all
382
+
383
+ FLAG DESCRIPTIONS
384
+ -a, --deploy-all Deploy all metadata in the branch to the stage's org.
385
+
386
+ If you don’t specify this flag, only changes in the stage’s branch are deployed.
387
+
388
+ -l, --test-level=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment Apex testing level.
389
+
390
+ Valid values are:
391
+
392
+ - NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as
393
+ sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.
394
+
395
+ - RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ
396
+ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75%
397
+ code coverage for each class and trigger in the deployment package. This coverage is computed for each class and
398
+ trigger individually and is different than the overall coverage percentage.
399
+
400
+ - RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked
401
+ packages. This test level is the default for production deployments that include Apex classes or triggers.
402
+
403
+ - RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
404
+
405
+ If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more
406
+ information, see [Running Tests in a
407
+ Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)
408
+ in the "Metadata API Developer Guide".
409
+
410
+ -t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
411
+
412
+ Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains
413
+ spaces.
414
+
415
+ -v, --bundle-version-name=<value> Version name of the bundle.
416
+
417
+ You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the
418
+ bundling stage.
419
+
420
+ -w, --wait=<minutes> Number of minutes to wait for command to complete and display results.
421
+
422
+ If the command continues to run after the wait period, the CLI returns control of the terminal window to you and
423
+ returns the job ID. To check the status of the operation, run "sf project deploy pipeline report".
424
+
425
+ --async Run the command asynchronously.
426
+
427
+ The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the
428
+ CLI. To resume the deployment, run "sf project deploy pipeline resume". To check the status of the deployment, run
429
+ "sf project deploy pipeline report".
430
+ ```
431
+
432
+ _See code: [src/commands/project/deploy/pipeline/validate.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.2.4/src/commands/project/deploy/pipeline/validate.ts)_
433
+
434
+ <!-- commandsstop -->
435
+
59
436
  - [`sf project deploy pipeline start`](#sf-project-deploy-pipeline-start)
60
437
  - [`sf project deploy pipeline report`](#sf-project-deploy-pipeline-report)
61
438
  - [`sf project deploy pipeline resume`](#sf-project-deploy-pipeline-resume)
@@ -36,7 +36,7 @@ Valid values are:
36
36
 
37
37
  - 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.
38
38
 
39
- - RunSpecifiedTests — Runs only the tests that you specify with the --run-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.
39
+ - 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.
40
40
 
41
41
  - 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.
42
42