@salesforce/plugin-devops-center 1.4.0 → 1.4.1
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 +592 -55
- package/lib/commands/devops/pipeline/{activate.d.ts → get.d.ts} +3 -3
- package/lib/commands/devops/pipeline/get.js +81 -0
- package/lib/commands/devops/pipeline/get.js.map +1 -0
- package/lib/commands/devops/pipeline/list.d.ts +13 -0
- package/lib/commands/devops/pipeline/list.js +58 -0
- package/lib/commands/devops/pipeline/list.js.map +1 -0
- package/lib/commands/devops/pipeline/project/delete.d.ts +15 -0
- package/lib/commands/devops/pipeline/project/delete.js +71 -0
- package/lib/commands/devops/pipeline/project/delete.js.map +1 -0
- package/lib/commands/devops/pipeline/stage/delete.d.ts +15 -0
- package/lib/commands/devops/pipeline/stage/delete.js +69 -0
- package/lib/commands/devops/pipeline/stage/delete.js.map +1 -0
- package/lib/commands/devops/pipeline/update.d.ts +18 -0
- package/lib/commands/devops/pipeline/update.js +126 -0
- package/lib/commands/devops/pipeline/update.js.map +1 -0
- package/lib/commands/devops/project/update.d.ts +17 -0
- package/lib/commands/devops/project/update.js +86 -0
- package/lib/commands/devops/project/update.js.map +1 -0
- package/lib/commands/devops/promote.d.ts +24 -0
- package/lib/commands/devops/promote.js +148 -0
- package/lib/commands/devops/promote.js.map +1 -0
- package/lib/commands/devops/promotion/complete.d.ts +20 -0
- package/lib/commands/devops/promotion/complete.js +112 -0
- package/lib/commands/devops/promotion/complete.js.map +1 -0
- package/lib/commands/devops/request/status.d.ts +14 -0
- package/lib/commands/devops/request/status.js +71 -0
- package/lib/commands/devops/request/status.js.map +1 -0
- package/lib/commands/devops/{pull-request → review}/create.d.ts +1 -1
- package/lib/commands/devops/{pull-request → review}/create.js +3 -3
- package/lib/commands/devops/review/create.js.map +1 -0
- package/lib/commands/devops/stage/environment/add.js +2 -0
- package/lib/commands/devops/stage/environment/add.js.map +1 -1
- package/lib/commands/devops/stage/environment/delete.d.ts +15 -0
- package/lib/commands/devops/{pipeline/activate.js → stage/environment/delete.js} +18 -30
- package/lib/commands/devops/stage/environment/delete.js.map +1 -0
- package/lib/commands/devops/work-item/combine.d.ts +15 -0
- package/lib/commands/devops/work-item/combine.js +109 -0
- package/lib/commands/devops/work-item/combine.js.map +1 -0
- package/lib/commands/devops/work-item/prepare.d.ts +14 -0
- package/lib/commands/devops/work-item/prepare.js +98 -0
- package/lib/commands/devops/work-item/prepare.js.map +1 -0
- package/lib/common/flags/promote/promoteFlags.d.ts +1 -0
- package/lib/common/flags/promote/promoteFlags.js +5 -0
- package/lib/common/flags/promote/promoteFlags.js.map +1 -1
- package/lib/common/outputService/aorOutputService.js +4 -4
- package/lib/common/outputService/aorOutputService.js.map +1 -1
- package/lib/common/outputService/outputUtils.js +1 -2
- package/lib/common/outputService/outputUtils.js.map +1 -1
- package/lib/common/selectors/asyncOperationResultsSelector.js +3 -1
- package/lib/common/selectors/asyncOperationResultsSelector.js.map +1 -1
- package/lib/common/selectors/deployComponentsSelector.js +5 -6
- package/lib/common/selectors/deployComponentsSelector.js.map +1 -1
- package/lib/common/selectors/deployProgressSummarySelector.js +3 -1
- package/lib/common/selectors/deployProgressSummarySelector.js.map +1 -1
- package/lib/common/selectors/deploymentResultsSelector.js +10 -6
- package/lib/common/selectors/deploymentResultsSelector.js.map +1 -1
- package/lib/common/selectors/environmentSelector.js +4 -2
- package/lib/common/selectors/environmentSelector.js.map +1 -1
- package/lib/common/selectors/namedCredentialSelector.js +2 -1
- package/lib/common/selectors/namedCredentialSelector.js.map +1 -1
- package/lib/common/selectors/pipelineStageSelector.js +5 -3
- package/lib/common/selectors/pipelineStageSelector.js.map +1 -1
- package/lib/common/selectors/validateDeploySelector.js +3 -1
- package/lib/common/selectors/validateDeploySelector.js.map +1 -1
- package/lib/common/selectors/workItemSelector.js +4 -1
- package/lib/common/selectors/workItemSelector.js.map +1 -1
- package/lib/utils/activatePipeline.d.ts +13 -4
- package/lib/utils/activatePipeline.js +7 -6
- package/lib/utils/activatePipeline.js.map +1 -1
- package/lib/utils/attachProject.js +2 -0
- package/lib/utils/attachProject.js.map +1 -1
- package/lib/utils/combineWorkItems.d.ts +20 -0
- package/lib/utils/combineWorkItems.js +42 -0
- package/lib/utils/combineWorkItems.js.map +1 -0
- package/lib/utils/createPullRequest.js +2 -1
- package/lib/utils/createPullRequest.js.map +1 -1
- package/lib/utils/deletePipelineStage.d.ts +12 -0
- package/lib/utils/deletePipelineStage.js +41 -0
- package/lib/utils/deletePipelineStage.js.map +1 -0
- package/lib/utils/deleteStageEnvironment.d.ts +8 -0
- package/lib/utils/deleteStageEnvironment.js +33 -0
- package/lib/utils/deleteStageEnvironment.js.map +1 -0
- package/lib/utils/deployStage.d.ts +29 -0
- package/lib/utils/deployStage.js +68 -0
- package/lib/utils/deployStage.js.map +1 -0
- package/lib/utils/detachProject.d.ts +8 -0
- package/lib/utils/detachProject.js +37 -0
- package/lib/utils/detachProject.js.map +1 -0
- package/lib/utils/getPipeline.d.ts +27 -0
- package/lib/utils/getPipeline.js +66 -0
- package/lib/utils/getPipeline.js.map +1 -0
- package/lib/utils/getRequestStatus.d.ts +10 -0
- package/lib/utils/getRequestStatus.js +32 -0
- package/lib/utils/getRequestStatus.js.map +1 -0
- package/lib/utils/listPipelines.d.ts +11 -0
- package/lib/utils/listPipelines.js +20 -0
- package/lib/utils/listPipelines.js.map +1 -0
- package/lib/utils/pipelineUtils.js +3 -0
- package/lib/utils/pipelineUtils.js.map +1 -1
- package/lib/utils/prepareWorkItem.d.ts +25 -0
- package/lib/utils/prepareWorkItem.js +55 -0
- package/lib/utils/prepareWorkItem.js.map +1 -0
- package/lib/utils/promoteStage.d.ts +21 -0
- package/lib/utils/promoteStage.js +46 -0
- package/lib/utils/promoteStage.js.map +1 -0
- package/lib/utils/soqlUtils.d.ts +23 -0
- package/lib/utils/soqlUtils.js +63 -0
- package/lib/utils/soqlUtils.js.map +1 -0
- package/lib/utils/updateProject.d.ts +17 -0
- package/lib/utils/updateProject.js +41 -0
- package/lib/utils/updateProject.js.map +1 -0
- package/lib/utils/updateWorkItem.js +3 -1
- package/lib/utils/updateWorkItem.js.map +1 -1
- package/lib/utils/workItems.js +2 -0
- package/lib/utils/workItems.js.map +1 -1
- package/messages/devops.pipeline.get.md +17 -0
- package/messages/devops.pipeline.list.md +13 -0
- package/messages/devops.pipeline.project.delete.md +25 -0
- package/messages/devops.pipeline.stage.delete.md +25 -0
- package/messages/devops.pipeline.update.md +47 -0
- package/messages/devops.project.update.md +45 -0
- package/messages/devops.promote.md +61 -0
- package/messages/devops.promotion.complete.md +47 -0
- package/messages/devops.request.status.md +21 -0
- package/messages/devops.stage.environment.delete.md +29 -0
- package/messages/devops.work-item.combine.md +39 -0
- package/messages/devops.work-item.prepare.md +27 -0
- package/npm-shrinkwrap.json +37 -174
- package/oclif.lock +1 -1
- package/oclif.manifest.json +997 -63
- package/package.json +20 -8
- package/schemas/devops-pipeline-get.json +98 -0
- package/schemas/devops-pipeline-list.json +38 -0
- package/schemas/devops-pipeline-project-delete.json +25 -0
- package/schemas/devops-pipeline-stage-delete.json +25 -0
- package/schemas/{devops-pipeline-activate.json → devops-pipeline-update.json} +5 -2
- package/schemas/devops-project-update.json +31 -0
- package/schemas/devops-promote.json +28 -0
- package/schemas/devops-promotion-complete.json +34 -0
- package/schemas/devops-request-status.json +31 -0
- package/schemas/devops-stage-environment-delete.json +25 -0
- package/schemas/devops-work__item-combine.json +25 -0
- package/schemas/devops-work__item-prepare.json +25 -0
- package/lib/commands/devops/pipeline/activate.js.map +0 -1
- package/lib/commands/devops/pull-request/create.js.map +0 -1
- package/messages/devops.pipeline.activate.md +0 -29
- /package/messages/{devops.pull-request.create.md → devops.review.create.md} +0 -0
- /package/schemas/{devops-pull__request-create.json → devops-review-create.json} +0 -0
package/README.md
CHANGED
|
@@ -56,17 +56,28 @@ sf plugins
|
|
|
56
56
|
|
|
57
57
|
<!-- commands -->
|
|
58
58
|
|
|
59
|
-
- [`sf devops pipeline activate`](#sf-devops-pipeline-activate)
|
|
60
59
|
- [`sf devops pipeline create`](#sf-devops-pipeline-create)
|
|
60
|
+
- [`sf devops pipeline get`](#sf-devops-pipeline-get)
|
|
61
|
+
- [`sf devops pipeline list`](#sf-devops-pipeline-list)
|
|
61
62
|
- [`sf devops pipeline project add`](#sf-devops-pipeline-project-add)
|
|
63
|
+
- [`sf devops pipeline project delete`](#sf-devops-pipeline-project-delete)
|
|
62
64
|
- [`sf devops pipeline stage add`](#sf-devops-pipeline-stage-add)
|
|
65
|
+
- [`sf devops pipeline stage delete`](#sf-devops-pipeline-stage-delete)
|
|
66
|
+
- [`sf devops pipeline update`](#sf-devops-pipeline-update)
|
|
63
67
|
- [`sf devops project create`](#sf-devops-project-create)
|
|
64
68
|
- [`sf devops project list`](#sf-devops-project-list)
|
|
65
|
-
- [`sf devops
|
|
69
|
+
- [`sf devops project update`](#sf-devops-project-update)
|
|
70
|
+
- [`sf devops promote`](#sf-devops-promote)
|
|
71
|
+
- [`sf devops promotion complete`](#sf-devops-promotion-complete)
|
|
72
|
+
- [`sf devops request status`](#sf-devops-request-status)
|
|
73
|
+
- [`sf devops review create`](#sf-devops-review-create)
|
|
66
74
|
- [`sf devops stage branch add`](#sf-devops-stage-branch-add)
|
|
67
75
|
- [`sf devops stage environment add`](#sf-devops-stage-environment-add)
|
|
76
|
+
- [`sf devops stage environment delete`](#sf-devops-stage-environment-delete)
|
|
77
|
+
- [`sf devops work-item combine`](#sf-devops-work-item-combine)
|
|
68
78
|
- [`sf devops work-item create`](#sf-devops-work-item-create)
|
|
69
79
|
- [`sf devops work-item list`](#sf-devops-work-item-list)
|
|
80
|
+
- [`sf devops work-item prepare`](#sf-devops-work-item-prepare)
|
|
70
81
|
- [`sf devops work-item update`](#sf-devops-work-item-update)
|
|
71
82
|
- [`sf project deploy pipeline quick`](#sf-project-deploy-pipeline-quick)
|
|
72
83
|
- [`sf project deploy pipeline report`](#sf-project-deploy-pipeline-report)
|
|
@@ -74,38 +85,6 @@ sf plugins
|
|
|
74
85
|
- [`sf project deploy pipeline start`](#sf-project-deploy-pipeline-start)
|
|
75
86
|
- [`sf project deploy pipeline validate`](#sf-project-deploy-pipeline-validate)
|
|
76
87
|
|
|
77
|
-
## `sf devops pipeline activate`
|
|
78
|
-
|
|
79
|
-
Activate a DevOps Center pipeline for deployments.
|
|
80
|
-
|
|
81
|
-
```
|
|
82
|
-
USAGE
|
|
83
|
-
$ sf devops pipeline activate -o <value> --pipeline-id <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
84
|
-
|
|
85
|
-
FLAGS
|
|
86
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
87
|
-
configuration variable is already set.
|
|
88
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
89
|
-
--pipeline-id=<value> (required) ID of the pipeline.
|
|
90
|
-
|
|
91
|
-
GLOBAL FLAGS
|
|
92
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
93
|
-
--json Format output as json.
|
|
94
|
-
|
|
95
|
-
DESCRIPTION
|
|
96
|
-
Activate a DevOps Center pipeline for deployments.
|
|
97
|
-
|
|
98
|
-
A pipeline must have at least one stage before you activate it. You can't modify the pipeline stages after you
|
|
99
|
-
activate and promote changes through it.
|
|
100
|
-
|
|
101
|
-
EXAMPLES
|
|
102
|
-
Activate a pipeline using the pipeline ID.
|
|
103
|
-
|
|
104
|
-
$ sf devops pipeline activate --target-org my-devops-org --pipeline-id 0XB000000000001
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
_See code: [src/commands/devops/pipeline/activate.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.0/src/commands/devops/pipeline/activate.ts)_
|
|
108
|
-
|
|
109
88
|
## `sf devops pipeline create`
|
|
110
89
|
|
|
111
90
|
Create a DevOps Center pipeline.
|
|
@@ -166,7 +145,70 @@ EXAMPLES
|
|
|
166
145
|
https://bitbucket.org/myworkspace/myrepo --description "Main CI/CD pipeline for production releases"
|
|
167
146
|
```
|
|
168
147
|
|
|
169
|
-
_See code: [src/commands/devops/pipeline/create.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
148
|
+
_See code: [src/commands/devops/pipeline/create.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/pipeline/create.ts)_
|
|
149
|
+
|
|
150
|
+
## `sf devops pipeline get`
|
|
151
|
+
|
|
152
|
+
Get details of a DevOps Center pipeline including its stages, repositories, and connected projects.
|
|
153
|
+
|
|
154
|
+
```
|
|
155
|
+
USAGE
|
|
156
|
+
$ sf devops pipeline get -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
157
|
+
|
|
158
|
+
FLAGS
|
|
159
|
+
-i, --pipeline-id=<value> (required) ID of the DevOps Center pipeline.
|
|
160
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
161
|
+
configuration variable is already set.
|
|
162
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
163
|
+
|
|
164
|
+
GLOBAL FLAGS
|
|
165
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
166
|
+
--json Format output as json.
|
|
167
|
+
|
|
168
|
+
DESCRIPTION
|
|
169
|
+
Get details of a DevOps Center pipeline including its stages, repositories, and connected projects.
|
|
170
|
+
|
|
171
|
+
Returns full details for a single DevOps Center pipeline: its stages in order, the source code repository and branch
|
|
172
|
+
associated with each stage, and any connected projects.
|
|
173
|
+
|
|
174
|
+
EXAMPLES
|
|
175
|
+
Get details for a specific pipeline:
|
|
176
|
+
|
|
177
|
+
$ sf devops pipeline get --target-org my-devops-org --pipeline-id 0Do000000000001
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
_See code: [src/commands/devops/pipeline/get.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/pipeline/get.ts)_
|
|
181
|
+
|
|
182
|
+
## `sf devops pipeline list`
|
|
183
|
+
|
|
184
|
+
List DevOps Center pipelines with their stages, repositories, and connected projects.
|
|
185
|
+
|
|
186
|
+
```
|
|
187
|
+
USAGE
|
|
188
|
+
$ sf devops pipeline list -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
189
|
+
|
|
190
|
+
FLAGS
|
|
191
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
192
|
+
configuration variable is already set.
|
|
193
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
194
|
+
|
|
195
|
+
GLOBAL FLAGS
|
|
196
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
197
|
+
--json Format output as json.
|
|
198
|
+
|
|
199
|
+
DESCRIPTION
|
|
200
|
+
List DevOps Center pipelines with their stages, repositories, and connected projects.
|
|
201
|
+
|
|
202
|
+
Returns all DevOps Center pipelines in the org, including each pipeline's stages (in order), source code repository
|
|
203
|
+
information per stage, and any connected projects.
|
|
204
|
+
|
|
205
|
+
EXAMPLES
|
|
206
|
+
List all pipelines in the org:
|
|
207
|
+
|
|
208
|
+
$ sf devops pipeline list --target-org my-devops-org
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
_See code: [src/commands/devops/pipeline/list.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/pipeline/list.ts)_
|
|
170
212
|
|
|
171
213
|
## `sf devops pipeline project add`
|
|
172
214
|
|
|
@@ -200,7 +242,41 @@ EXAMPLES
|
|
|
200
242
|
0Hn000000000001
|
|
201
243
|
```
|
|
202
244
|
|
|
203
|
-
_See code: [src/commands/devops/pipeline/project/add.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
245
|
+
_See code: [src/commands/devops/pipeline/project/add.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/pipeline/project/add.ts)_
|
|
246
|
+
|
|
247
|
+
## `sf devops pipeline project delete`
|
|
248
|
+
|
|
249
|
+
Remove a DevOps Center project's connection to a pipeline.
|
|
250
|
+
|
|
251
|
+
```
|
|
252
|
+
USAGE
|
|
253
|
+
$ sf devops pipeline project delete -o <value> --pipeline-id <value> --project-id <value> [--json] [--flags-dir <value>]
|
|
254
|
+
[--api-version <value>]
|
|
255
|
+
|
|
256
|
+
FLAGS
|
|
257
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
258
|
+
configuration variable is already set.
|
|
259
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
260
|
+
--pipeline-id=<value> (required) ID of the pipeline.
|
|
261
|
+
--project-id=<value> (required) ID of the DevOps Center project.
|
|
262
|
+
|
|
263
|
+
GLOBAL FLAGS
|
|
264
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
265
|
+
--json Format output as json.
|
|
266
|
+
|
|
267
|
+
DESCRIPTION
|
|
268
|
+
Remove a DevOps Center project's connection to a pipeline.
|
|
269
|
+
|
|
270
|
+
Deletes the junction record that connects the project to the pipeline. The project itself is not deleted.
|
|
271
|
+
|
|
272
|
+
EXAMPLES
|
|
273
|
+
Remove a project from a pipeline using the project ID and pipeline ID.
|
|
274
|
+
|
|
275
|
+
$ sf devops pipeline project delete --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id \
|
|
276
|
+
0Hn000000000001
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
_See code: [src/commands/devops/pipeline/project/delete.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/pipeline/project/delete.ts)_
|
|
204
280
|
|
|
205
281
|
## `sf devops pipeline stage add`
|
|
206
282
|
|
|
@@ -241,7 +317,85 @@ EXAMPLES
|
|
|
241
317
|
--next-stage-id 0Xc000000000003
|
|
242
318
|
```
|
|
243
319
|
|
|
244
|
-
_See code: [src/commands/devops/pipeline/stage/add.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
320
|
+
_See code: [src/commands/devops/pipeline/stage/add.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/pipeline/stage/add.ts)_
|
|
321
|
+
|
|
322
|
+
## `sf devops pipeline stage delete`
|
|
323
|
+
|
|
324
|
+
Delete a stage from a DevOps Center pipeline.
|
|
325
|
+
|
|
326
|
+
```
|
|
327
|
+
USAGE
|
|
328
|
+
$ sf devops pipeline stage delete -o <value> --pipeline-id <value> --stage-id <value> [--json] [--flags-dir <value>]
|
|
329
|
+
[--api-version <value>]
|
|
330
|
+
|
|
331
|
+
FLAGS
|
|
332
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
333
|
+
configuration variable is already set.
|
|
334
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
335
|
+
--pipeline-id=<value> (required) ID of the pipeline that contains the stage.
|
|
336
|
+
--stage-id=<value> (required) ID of the stage to delete.
|
|
337
|
+
|
|
338
|
+
GLOBAL FLAGS
|
|
339
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
340
|
+
--json Format output as json.
|
|
341
|
+
|
|
342
|
+
DESCRIPTION
|
|
343
|
+
Delete a stage from a DevOps Center pipeline.
|
|
344
|
+
|
|
345
|
+
Deletes the specified stage from the pipeline. If the stage sits between two other stages, the predecessor stage is
|
|
346
|
+
automatically re-linked to the successor so the pipeline chain stays intact.
|
|
347
|
+
|
|
348
|
+
EXAMPLES
|
|
349
|
+
Delete a stage from a pipeline:
|
|
350
|
+
|
|
351
|
+
$ sf devops pipeline stage delete --target-org my-devops-org --pipeline-id 0XB000000000001 --stage-id \
|
|
352
|
+
0Xc000000000002
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
_See code: [src/commands/devops/pipeline/stage/delete.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/pipeline/stage/delete.ts)_
|
|
356
|
+
|
|
357
|
+
## `sf devops pipeline update`
|
|
358
|
+
|
|
359
|
+
Update a DevOps Center pipeline.
|
|
360
|
+
|
|
361
|
+
```
|
|
362
|
+
USAGE
|
|
363
|
+
$ sf devops pipeline update -o <value> --pipeline-id <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
364
|
+
[--active] [-n <value>]
|
|
365
|
+
|
|
366
|
+
FLAGS
|
|
367
|
+
-n, --name=<value> New name for the pipeline.
|
|
368
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
369
|
+
configuration variable is already set.
|
|
370
|
+
--[no-]active Activate the pipeline. Use --no-active to deactivate.
|
|
371
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
372
|
+
--pipeline-id=<value> (required) ID of the pipeline.
|
|
373
|
+
|
|
374
|
+
GLOBAL FLAGS
|
|
375
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
376
|
+
--json Format output as json.
|
|
377
|
+
|
|
378
|
+
DESCRIPTION
|
|
379
|
+
Update a DevOps Center pipeline.
|
|
380
|
+
|
|
381
|
+
Activate, deactivate, or rename a DevOps Center pipeline. Use --active to activate, --no-active to deactivate, and
|
|
382
|
+
--name to rename. You can combine --no-active and --name in one command.
|
|
383
|
+
|
|
384
|
+
A pipeline must have at least one stage before you can activate it. You can't modify the pipeline stages after you
|
|
385
|
+
activate and promote changes through it.
|
|
386
|
+
|
|
387
|
+
EXAMPLES
|
|
388
|
+
Activate a pipeline:
|
|
389
|
+
|
|
390
|
+
$ sf devops pipeline update --target-org my-devops-org --pipeline-id 0XB000000000001 --active
|
|
391
|
+
|
|
392
|
+
Deactivate and rename in one step.
|
|
393
|
+
|
|
394
|
+
$ sf devops pipeline update --target-org my-devops-org --pipeline-id 0XB000000000001 --no-active --name "My \
|
|
395
|
+
Pipeline"
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
_See code: [src/commands/devops/pipeline/update.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/pipeline/update.ts)_
|
|
245
399
|
|
|
246
400
|
## `sf devops project create`
|
|
247
401
|
|
|
@@ -278,7 +432,7 @@ EXAMPLES
|
|
|
278
432
|
update"
|
|
279
433
|
```
|
|
280
434
|
|
|
281
|
-
_See code: [src/commands/devops/project/create.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
435
|
+
_See code: [src/commands/devops/project/create.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/project/create.ts)_
|
|
282
436
|
|
|
283
437
|
## `sf devops project list`
|
|
284
438
|
|
|
@@ -313,16 +467,275 @@ EXAMPLES
|
|
|
313
467
|
$ sf devops project list --target-org devops-center@example.com
|
|
314
468
|
```
|
|
315
469
|
|
|
316
|
-
_See code: [src/commands/devops/project/list.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
470
|
+
_See code: [src/commands/devops/project/list.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/project/list.ts)_
|
|
471
|
+
|
|
472
|
+
## `sf devops project update`
|
|
473
|
+
|
|
474
|
+
Update a DevOps Center project.
|
|
475
|
+
|
|
476
|
+
```
|
|
477
|
+
USAGE
|
|
478
|
+
$ sf devops project update -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>] [-d
|
|
479
|
+
<value>] [--is-active]
|
|
480
|
+
|
|
481
|
+
FLAGS
|
|
482
|
+
-d, --description=<value> New description for the project.
|
|
483
|
+
-i, --project-id=<value> (required) ID of the DevOps Center project to update.
|
|
484
|
+
-n, --name=<value> New name for the project.
|
|
485
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
486
|
+
configuration variable is already set.
|
|
487
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
488
|
+
--[no-]is-active Set the project active status. Use --is-active to activate or --no-is-active to deactivate.
|
|
489
|
+
|
|
490
|
+
GLOBAL FLAGS
|
|
491
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
492
|
+
--json Format output as json.
|
|
493
|
+
|
|
494
|
+
DESCRIPTION
|
|
495
|
+
Update a DevOps Center project.
|
|
496
|
+
|
|
497
|
+
Update the name, description, or active status of a DevOps Center project. At least one of --name, --description, or
|
|
498
|
+
--is-active must be provided.
|
|
499
|
+
|
|
500
|
+
EXAMPLES
|
|
501
|
+
Rename a project:
|
|
502
|
+
|
|
503
|
+
$ sf devops project update --target-org my-devops-org --project-id 1Qg000000000001 --name "MyApp Release v2"
|
|
504
|
+
|
|
505
|
+
Update the description of a project:
|
|
506
|
+
|
|
507
|
+
$ sf devops project update --target-org my-devops-org --project-id 1Qg000000000001 --description "Updated \
|
|
508
|
+
release description"
|
|
509
|
+
|
|
510
|
+
Deactivate a project:
|
|
511
|
+
|
|
512
|
+
$ sf devops project update --target-org my-devops-org --project-id 1Qg000000000001 --no-is-active
|
|
513
|
+
|
|
514
|
+
Update all fields at once:
|
|
515
|
+
|
|
516
|
+
$ sf devops project update --target-org my-devops-org --project-id 1Qg000000000001 --name "Archived App" \
|
|
517
|
+
--description "Archived" --no-is-active
|
|
518
|
+
```
|
|
519
|
+
|
|
520
|
+
_See code: [src/commands/devops/project/update.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/project/update.ts)_
|
|
521
|
+
|
|
522
|
+
## `sf devops promote`
|
|
523
|
+
|
|
524
|
+
Promote work items or a pipeline stage to a target pipeline stage.
|
|
525
|
+
|
|
526
|
+
```
|
|
527
|
+
USAGE
|
|
528
|
+
$ sf devops promote -o <value> -t <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>... |
|
|
529
|
+
-s <value>] [-a] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--tests <value>...]
|
|
530
|
+
|
|
531
|
+
FLAGS
|
|
532
|
+
-a, --deploy-all Deploy all metadata in the branch to the stage's org.
|
|
533
|
+
-i, --work-item-id=<value>... ID of the work item to promote. Mutually exclusive with --stage-id.
|
|
534
|
+
-l, --test-level=<option> Deployment Apex testing level.
|
|
535
|
+
<options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
|
|
536
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
537
|
+
configuration variable is already set.
|
|
538
|
+
-s, --stage-id=<value> ID of the source pipeline stage whose approved work items will be promoted. Mutually
|
|
539
|
+
exclusive with --work-item-id.
|
|
540
|
+
-t, --target-stage-id=<value> (required) ID of the pipeline stage to promote to.
|
|
541
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
542
|
+
--tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
|
|
543
|
+
|
|
544
|
+
GLOBAL FLAGS
|
|
545
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
546
|
+
--json Format output as json.
|
|
547
|
+
|
|
548
|
+
DESCRIPTION
|
|
549
|
+
Promote work items or a pipeline stage to a target pipeline stage.
|
|
550
|
+
|
|
551
|
+
Promote specific work items or all approved work items from a source stage to the target pipeline stage.
|
|
552
|
+
|
|
553
|
+
Pass --work-item-id to promote one or more specific work items to the target stage.
|
|
554
|
+
|
|
555
|
+
Pass --stage-id to promote all approved work items from that source stage to the target stage.
|
|
317
556
|
|
|
318
|
-
|
|
557
|
+
Exactly one of --work-item-id or --stage-id must be provided.
|
|
558
|
+
|
|
559
|
+
Use --deploy-all to deploy all metadata in the branch rather than only changes not yet in the target stage.
|
|
560
|
+
|
|
561
|
+
EXAMPLES
|
|
562
|
+
Promote all approved work items from a source stage to a target stage:
|
|
563
|
+
|
|
564
|
+
$ sf devops promote --target-org my-devops-org --stage-id 1QVxx0000000001 --target-stage-id 1QVxx0000000002
|
|
565
|
+
|
|
566
|
+
Promote a specific work item to a stage:
|
|
567
|
+
|
|
568
|
+
$ sf devops promote --target-org my-devops-org --work-item-id 1fkxx0000000001 --target-stage-id 1QVxx0000000001
|
|
569
|
+
|
|
570
|
+
Promote multiple work items:
|
|
571
|
+
|
|
572
|
+
$ sf devops promote --target-org my-devops-org --work-item-id 1fkxx0000000001 --work-item-id 1fkxx0000000002 \
|
|
573
|
+
--target-stage-id 1QVxx0000000001
|
|
574
|
+
|
|
575
|
+
Promote a stage with full deploy:
|
|
576
|
+
|
|
577
|
+
$ sf devops promote --target-org my-devops-org --stage-id 1QVxx0000000001 --target-stage-id 1QVxx0000000002 \
|
|
578
|
+
--deploy-all
|
|
579
|
+
|
|
580
|
+
FLAG DESCRIPTIONS
|
|
581
|
+
-a, --deploy-all Deploy all metadata in the branch to the stage's org.
|
|
582
|
+
|
|
583
|
+
If you don’t specify this flag, only changes in the stage’s branch are deployed.
|
|
584
|
+
|
|
585
|
+
-i, --work-item-id=<value>... ID of the work item to promote. Mutually exclusive with --stage-id.
|
|
586
|
+
|
|
587
|
+
Specify this flag multiple times to promote multiple work items in a single operation.
|
|
588
|
+
|
|
589
|
+
-l, --test-level=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment Apex testing level.
|
|
590
|
+
|
|
591
|
+
Valid values are:
|
|
592
|
+
|
|
593
|
+
- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as
|
|
594
|
+
sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.
|
|
595
|
+
|
|
596
|
+
- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ
|
|
597
|
+
from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75%
|
|
598
|
+
code coverage for each class and trigger in the deployment package. This coverage is computed for each class and
|
|
599
|
+
trigger individually and is different than the overall coverage percentage.
|
|
600
|
+
|
|
601
|
+
- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked
|
|
602
|
+
packages. This test level is the default for production deployments that include Apex classes or triggers.
|
|
603
|
+
|
|
604
|
+
- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
|
|
605
|
+
|
|
606
|
+
If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more
|
|
607
|
+
information, see the section "Running Tests in a Deployment" in the "Metadata API Developer Guide".
|
|
608
|
+
(https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)
|
|
609
|
+
|
|
610
|
+
--tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
|
|
611
|
+
|
|
612
|
+
Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains
|
|
613
|
+
spaces.
|
|
614
|
+
```
|
|
615
|
+
|
|
616
|
+
_See code: [src/commands/devops/promote.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/promote.ts)_
|
|
617
|
+
|
|
618
|
+
## `sf devops promotion complete`
|
|
619
|
+
|
|
620
|
+
Deploy undeployed work items to a pipeline stage org.
|
|
621
|
+
|
|
622
|
+
```
|
|
623
|
+
USAGE
|
|
624
|
+
$ sf devops promotion complete -o <value> -t <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>...]
|
|
625
|
+
[-a] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--tests <value>...]
|
|
626
|
+
|
|
627
|
+
FLAGS
|
|
628
|
+
-a, --deploy-all Deploy all metadata in the branch to the stage's org.
|
|
629
|
+
-i, --work-item-id=<value>... ID of a specific work item to deploy. Omit to deploy all undeployed work items for the
|
|
630
|
+
stage. Use this for the first stage of a pipeline where no source stage exists.
|
|
631
|
+
-l, --test-level=<option> Deployment Apex testing level.
|
|
632
|
+
<options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
|
|
633
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
634
|
+
configuration variable is already set.
|
|
635
|
+
-t, --target-stage-id=<value> (required) ID of the out-of-sync pipeline stage to deploy to.
|
|
636
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
637
|
+
--tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
|
|
638
|
+
|
|
639
|
+
GLOBAL FLAGS
|
|
640
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
641
|
+
--json Format output as json.
|
|
642
|
+
|
|
643
|
+
DESCRIPTION
|
|
644
|
+
Deploy undeployed work items to a pipeline stage org.
|
|
645
|
+
|
|
646
|
+
Deploys work items that were merged into the pipeline branch outside of DevOps Center (externally merged) into the
|
|
647
|
+
target stage org and updates DevOps Center records. Equivalent to the "Complete Promotion" action in the DevOps Center
|
|
648
|
+
UI when a stage is out of sync.
|
|
649
|
+
|
|
650
|
+
If no undeployed work items are found for the stage, the command exits successfully with no action taken.
|
|
651
|
+
|
|
652
|
+
EXAMPLES
|
|
653
|
+
Complete a promotion for an out-of-sync pipeline stage.
|
|
654
|
+
|
|
655
|
+
$ sf devops promotion complete --target-org my-devops-org --target-stage-id 1QV000000000001
|
|
656
|
+
|
|
657
|
+
Complete a promotion for a specific work item (e.g. first stage of a pipeline).
|
|
658
|
+
|
|
659
|
+
$ sf devops promotion complete --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id \
|
|
660
|
+
1fk000000000001
|
|
661
|
+
|
|
662
|
+
Complete a promotion with full deploy and a specific test level.
|
|
663
|
+
|
|
664
|
+
$ sf devops promotion complete --target-org my-devops-org --target-stage-id 1QV000000000001 --deploy-all \
|
|
665
|
+
--test-level RunLocalTests
|
|
666
|
+
|
|
667
|
+
FLAG DESCRIPTIONS
|
|
668
|
+
-a, --deploy-all Deploy all metadata in the branch to the stage's org.
|
|
669
|
+
|
|
670
|
+
If you don’t specify this flag, only changes in the stage’s branch are deployed.
|
|
671
|
+
|
|
672
|
+
-l, --test-level=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment Apex testing level.
|
|
673
|
+
|
|
674
|
+
Valid values are:
|
|
675
|
+
|
|
676
|
+
- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as
|
|
677
|
+
sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.
|
|
678
|
+
|
|
679
|
+
- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ
|
|
680
|
+
from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75%
|
|
681
|
+
code coverage for each class and trigger in the deployment package. This coverage is computed for each class and
|
|
682
|
+
trigger individually and is different than the overall coverage percentage.
|
|
683
|
+
|
|
684
|
+
- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked
|
|
685
|
+
packages. This test level is the default for production deployments that include Apex classes or triggers.
|
|
686
|
+
|
|
687
|
+
- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
|
|
688
|
+
|
|
689
|
+
If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more
|
|
690
|
+
information, see the section "Running Tests in a Deployment" in the "Metadata API Developer Guide".
|
|
691
|
+
(https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)
|
|
692
|
+
|
|
693
|
+
--tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
|
|
694
|
+
|
|
695
|
+
Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains
|
|
696
|
+
spaces.
|
|
697
|
+
```
|
|
698
|
+
|
|
699
|
+
_See code: [src/commands/devops/promotion/complete.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/promotion/complete.ts)_
|
|
700
|
+
|
|
701
|
+
## `sf devops request status`
|
|
702
|
+
|
|
703
|
+
Get the status of a request.
|
|
704
|
+
|
|
705
|
+
```
|
|
706
|
+
USAGE
|
|
707
|
+
$ sf devops request status -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
708
|
+
|
|
709
|
+
FLAGS
|
|
710
|
+
-i, --request-token=<value> (required) Request token from the promote response.
|
|
711
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
712
|
+
configuration variable is already set.
|
|
713
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
714
|
+
|
|
715
|
+
GLOBAL FLAGS
|
|
716
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
717
|
+
--json Format output as json.
|
|
718
|
+
|
|
719
|
+
DESCRIPTION
|
|
720
|
+
Get the status of a request.
|
|
721
|
+
|
|
722
|
+
Returns the current status of a request identified by its request token.
|
|
723
|
+
|
|
724
|
+
EXAMPLES
|
|
725
|
+
Get the status of a request:
|
|
726
|
+
|
|
727
|
+
$ sf devops request status --target-org my-devops-org --request-token a0B000000000001
|
|
728
|
+
```
|
|
729
|
+
|
|
730
|
+
_See code: [src/commands/devops/request/status.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/request/status.ts)_
|
|
731
|
+
|
|
732
|
+
## `sf devops review create`
|
|
319
733
|
|
|
320
734
|
Create a pull request for a work item branch.
|
|
321
735
|
|
|
322
736
|
```
|
|
323
737
|
USAGE
|
|
324
|
-
$ sf devops
|
|
325
|
-
<value>]
|
|
738
|
+
$ sf devops review create -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>] [-w <value>]
|
|
326
739
|
|
|
327
740
|
FLAGS
|
|
328
741
|
-n, --work-item-name=<value> Name of the work item, such as WI-000001.
|
|
@@ -344,14 +757,14 @@ DESCRIPTION
|
|
|
344
757
|
EXAMPLES
|
|
345
758
|
Create a pull request for a work item.
|
|
346
759
|
|
|
347
|
-
$ sf devops
|
|
760
|
+
$ sf devops review create --target-org my-devops-org --work-item-name WI-000001
|
|
348
761
|
|
|
349
762
|
Create a pull request using the work item ID.
|
|
350
763
|
|
|
351
|
-
$ sf devops
|
|
764
|
+
$ sf devops review create --target-org my-devops-org --work-item-id 0Wx000000000001
|
|
352
765
|
```
|
|
353
766
|
|
|
354
|
-
_See code: [src/commands/devops/
|
|
767
|
+
_See code: [src/commands/devops/review/create.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/review/create.ts)_
|
|
355
768
|
|
|
356
769
|
## `sf devops stage branch add`
|
|
357
770
|
|
|
@@ -394,7 +807,7 @@ EXAMPLES
|
|
|
394
807
|
--branch-name integration --create-vcs-branch
|
|
395
808
|
```
|
|
396
809
|
|
|
397
|
-
_See code: [src/commands/devops/stage/branch/add.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
810
|
+
_See code: [src/commands/devops/stage/branch/add.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/stage/branch/add.ts)_
|
|
398
811
|
|
|
399
812
|
## `sf devops stage environment add`
|
|
400
813
|
|
|
@@ -434,7 +847,90 @@ EXAMPLES
|
|
|
434
847
|
Production_Org --org-type Production
|
|
435
848
|
```
|
|
436
849
|
|
|
437
|
-
_See code: [src/commands/devops/stage/environment/add.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
850
|
+
_See code: [src/commands/devops/stage/environment/add.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/stage/environment/add.ts)_
|
|
851
|
+
|
|
852
|
+
## `sf devops stage environment delete`
|
|
853
|
+
|
|
854
|
+
Delete an environment from a DevOps Center pipeline stage.
|
|
855
|
+
|
|
856
|
+
```
|
|
857
|
+
USAGE
|
|
858
|
+
$ sf devops stage environment delete -o <value> --pipeline-id <value> -e <value> [--json] [--flags-dir <value>] [--api-version
|
|
859
|
+
<value>]
|
|
860
|
+
|
|
861
|
+
FLAGS
|
|
862
|
+
-e, --environment-id=<value> (required) ID of the environment to delete.
|
|
863
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
864
|
+
configuration variable is already set.
|
|
865
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
866
|
+
--pipeline-id=<value> (required) ID of the pipeline. Used to verify the pipeline is inactive before deleting.
|
|
867
|
+
|
|
868
|
+
GLOBAL FLAGS
|
|
869
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
870
|
+
--json Format output as json.
|
|
871
|
+
|
|
872
|
+
DESCRIPTION
|
|
873
|
+
Delete an environment from a DevOps Center pipeline stage.
|
|
874
|
+
|
|
875
|
+
Removes the specified environment from the pipeline stage. The environment must belong to an inactive pipeline.
|
|
876
|
+
|
|
877
|
+
EXAMPLES
|
|
878
|
+
Delete an environment:
|
|
879
|
+
|
|
880
|
+
$ sf devops stage environment delete --target-org my-devops-org --pipeline-id 0XB000000000001 --environment-id \
|
|
881
|
+
0Xe000000000001
|
|
882
|
+
```
|
|
883
|
+
|
|
884
|
+
_See code: [src/commands/devops/stage/environment/delete.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/stage/environment/delete.ts)_
|
|
885
|
+
|
|
886
|
+
## `sf devops work-item combine`
|
|
887
|
+
|
|
888
|
+
Prepare work items to be combined for custom promotion.
|
|
889
|
+
|
|
890
|
+
```
|
|
891
|
+
USAGE
|
|
892
|
+
$ sf devops work-item combine -o <value> --parent-work-item-id <value> --child-work-item-id <value>... -t <value> [--json]
|
|
893
|
+
[--flags-dir <value>] [--api-version <value>]
|
|
894
|
+
|
|
895
|
+
FLAGS
|
|
896
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
897
|
+
configuration variable is already set.
|
|
898
|
+
-t, --target-stage-id=<value> (required) ID of the pipeline stage to promote the combined work item to.
|
|
899
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
900
|
+
--child-work-item-id=<value>... (required) ID of a work item to combine.
|
|
901
|
+
--parent-work-item-id=<value> (required) ID of the parent work item.
|
|
902
|
+
|
|
903
|
+
GLOBAL FLAGS
|
|
904
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
905
|
+
--json Format output as json.
|
|
906
|
+
|
|
907
|
+
DESCRIPTION
|
|
908
|
+
Prepare work items to be combined for custom promotion.
|
|
909
|
+
|
|
910
|
+
Use this command when work items in the same stage share metadata or have dependencies. DevOps Center combines the
|
|
911
|
+
selected work items so they can be promoted together during custom promotion.
|
|
912
|
+
|
|
913
|
+
After running this command, use "sf devops work-item promote" with the parent work item ID to complete the promotion.
|
|
914
|
+
The combined work items are promoted as a single unit.
|
|
915
|
+
|
|
916
|
+
EXAMPLES
|
|
917
|
+
Prepare three work items to be combined to prevent conflicts during promotion:
|
|
918
|
+
|
|
919
|
+
$ sf devops work-item combine --target-org my-devops-org --parent-work-item-id 0Wx000000000001 \
|
|
920
|
+
--child-work-item-id 0Wx000000000002 --child-work-item-id 0Wx000000000003 --target-stage-id 05S000000000002
|
|
921
|
+
|
|
922
|
+
FLAG DESCRIPTIONS
|
|
923
|
+
--child-work-item-id=<value>... ID of a work item to combine.
|
|
924
|
+
|
|
925
|
+
Specify this flag multiple times to combine multiple work items with the parent.
|
|
926
|
+
|
|
927
|
+
--parent-work-item-id=<value> ID of the parent work item.
|
|
928
|
+
|
|
929
|
+
The parent work item is the primary work item that continues through the pipeline. Changes from all child work items
|
|
930
|
+
are merged into the parent's branch during promotion.
|
|
931
|
+
```
|
|
932
|
+
|
|
933
|
+
_See code: [src/commands/devops/work-item/combine.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/work-item/combine.ts)_
|
|
438
934
|
|
|
439
935
|
## `sf devops work-item create`
|
|
440
936
|
|
|
@@ -475,7 +971,7 @@ EXAMPLES
|
|
|
475
971
|
--description "Implement dark mode toggle in settings page"
|
|
476
972
|
```
|
|
477
973
|
|
|
478
|
-
_See code: [src/commands/devops/work-item/create.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
974
|
+
_See code: [src/commands/devops/work-item/create.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/work-item/create.ts)_
|
|
479
975
|
|
|
480
976
|
## `sf devops work-item list`
|
|
481
977
|
|
|
@@ -511,7 +1007,48 @@ EXAMPLES
|
|
|
511
1007
|
$ sf devops work-item list --target-org my-devops-org --project-id 1Qg000000000001 --json
|
|
512
1008
|
```
|
|
513
1009
|
|
|
514
|
-
_See code: [src/commands/devops/work-item/list.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
1010
|
+
_See code: [src/commands/devops/work-item/list.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/work-item/list.ts)_
|
|
1011
|
+
|
|
1012
|
+
## `sf devops work-item prepare`
|
|
1013
|
+
|
|
1014
|
+
Prepare a work item for one-off promotion between pipeline stages.
|
|
1015
|
+
|
|
1016
|
+
```
|
|
1017
|
+
USAGE
|
|
1018
|
+
$ sf devops work-item prepare -o <value> -i <value> -t <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
1019
|
+
|
|
1020
|
+
FLAGS
|
|
1021
|
+
-i, --work-item-id=<value> (required) ID of the work item to prepare for one-off promotion.
|
|
1022
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1023
|
+
configuration variable is already set.
|
|
1024
|
+
-t, --target-stage-id=<value> (required) ID of the pipeline stage to promote the work item to.
|
|
1025
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1026
|
+
|
|
1027
|
+
GLOBAL FLAGS
|
|
1028
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1029
|
+
--json Format output as json.
|
|
1030
|
+
|
|
1031
|
+
DESCRIPTION
|
|
1032
|
+
Prepare a work item for one-off promotion between pipeline stages.
|
|
1033
|
+
|
|
1034
|
+
Prepares a work item for one-off promotion by creating the necessary branches and pull requests in the source control
|
|
1035
|
+
repository. Run this command before running "sf devops work-item promote" for a one-off promotion.
|
|
1036
|
+
|
|
1037
|
+
Use "sf devops work-item list" to find the work item ID and target stage ID for a project.
|
|
1038
|
+
|
|
1039
|
+
EXAMPLES
|
|
1040
|
+
Prepare a work item for one-off promotion to the UAT stage:
|
|
1041
|
+
|
|
1042
|
+
$ sf devops work-item prepare --target-org my-devops-org --work-item-id 0Wx000000000001 --target-stage-id \
|
|
1043
|
+
05S000000000002
|
|
1044
|
+
|
|
1045
|
+
Prepare a work item using a DevOps Center org username:
|
|
1046
|
+
|
|
1047
|
+
$ sf devops work-item prepare --target-org devops-center@example.com --work-item-id 0Wx000000000001 \
|
|
1048
|
+
--target-stage-id 05S000000000002
|
|
1049
|
+
```
|
|
1050
|
+
|
|
1051
|
+
_See code: [src/commands/devops/work-item/prepare.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/work-item/prepare.ts)_
|
|
515
1052
|
|
|
516
1053
|
## `sf devops work-item update`
|
|
517
1054
|
|
|
@@ -558,7 +1095,7 @@ EXAMPLES
|
|
|
558
1095
|
--description "Users can't log in on mobile" --status "In Progress"
|
|
559
1096
|
```
|
|
560
1097
|
|
|
561
|
-
_See code: [src/commands/devops/work-item/update.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
1098
|
+
_See code: [src/commands/devops/work-item/update.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/devops/work-item/update.ts)_
|
|
562
1099
|
|
|
563
1100
|
## `sf project deploy pipeline quick`
|
|
564
1101
|
|
|
@@ -632,7 +1169,7 @@ FLAG DESCRIPTIONS
|
|
|
632
1169
|
"sf project deploy pipeline report".
|
|
633
1170
|
```
|
|
634
1171
|
|
|
635
|
-
_See code: [src/commands/project/deploy/pipeline/quick.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
1172
|
+
_See code: [src/commands/project/deploy/pipeline/quick.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/project/deploy/pipeline/quick.ts)_
|
|
636
1173
|
|
|
637
1174
|
## `sf project deploy pipeline report`
|
|
638
1175
|
|
|
@@ -680,7 +1217,7 @@ FLAG DESCRIPTIONS
|
|
|
680
1217
|
your most recent operation was longer than 3 days ago, this flag won't find the job ID.
|
|
681
1218
|
```
|
|
682
1219
|
|
|
683
|
-
_See code: [src/commands/project/deploy/pipeline/report.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
1220
|
+
_See code: [src/commands/project/deploy/pipeline/report.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/project/deploy/pipeline/report.ts)_
|
|
684
1221
|
|
|
685
1222
|
## `sf project deploy pipeline resume`
|
|
686
1223
|
|
|
@@ -747,7 +1284,7 @@ FLAG DESCRIPTIONS
|
|
|
747
1284
|
returns the job ID. To check the status of the operation, run "sf project deploy pipeline report".
|
|
748
1285
|
```
|
|
749
1286
|
|
|
750
|
-
_See code: [src/commands/project/deploy/pipeline/resume.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
1287
|
+
_See code: [src/commands/project/deploy/pipeline/resume.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/project/deploy/pipeline/resume.ts)_
|
|
751
1288
|
|
|
752
1289
|
## `sf project deploy pipeline start`
|
|
753
1290
|
|
|
@@ -847,7 +1384,7 @@ FLAG DESCRIPTIONS
|
|
|
847
1384
|
"sf project deploy pipeline report".
|
|
848
1385
|
```
|
|
849
1386
|
|
|
850
|
-
_See code: [src/commands/project/deploy/pipeline/start.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
1387
|
+
_See code: [src/commands/project/deploy/pipeline/start.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/project/deploy/pipeline/start.ts)_
|
|
851
1388
|
|
|
852
1389
|
## `sf project deploy pipeline validate`
|
|
853
1390
|
|
|
@@ -947,7 +1484,7 @@ FLAG DESCRIPTIONS
|
|
|
947
1484
|
"sf project deploy pipeline report".
|
|
948
1485
|
```
|
|
949
1486
|
|
|
950
|
-
_See code: [src/commands/project/deploy/pipeline/validate.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.
|
|
1487
|
+
_See code: [src/commands/project/deploy/pipeline/validate.ts](https://github.com/salesforcecli/plugin-devops-center/blob/1.4.1/src/commands/project/deploy/pipeline/validate.ts)_
|
|
951
1488
|
|
|
952
1489
|
<!-- commandsstop -->
|
|
953
1490
|
|