@salesforce/plugin-devops-center 2.3.3 → 2.3.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 +31 -31
- package/oclif.manifest.json +922 -922
- package/package.json +3 -3
package/oclif.manifest.json
CHANGED
|
@@ -138,6 +138,236 @@
|
|
|
138
138
|
"promote.js"
|
|
139
139
|
]
|
|
140
140
|
},
|
|
141
|
+
"devops:project:create": {
|
|
142
|
+
"aliases": [],
|
|
143
|
+
"args": {},
|
|
144
|
+
"description": "Creates a new DevOps Center project with the specified name and optional description.",
|
|
145
|
+
"examples": [
|
|
146
|
+
"Create a new DevOps Center project in the specified org.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --name \"MyApp Release\"",
|
|
147
|
+
"Create a project with a name and description.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --name \"Platform Update\" --description \"Platform services update\""
|
|
148
|
+
],
|
|
149
|
+
"flags": {
|
|
150
|
+
"json": {
|
|
151
|
+
"description": "Format output as json.",
|
|
152
|
+
"helpGroup": "GLOBAL",
|
|
153
|
+
"name": "json",
|
|
154
|
+
"allowNo": false,
|
|
155
|
+
"type": "boolean"
|
|
156
|
+
},
|
|
157
|
+
"flags-dir": {
|
|
158
|
+
"helpGroup": "GLOBAL",
|
|
159
|
+
"name": "flags-dir",
|
|
160
|
+
"summary": "Import flag values from a directory.",
|
|
161
|
+
"hasDynamicHelp": false,
|
|
162
|
+
"multiple": false,
|
|
163
|
+
"type": "option"
|
|
164
|
+
},
|
|
165
|
+
"target-org": {
|
|
166
|
+
"char": "o",
|
|
167
|
+
"name": "target-org",
|
|
168
|
+
"noCacheDefault": true,
|
|
169
|
+
"required": true,
|
|
170
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
171
|
+
"hasDynamicHelp": true,
|
|
172
|
+
"multiple": false,
|
|
173
|
+
"type": "option"
|
|
174
|
+
},
|
|
175
|
+
"api-version": {
|
|
176
|
+
"description": "Override the api version used for api requests made by this command",
|
|
177
|
+
"name": "api-version",
|
|
178
|
+
"hasDynamicHelp": false,
|
|
179
|
+
"multiple": false,
|
|
180
|
+
"type": "option"
|
|
181
|
+
},
|
|
182
|
+
"name": {
|
|
183
|
+
"char": "n",
|
|
184
|
+
"name": "name",
|
|
185
|
+
"required": true,
|
|
186
|
+
"summary": "Name of the new DevOps Center project.",
|
|
187
|
+
"hasDynamicHelp": false,
|
|
188
|
+
"multiple": false,
|
|
189
|
+
"type": "option"
|
|
190
|
+
},
|
|
191
|
+
"description": {
|
|
192
|
+
"char": "d",
|
|
193
|
+
"name": "description",
|
|
194
|
+
"summary": "Description of the new project; if not specified, the description is blank.",
|
|
195
|
+
"hasDynamicHelp": false,
|
|
196
|
+
"multiple": false,
|
|
197
|
+
"type": "option"
|
|
198
|
+
}
|
|
199
|
+
},
|
|
200
|
+
"hasDynamicHelp": true,
|
|
201
|
+
"hiddenAliases": [],
|
|
202
|
+
"id": "devops:project:create",
|
|
203
|
+
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
204
|
+
"pluginName": "@salesforce/plugin-devops-center",
|
|
205
|
+
"pluginType": "core",
|
|
206
|
+
"strict": true,
|
|
207
|
+
"summary": "Create a DevOps Center project in a DevOps Center org.",
|
|
208
|
+
"enableJsonFlag": true,
|
|
209
|
+
"isESM": true,
|
|
210
|
+
"relativePath": [
|
|
211
|
+
"lib",
|
|
212
|
+
"commands",
|
|
213
|
+
"devops",
|
|
214
|
+
"project",
|
|
215
|
+
"create.js"
|
|
216
|
+
]
|
|
217
|
+
},
|
|
218
|
+
"devops:project:list": {
|
|
219
|
+
"aliases": [],
|
|
220
|
+
"args": {},
|
|
221
|
+
"description": "This command queries the DevopsProject standard object and returns the project Id, Name, and Description for each project found.",
|
|
222
|
+
"examples": [
|
|
223
|
+
"List all DevOps Center projects in an org with alias \"my-devops-org\":\n<%= config.bin %> <%= command.id %> --target-org my-devops-org",
|
|
224
|
+
"List projects using an org's username:\n<%= config.bin %> <%= command.id %> --target-org devops-center@example.com"
|
|
225
|
+
],
|
|
226
|
+
"flags": {
|
|
227
|
+
"json": {
|
|
228
|
+
"description": "Format output as json.",
|
|
229
|
+
"helpGroup": "GLOBAL",
|
|
230
|
+
"name": "json",
|
|
231
|
+
"allowNo": false,
|
|
232
|
+
"type": "boolean"
|
|
233
|
+
},
|
|
234
|
+
"flags-dir": {
|
|
235
|
+
"helpGroup": "GLOBAL",
|
|
236
|
+
"name": "flags-dir",
|
|
237
|
+
"summary": "Import flag values from a directory.",
|
|
238
|
+
"hasDynamicHelp": false,
|
|
239
|
+
"multiple": false,
|
|
240
|
+
"type": "option"
|
|
241
|
+
},
|
|
242
|
+
"target-org": {
|
|
243
|
+
"char": "o",
|
|
244
|
+
"name": "target-org",
|
|
245
|
+
"noCacheDefault": true,
|
|
246
|
+
"required": true,
|
|
247
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
248
|
+
"hasDynamicHelp": true,
|
|
249
|
+
"multiple": false,
|
|
250
|
+
"type": "option"
|
|
251
|
+
},
|
|
252
|
+
"api-version": {
|
|
253
|
+
"description": "Override the api version used for api requests made by this command",
|
|
254
|
+
"name": "api-version",
|
|
255
|
+
"hasDynamicHelp": false,
|
|
256
|
+
"multiple": false,
|
|
257
|
+
"type": "option"
|
|
258
|
+
}
|
|
259
|
+
},
|
|
260
|
+
"hasDynamicHelp": true,
|
|
261
|
+
"hiddenAliases": [],
|
|
262
|
+
"id": "devops:project:list",
|
|
263
|
+
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
264
|
+
"pluginName": "@salesforce/plugin-devops-center",
|
|
265
|
+
"pluginType": "core",
|
|
266
|
+
"strict": true,
|
|
267
|
+
"summary": "List all DevOps Center projects in a Salesforce org.",
|
|
268
|
+
"enableJsonFlag": true,
|
|
269
|
+
"isESM": true,
|
|
270
|
+
"relativePath": [
|
|
271
|
+
"lib",
|
|
272
|
+
"commands",
|
|
273
|
+
"devops",
|
|
274
|
+
"project",
|
|
275
|
+
"list.js"
|
|
276
|
+
]
|
|
277
|
+
},
|
|
278
|
+
"devops:project:update": {
|
|
279
|
+
"aliases": [],
|
|
280
|
+
"args": {},
|
|
281
|
+
"description": "Update the name, description, or active status of a DevOps Center project. At least one of --name, --description, or --is-active must be provided.",
|
|
282
|
+
"examples": [
|
|
283
|
+
"Rename a project:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --name \"MyApp Release v2\"",
|
|
284
|
+
"Update the description of a project:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --description \"Updated release description\"",
|
|
285
|
+
"Deactivate a project:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --no-is-active",
|
|
286
|
+
"Update all fields at once:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --name \"Archived App\" --description \"Archived\" --no-is-active"
|
|
287
|
+
],
|
|
288
|
+
"flags": {
|
|
289
|
+
"json": {
|
|
290
|
+
"description": "Format output as json.",
|
|
291
|
+
"helpGroup": "GLOBAL",
|
|
292
|
+
"name": "json",
|
|
293
|
+
"allowNo": false,
|
|
294
|
+
"type": "boolean"
|
|
295
|
+
},
|
|
296
|
+
"flags-dir": {
|
|
297
|
+
"helpGroup": "GLOBAL",
|
|
298
|
+
"name": "flags-dir",
|
|
299
|
+
"summary": "Import flag values from a directory.",
|
|
300
|
+
"hasDynamicHelp": false,
|
|
301
|
+
"multiple": false,
|
|
302
|
+
"type": "option"
|
|
303
|
+
},
|
|
304
|
+
"target-org": {
|
|
305
|
+
"char": "o",
|
|
306
|
+
"name": "target-org",
|
|
307
|
+
"noCacheDefault": true,
|
|
308
|
+
"required": true,
|
|
309
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
310
|
+
"hasDynamicHelp": true,
|
|
311
|
+
"multiple": false,
|
|
312
|
+
"type": "option"
|
|
313
|
+
},
|
|
314
|
+
"api-version": {
|
|
315
|
+
"description": "Override the api version used for api requests made by this command",
|
|
316
|
+
"name": "api-version",
|
|
317
|
+
"hasDynamicHelp": false,
|
|
318
|
+
"multiple": false,
|
|
319
|
+
"type": "option"
|
|
320
|
+
},
|
|
321
|
+
"project-id": {
|
|
322
|
+
"char": "i",
|
|
323
|
+
"name": "project-id",
|
|
324
|
+
"required": true,
|
|
325
|
+
"summary": "ID of the DevOps Center project to update.",
|
|
326
|
+
"hasDynamicHelp": false,
|
|
327
|
+
"multiple": false,
|
|
328
|
+
"type": "option"
|
|
329
|
+
},
|
|
330
|
+
"name": {
|
|
331
|
+
"char": "n",
|
|
332
|
+
"name": "name",
|
|
333
|
+
"summary": "New name for the project.",
|
|
334
|
+
"hasDynamicHelp": false,
|
|
335
|
+
"multiple": false,
|
|
336
|
+
"type": "option"
|
|
337
|
+
},
|
|
338
|
+
"description": {
|
|
339
|
+
"char": "d",
|
|
340
|
+
"name": "description",
|
|
341
|
+
"summary": "New description for the project.",
|
|
342
|
+
"hasDynamicHelp": false,
|
|
343
|
+
"multiple": false,
|
|
344
|
+
"type": "option"
|
|
345
|
+
},
|
|
346
|
+
"is-active": {
|
|
347
|
+
"name": "is-active",
|
|
348
|
+
"summary": "Set the project active status. Use --is-active to activate or --no-is-active to deactivate.",
|
|
349
|
+
"allowNo": true,
|
|
350
|
+
"type": "boolean"
|
|
351
|
+
}
|
|
352
|
+
},
|
|
353
|
+
"hasDynamicHelp": true,
|
|
354
|
+
"hiddenAliases": [],
|
|
355
|
+
"id": "devops:project:update",
|
|
356
|
+
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
357
|
+
"pluginName": "@salesforce/plugin-devops-center",
|
|
358
|
+
"pluginType": "core",
|
|
359
|
+
"strict": true,
|
|
360
|
+
"summary": "Update a DevOps Center project.",
|
|
361
|
+
"enableJsonFlag": true,
|
|
362
|
+
"isESM": true,
|
|
363
|
+
"relativePath": [
|
|
364
|
+
"lib",
|
|
365
|
+
"commands",
|
|
366
|
+
"devops",
|
|
367
|
+
"project",
|
|
368
|
+
"update.js"
|
|
369
|
+
]
|
|
370
|
+
},
|
|
141
371
|
"devops:pipeline:create": {
|
|
142
372
|
"aliases": [],
|
|
143
373
|
"args": {},
|
|
@@ -497,13 +727,14 @@
|
|
|
497
727
|
"update.js"
|
|
498
728
|
]
|
|
499
729
|
},
|
|
500
|
-
"devops:
|
|
730
|
+
"devops:promotion:complete": {
|
|
501
731
|
"aliases": [],
|
|
502
732
|
"args": {},
|
|
503
|
-
"description": "
|
|
733
|
+
"description": "Deploys work items that were merged into the pipeline branch outside of DevOps Center (externally merged) into the target stage org and updates DevOps Center records. Equivalent to the \"Complete Promotion\" action in the DevOps Center UI when a stage is out of sync.\n\nIf no undeployed work items are found for the stage, the command exits successfully with no action taken.",
|
|
504
734
|
"examples": [
|
|
505
|
-
"
|
|
506
|
-
"
|
|
735
|
+
"Complete a promotion for an out-of-sync pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001",
|
|
736
|
+
"Complete a promotion for a specific work item (e.g. first stage of a pipeline):\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001",
|
|
737
|
+
"Complete a promotion with full deploy and a specific test level:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --deploy-all --test-level RunLocalTests"
|
|
507
738
|
],
|
|
508
739
|
"flags": {
|
|
509
740
|
"json": {
|
|
@@ -538,49 +769,81 @@
|
|
|
538
769
|
"multiple": false,
|
|
539
770
|
"type": "option"
|
|
540
771
|
},
|
|
541
|
-
"
|
|
542
|
-
"char": "
|
|
543
|
-
"name": "
|
|
772
|
+
"target-stage-id": {
|
|
773
|
+
"char": "t",
|
|
774
|
+
"name": "target-stage-id",
|
|
544
775
|
"required": true,
|
|
545
|
-
"summary": "
|
|
776
|
+
"summary": "ID of the out-of-sync pipeline stage to deploy to.",
|
|
546
777
|
"hasDynamicHelp": false,
|
|
547
778
|
"multiple": false,
|
|
548
779
|
"type": "option"
|
|
549
780
|
},
|
|
550
|
-
"
|
|
551
|
-
"char": "
|
|
552
|
-
"name": "
|
|
553
|
-
"
|
|
781
|
+
"work-item-id": {
|
|
782
|
+
"char": "i",
|
|
783
|
+
"name": "work-item-id",
|
|
784
|
+
"required": false,
|
|
785
|
+
"summary": "ID of a specific work item to deploy. Omit to deploy all undeployed work items for the stage. Use this for the first stage of a pipeline where no source stage exists.",
|
|
786
|
+
"hasDynamicHelp": false,
|
|
787
|
+
"multiple": true,
|
|
788
|
+
"type": "option"
|
|
789
|
+
},
|
|
790
|
+
"deploy-all": {
|
|
791
|
+
"char": "a",
|
|
792
|
+
"description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
|
|
793
|
+
"name": "deploy-all",
|
|
794
|
+
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
795
|
+
"allowNo": false,
|
|
796
|
+
"type": "boolean"
|
|
797
|
+
},
|
|
798
|
+
"test-level": {
|
|
799
|
+
"char": "l",
|
|
800
|
+
"description": "Valid values are:\n\n- 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.\n\n- 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.\n\n- 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.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf 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)",
|
|
801
|
+
"name": "test-level",
|
|
802
|
+
"summary": "Deployment Apex testing level.",
|
|
554
803
|
"hasDynamicHelp": false,
|
|
555
804
|
"multiple": false,
|
|
805
|
+
"options": [
|
|
806
|
+
"NoTestRun",
|
|
807
|
+
"RunSpecifiedTests",
|
|
808
|
+
"RunLocalTests",
|
|
809
|
+
"RunAllTestsInOrg"
|
|
810
|
+
],
|
|
811
|
+
"type": "option"
|
|
812
|
+
},
|
|
813
|
+
"tests": {
|
|
814
|
+
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
815
|
+
"name": "tests",
|
|
816
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
817
|
+
"hasDynamicHelp": false,
|
|
818
|
+
"multiple": true,
|
|
556
819
|
"type": "option"
|
|
557
820
|
}
|
|
558
821
|
},
|
|
559
822
|
"hasDynamicHelp": true,
|
|
560
823
|
"hiddenAliases": [],
|
|
561
|
-
"id": "devops:
|
|
824
|
+
"id": "devops:promotion:complete",
|
|
562
825
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
563
826
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
564
827
|
"pluginType": "core",
|
|
565
828
|
"strict": true,
|
|
566
|
-
"summary": "
|
|
829
|
+
"summary": "Deploy undeployed work items to a pipeline stage org.",
|
|
567
830
|
"enableJsonFlag": true,
|
|
568
831
|
"isESM": true,
|
|
569
832
|
"relativePath": [
|
|
570
833
|
"lib",
|
|
571
834
|
"commands",
|
|
572
835
|
"devops",
|
|
573
|
-
"
|
|
574
|
-
"
|
|
836
|
+
"promotion",
|
|
837
|
+
"complete.js"
|
|
575
838
|
]
|
|
576
839
|
},
|
|
577
|
-
"devops:
|
|
840
|
+
"devops:promotion:validate": {
|
|
578
841
|
"aliases": [],
|
|
579
842
|
"args": {},
|
|
580
|
-
"description": "
|
|
843
|
+
"description": "Validates whether the specified work items can be promoted to the target pipeline stage. Checks for VCS and object permission errors before a promotion is attempted.",
|
|
581
844
|
"examples": [
|
|
582
|
-
"
|
|
583
|
-
"
|
|
845
|
+
"Validate promotion of a work item to a target stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001",
|
|
846
|
+
"Validate promotion of multiple work items:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001 --work-item-id 1fk000000000002"
|
|
584
847
|
],
|
|
585
848
|
"flags": {
|
|
586
849
|
"json": {
|
|
@@ -614,35 +877,51 @@
|
|
|
614
877
|
"hasDynamicHelp": false,
|
|
615
878
|
"multiple": false,
|
|
616
879
|
"type": "option"
|
|
880
|
+
},
|
|
881
|
+
"target-stage-id": {
|
|
882
|
+
"char": "t",
|
|
883
|
+
"name": "target-stage-id",
|
|
884
|
+
"required": true,
|
|
885
|
+
"summary": "ID of the target pipeline stage to validate promotion to.",
|
|
886
|
+
"hasDynamicHelp": false,
|
|
887
|
+
"multiple": false,
|
|
888
|
+
"type": "option"
|
|
889
|
+
},
|
|
890
|
+
"work-item-id": {
|
|
891
|
+
"char": "i",
|
|
892
|
+
"name": "work-item-id",
|
|
893
|
+
"required": true,
|
|
894
|
+
"summary": "ID of a work item to validate for promotion. Specify multiple times for multiple work items.",
|
|
895
|
+
"hasDynamicHelp": false,
|
|
896
|
+
"multiple": true,
|
|
897
|
+
"type": "option"
|
|
617
898
|
}
|
|
618
899
|
},
|
|
619
900
|
"hasDynamicHelp": true,
|
|
620
901
|
"hiddenAliases": [],
|
|
621
|
-
"id": "devops:
|
|
902
|
+
"id": "devops:promotion:validate",
|
|
622
903
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
623
904
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
624
905
|
"pluginType": "core",
|
|
625
906
|
"strict": true,
|
|
626
|
-
"summary": "
|
|
907
|
+
"summary": "Validate work item promotion for a pipeline stage.",
|
|
627
908
|
"enableJsonFlag": true,
|
|
628
909
|
"isESM": true,
|
|
629
910
|
"relativePath": [
|
|
630
911
|
"lib",
|
|
631
912
|
"commands",
|
|
632
913
|
"devops",
|
|
633
|
-
"
|
|
634
|
-
"
|
|
914
|
+
"promotion",
|
|
915
|
+
"validate.js"
|
|
635
916
|
]
|
|
636
917
|
},
|
|
637
|
-
"devops:
|
|
918
|
+
"devops:review:create": {
|
|
638
919
|
"aliases": [],
|
|
639
920
|
"args": {},
|
|
640
|
-
"description": "
|
|
921
|
+
"description": "Creates a pull request via the Salesforce DevOps Center API, using the VCS credentials stored in the org. Works with GitHub and Bitbucket without requiring local VCS authentication.",
|
|
641
922
|
"examples": [
|
|
642
|
-
"
|
|
643
|
-
"
|
|
644
|
-
"Deactivate a project:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --no-is-active",
|
|
645
|
-
"Update all fields at once:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --name \"Archived App\" --description \"Archived\" --no-is-active"
|
|
923
|
+
"Create a pull request for a work item.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --work-item-name WI-000001",
|
|
924
|
+
"Create a pull request using the work item ID.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --work-item-id 0Wx000000000001"
|
|
646
925
|
],
|
|
647
926
|
"flags": {
|
|
648
927
|
"json": {
|
|
@@ -677,64 +956,47 @@
|
|
|
677
956
|
"multiple": false,
|
|
678
957
|
"type": "option"
|
|
679
958
|
},
|
|
680
|
-
"
|
|
681
|
-
"char": "i",
|
|
682
|
-
"name": "project-id",
|
|
683
|
-
"required": true,
|
|
684
|
-
"summary": "ID of the DevOps Center project to update.",
|
|
685
|
-
"hasDynamicHelp": false,
|
|
686
|
-
"multiple": false,
|
|
687
|
-
"type": "option"
|
|
688
|
-
},
|
|
689
|
-
"name": {
|
|
959
|
+
"work-item-name": {
|
|
690
960
|
"char": "n",
|
|
691
|
-
"name": "name",
|
|
692
|
-
"summary": "
|
|
961
|
+
"name": "work-item-name",
|
|
962
|
+
"summary": "Name of the work item, such as WI-000001.",
|
|
693
963
|
"hasDynamicHelp": false,
|
|
694
964
|
"multiple": false,
|
|
695
965
|
"type": "option"
|
|
696
966
|
},
|
|
697
|
-
"
|
|
698
|
-
"char": "
|
|
699
|
-
"name": "
|
|
700
|
-
"summary": "
|
|
967
|
+
"work-item-id": {
|
|
968
|
+
"char": "w",
|
|
969
|
+
"name": "work-item-id",
|
|
970
|
+
"summary": "ID of the work item.",
|
|
701
971
|
"hasDynamicHelp": false,
|
|
702
972
|
"multiple": false,
|
|
703
973
|
"type": "option"
|
|
704
|
-
},
|
|
705
|
-
"is-active": {
|
|
706
|
-
"name": "is-active",
|
|
707
|
-
"summary": "Set the project active status. Use --is-active to activate or --no-is-active to deactivate.",
|
|
708
|
-
"allowNo": true,
|
|
709
|
-
"type": "boolean"
|
|
710
974
|
}
|
|
711
975
|
},
|
|
712
976
|
"hasDynamicHelp": true,
|
|
713
977
|
"hiddenAliases": [],
|
|
714
|
-
"id": "devops:
|
|
978
|
+
"id": "devops:review:create",
|
|
715
979
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
716
980
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
717
981
|
"pluginType": "core",
|
|
718
982
|
"strict": true,
|
|
719
|
-
"summary": "
|
|
983
|
+
"summary": "Create a pull request for a work item branch.",
|
|
720
984
|
"enableJsonFlag": true,
|
|
721
985
|
"isESM": true,
|
|
722
986
|
"relativePath": [
|
|
723
987
|
"lib",
|
|
724
988
|
"commands",
|
|
725
989
|
"devops",
|
|
726
|
-
"
|
|
727
|
-
"
|
|
990
|
+
"review",
|
|
991
|
+
"create.js"
|
|
728
992
|
]
|
|
729
993
|
},
|
|
730
|
-
"devops:
|
|
994
|
+
"devops:request:status": {
|
|
731
995
|
"aliases": [],
|
|
732
996
|
"args": {},
|
|
733
|
-
"description": "
|
|
997
|
+
"description": "Returns the current status of a request identified by its request token.",
|
|
734
998
|
"examples": [
|
|
735
|
-
"
|
|
736
|
-
"Complete a promotion for a specific work item (e.g. first stage of a pipeline):\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001",
|
|
737
|
-
"Complete a promotion with full deploy and a specific test level:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --deploy-all --test-level RunLocalTests"
|
|
999
|
+
"Get the status of a request:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --request-token a0B000000000001"
|
|
738
1000
|
],
|
|
739
1001
|
"flags": {
|
|
740
1002
|
"json": {
|
|
@@ -769,81 +1031,40 @@
|
|
|
769
1031
|
"multiple": false,
|
|
770
1032
|
"type": "option"
|
|
771
1033
|
},
|
|
772
|
-
"
|
|
773
|
-
"char": "t",
|
|
774
|
-
"name": "target-stage-id",
|
|
775
|
-
"required": true,
|
|
776
|
-
"summary": "ID of the out-of-sync pipeline stage to deploy to.",
|
|
777
|
-
"hasDynamicHelp": false,
|
|
778
|
-
"multiple": false,
|
|
779
|
-
"type": "option"
|
|
780
|
-
},
|
|
781
|
-
"work-item-id": {
|
|
1034
|
+
"request-token": {
|
|
782
1035
|
"char": "i",
|
|
783
|
-
"name": "
|
|
784
|
-
"required":
|
|
785
|
-
"summary": "
|
|
786
|
-
"hasDynamicHelp": false,
|
|
787
|
-
"multiple": true,
|
|
788
|
-
"type": "option"
|
|
789
|
-
},
|
|
790
|
-
"deploy-all": {
|
|
791
|
-
"char": "a",
|
|
792
|
-
"description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
|
|
793
|
-
"name": "deploy-all",
|
|
794
|
-
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
795
|
-
"allowNo": false,
|
|
796
|
-
"type": "boolean"
|
|
797
|
-
},
|
|
798
|
-
"test-level": {
|
|
799
|
-
"char": "l",
|
|
800
|
-
"description": "Valid values are:\n\n- 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.\n\n- 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.\n\n- 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.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf 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)",
|
|
801
|
-
"name": "test-level",
|
|
802
|
-
"summary": "Deployment Apex testing level.",
|
|
1036
|
+
"name": "request-token",
|
|
1037
|
+
"required": true,
|
|
1038
|
+
"summary": "Request token from the promote response.",
|
|
803
1039
|
"hasDynamicHelp": false,
|
|
804
1040
|
"multiple": false,
|
|
805
|
-
"options": [
|
|
806
|
-
"NoTestRun",
|
|
807
|
-
"RunSpecifiedTests",
|
|
808
|
-
"RunLocalTests",
|
|
809
|
-
"RunAllTestsInOrg"
|
|
810
|
-
],
|
|
811
|
-
"type": "option"
|
|
812
|
-
},
|
|
813
|
-
"tests": {
|
|
814
|
-
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
815
|
-
"name": "tests",
|
|
816
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
817
|
-
"hasDynamicHelp": false,
|
|
818
|
-
"multiple": true,
|
|
819
1041
|
"type": "option"
|
|
820
1042
|
}
|
|
821
1043
|
},
|
|
822
1044
|
"hasDynamicHelp": true,
|
|
823
1045
|
"hiddenAliases": [],
|
|
824
|
-
"id": "devops:
|
|
1046
|
+
"id": "devops:request:status",
|
|
825
1047
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
826
1048
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
827
1049
|
"pluginType": "core",
|
|
828
1050
|
"strict": true,
|
|
829
|
-
"summary": "
|
|
1051
|
+
"summary": "Get the status of a request.",
|
|
830
1052
|
"enableJsonFlag": true,
|
|
831
1053
|
"isESM": true,
|
|
832
1054
|
"relativePath": [
|
|
833
1055
|
"lib",
|
|
834
1056
|
"commands",
|
|
835
1057
|
"devops",
|
|
836
|
-
"
|
|
837
|
-
"
|
|
1058
|
+
"request",
|
|
1059
|
+
"status.js"
|
|
838
1060
|
]
|
|
839
1061
|
},
|
|
840
|
-
"devops:
|
|
1062
|
+
"devops:work-item:combine": {
|
|
841
1063
|
"aliases": [],
|
|
842
1064
|
"args": {},
|
|
843
|
-
"description": "
|
|
1065
|
+
"description": "Use this command when work items in the same stage share metadata or have dependencies. DevOps Center combines the selected work items so they can be promoted together during custom promotion.\n\nAfter running this command, use \"sf devops work-item promote\" with the parent work item ID to complete the promotion. The combined work items are promoted as a single unit.",
|
|
844
1066
|
"examples": [
|
|
845
|
-
"
|
|
846
|
-
"Validate promotion of multiple work items:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001 --work-item-id 1fk000000000002"
|
|
1067
|
+
"Prepare three work items to be combined to prevent conflicts during promotion:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --parent-work-item-id 0Wx000000000001 --child-work-item-id 0Wx000000000002 --child-work-item-id 0Wx000000000003 --target-stage-id 05S000000000002"
|
|
847
1068
|
],
|
|
848
1069
|
"flags": {
|
|
849
1070
|
"json": {
|
|
@@ -878,49 +1099,59 @@
|
|
|
878
1099
|
"multiple": false,
|
|
879
1100
|
"type": "option"
|
|
880
1101
|
},
|
|
881
|
-
"
|
|
882
|
-
"
|
|
883
|
-
"name": "
|
|
1102
|
+
"parent-work-item-id": {
|
|
1103
|
+
"description": "The parent work item is the primary work item that continues through the pipeline. Changes from all child work items are merged into the parent's branch during promotion.",
|
|
1104
|
+
"name": "parent-work-item-id",
|
|
884
1105
|
"required": true,
|
|
885
|
-
"summary": "ID of the
|
|
1106
|
+
"summary": "ID of the parent work item.",
|
|
886
1107
|
"hasDynamicHelp": false,
|
|
887
1108
|
"multiple": false,
|
|
888
1109
|
"type": "option"
|
|
889
1110
|
},
|
|
890
|
-
"work-item-id": {
|
|
891
|
-
"
|
|
892
|
-
"name": "work-item-id",
|
|
1111
|
+
"child-work-item-id": {
|
|
1112
|
+
"description": "Specify this flag multiple times to combine multiple work items with the parent.",
|
|
1113
|
+
"name": "child-work-item-id",
|
|
893
1114
|
"required": true,
|
|
894
|
-
"summary": "ID of a work item to
|
|
1115
|
+
"summary": "ID of a work item to combine.",
|
|
895
1116
|
"hasDynamicHelp": false,
|
|
896
1117
|
"multiple": true,
|
|
897
1118
|
"type": "option"
|
|
1119
|
+
},
|
|
1120
|
+
"target-stage-id": {
|
|
1121
|
+
"char": "t",
|
|
1122
|
+
"name": "target-stage-id",
|
|
1123
|
+
"required": true,
|
|
1124
|
+
"summary": "ID of the pipeline stage to promote the combined work item to.",
|
|
1125
|
+
"hasDynamicHelp": false,
|
|
1126
|
+
"multiple": false,
|
|
1127
|
+
"type": "option"
|
|
898
1128
|
}
|
|
899
1129
|
},
|
|
900
1130
|
"hasDynamicHelp": true,
|
|
901
1131
|
"hiddenAliases": [],
|
|
902
|
-
"id": "devops:
|
|
1132
|
+
"id": "devops:work-item:combine",
|
|
903
1133
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
904
1134
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
905
1135
|
"pluginType": "core",
|
|
906
1136
|
"strict": true,
|
|
907
|
-
"summary": "
|
|
1137
|
+
"summary": "Prepare work items to be combined for custom promotion.",
|
|
908
1138
|
"enableJsonFlag": true,
|
|
909
1139
|
"isESM": true,
|
|
910
1140
|
"relativePath": [
|
|
911
1141
|
"lib",
|
|
912
1142
|
"commands",
|
|
913
1143
|
"devops",
|
|
914
|
-
"
|
|
915
|
-
"
|
|
1144
|
+
"work-item",
|
|
1145
|
+
"combine.js"
|
|
916
1146
|
]
|
|
917
1147
|
},
|
|
918
|
-
"devops:
|
|
1148
|
+
"devops:work-item:create": {
|
|
919
1149
|
"aliases": [],
|
|
920
1150
|
"args": {},
|
|
921
|
-
"description": "
|
|
1151
|
+
"description": "The command creates the work item using the Connect API. Requires a project ID and a subject for the new work item; run the `devops project list` command to get the IDs for all existing projects.",
|
|
922
1152
|
"examples": [
|
|
923
|
-
"
|
|
1153
|
+
"Create a work item for the project with the specified ID and give the work item the specified subject (title); use the DevOps Center org with alias \"my-devops-org\":\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --subject \"Fix login bug\"",
|
|
1154
|
+
"Create a work item with a subject and description:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --subject \"Add dark mode\" --description \"Implement dark mode toggle in settings page\""
|
|
924
1155
|
],
|
|
925
1156
|
"flags": {
|
|
926
1157
|
"json": {
|
|
@@ -955,183 +1186,28 @@
|
|
|
955
1186
|
"multiple": false,
|
|
956
1187
|
"type": "option"
|
|
957
1188
|
},
|
|
958
|
-
"
|
|
959
|
-
"char": "
|
|
960
|
-
"name": "
|
|
1189
|
+
"project-id": {
|
|
1190
|
+
"char": "p",
|
|
1191
|
+
"name": "project-id",
|
|
961
1192
|
"required": true,
|
|
962
|
-
"summary": "
|
|
963
|
-
"hasDynamicHelp": false,
|
|
964
|
-
"multiple": false,
|
|
965
|
-
"type": "option"
|
|
966
|
-
}
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
"commands",
|
|
981
|
-
"devops",
|
|
982
|
-
"request",
|
|
983
|
-
"status.js"
|
|
984
|
-
]
|
|
985
|
-
},
|
|
986
|
-
"devops:work-item:combine": {
|
|
987
|
-
"aliases": [],
|
|
988
|
-
"args": {},
|
|
989
|
-
"description": "Use this command when work items in the same stage share metadata or have dependencies. DevOps Center combines the selected work items so they can be promoted together during custom promotion.\n\nAfter running this command, use \"sf devops work-item promote\" with the parent work item ID to complete the promotion. The combined work items are promoted as a single unit.",
|
|
990
|
-
"examples": [
|
|
991
|
-
"Prepare three work items to be combined to prevent conflicts during promotion:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --parent-work-item-id 0Wx000000000001 --child-work-item-id 0Wx000000000002 --child-work-item-id 0Wx000000000003 --target-stage-id 05S000000000002"
|
|
992
|
-
],
|
|
993
|
-
"flags": {
|
|
994
|
-
"json": {
|
|
995
|
-
"description": "Format output as json.",
|
|
996
|
-
"helpGroup": "GLOBAL",
|
|
997
|
-
"name": "json",
|
|
998
|
-
"allowNo": false,
|
|
999
|
-
"type": "boolean"
|
|
1000
|
-
},
|
|
1001
|
-
"flags-dir": {
|
|
1002
|
-
"helpGroup": "GLOBAL",
|
|
1003
|
-
"name": "flags-dir",
|
|
1004
|
-
"summary": "Import flag values from a directory.",
|
|
1005
|
-
"hasDynamicHelp": false,
|
|
1006
|
-
"multiple": false,
|
|
1007
|
-
"type": "option"
|
|
1008
|
-
},
|
|
1009
|
-
"target-org": {
|
|
1010
|
-
"char": "o",
|
|
1011
|
-
"name": "target-org",
|
|
1012
|
-
"noCacheDefault": true,
|
|
1013
|
-
"required": true,
|
|
1014
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1015
|
-
"hasDynamicHelp": true,
|
|
1016
|
-
"multiple": false,
|
|
1017
|
-
"type": "option"
|
|
1018
|
-
},
|
|
1019
|
-
"api-version": {
|
|
1020
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1021
|
-
"name": "api-version",
|
|
1022
|
-
"hasDynamicHelp": false,
|
|
1023
|
-
"multiple": false,
|
|
1024
|
-
"type": "option"
|
|
1025
|
-
},
|
|
1026
|
-
"parent-work-item-id": {
|
|
1027
|
-
"description": "The parent work item is the primary work item that continues through the pipeline. Changes from all child work items are merged into the parent's branch during promotion.",
|
|
1028
|
-
"name": "parent-work-item-id",
|
|
1029
|
-
"required": true,
|
|
1030
|
-
"summary": "ID of the parent work item.",
|
|
1031
|
-
"hasDynamicHelp": false,
|
|
1032
|
-
"multiple": false,
|
|
1033
|
-
"type": "option"
|
|
1034
|
-
},
|
|
1035
|
-
"child-work-item-id": {
|
|
1036
|
-
"description": "Specify this flag multiple times to combine multiple work items with the parent.",
|
|
1037
|
-
"name": "child-work-item-id",
|
|
1038
|
-
"required": true,
|
|
1039
|
-
"summary": "ID of a work item to combine.",
|
|
1040
|
-
"hasDynamicHelp": false,
|
|
1041
|
-
"multiple": true,
|
|
1042
|
-
"type": "option"
|
|
1043
|
-
},
|
|
1044
|
-
"target-stage-id": {
|
|
1045
|
-
"char": "t",
|
|
1046
|
-
"name": "target-stage-id",
|
|
1047
|
-
"required": true,
|
|
1048
|
-
"summary": "ID of the pipeline stage to promote the combined work item to.",
|
|
1049
|
-
"hasDynamicHelp": false,
|
|
1050
|
-
"multiple": false,
|
|
1051
|
-
"type": "option"
|
|
1052
|
-
}
|
|
1053
|
-
},
|
|
1054
|
-
"hasDynamicHelp": true,
|
|
1055
|
-
"hiddenAliases": [],
|
|
1056
|
-
"id": "devops:work-item:combine",
|
|
1057
|
-
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1058
|
-
"pluginName": "@salesforce/plugin-devops-center",
|
|
1059
|
-
"pluginType": "core",
|
|
1060
|
-
"strict": true,
|
|
1061
|
-
"summary": "Prepare work items to be combined for custom promotion.",
|
|
1062
|
-
"enableJsonFlag": true,
|
|
1063
|
-
"isESM": true,
|
|
1064
|
-
"relativePath": [
|
|
1065
|
-
"lib",
|
|
1066
|
-
"commands",
|
|
1067
|
-
"devops",
|
|
1068
|
-
"work-item",
|
|
1069
|
-
"combine.js"
|
|
1070
|
-
]
|
|
1071
|
-
},
|
|
1072
|
-
"devops:work-item:create": {
|
|
1073
|
-
"aliases": [],
|
|
1074
|
-
"args": {},
|
|
1075
|
-
"description": "The command creates the work item using the Connect API. Requires a project ID and a subject for the new work item; run the `devops project list` command to get the IDs for all existing projects.",
|
|
1076
|
-
"examples": [
|
|
1077
|
-
"Create a work item for the project with the specified ID and give the work item the specified subject (title); use the DevOps Center org with alias \"my-devops-org\":\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --subject \"Fix login bug\"",
|
|
1078
|
-
"Create a work item with a subject and description:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --subject \"Add dark mode\" --description \"Implement dark mode toggle in settings page\""
|
|
1079
|
-
],
|
|
1080
|
-
"flags": {
|
|
1081
|
-
"json": {
|
|
1082
|
-
"description": "Format output as json.",
|
|
1083
|
-
"helpGroup": "GLOBAL",
|
|
1084
|
-
"name": "json",
|
|
1085
|
-
"allowNo": false,
|
|
1086
|
-
"type": "boolean"
|
|
1087
|
-
},
|
|
1088
|
-
"flags-dir": {
|
|
1089
|
-
"helpGroup": "GLOBAL",
|
|
1090
|
-
"name": "flags-dir",
|
|
1091
|
-
"summary": "Import flag values from a directory.",
|
|
1092
|
-
"hasDynamicHelp": false,
|
|
1093
|
-
"multiple": false,
|
|
1094
|
-
"type": "option"
|
|
1095
|
-
},
|
|
1096
|
-
"target-org": {
|
|
1097
|
-
"char": "o",
|
|
1098
|
-
"name": "target-org",
|
|
1099
|
-
"noCacheDefault": true,
|
|
1100
|
-
"required": true,
|
|
1101
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1102
|
-
"hasDynamicHelp": true,
|
|
1103
|
-
"multiple": false,
|
|
1104
|
-
"type": "option"
|
|
1105
|
-
},
|
|
1106
|
-
"api-version": {
|
|
1107
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1108
|
-
"name": "api-version",
|
|
1109
|
-
"hasDynamicHelp": false,
|
|
1110
|
-
"multiple": false,
|
|
1111
|
-
"type": "option"
|
|
1112
|
-
},
|
|
1113
|
-
"project-id": {
|
|
1114
|
-
"char": "p",
|
|
1115
|
-
"name": "project-id",
|
|
1116
|
-
"required": true,
|
|
1117
|
-
"summary": "ID of the DevOps Center project to create the work item in.",
|
|
1118
|
-
"hasDynamicHelp": false,
|
|
1119
|
-
"multiple": false,
|
|
1120
|
-
"type": "option"
|
|
1121
|
-
},
|
|
1122
|
-
"subject": {
|
|
1123
|
-
"char": "s",
|
|
1124
|
-
"name": "subject",
|
|
1125
|
-
"required": true,
|
|
1126
|
-
"summary": "Subject (title) of the new work item.",
|
|
1127
|
-
"hasDynamicHelp": false,
|
|
1128
|
-
"multiple": false,
|
|
1129
|
-
"type": "option"
|
|
1130
|
-
},
|
|
1131
|
-
"description": {
|
|
1132
|
-
"char": "d",
|
|
1133
|
-
"name": "description",
|
|
1134
|
-
"summary": "Description of the new work item; if not specified, the description is blank.",
|
|
1193
|
+
"summary": "ID of the DevOps Center project to create the work item in.",
|
|
1194
|
+
"hasDynamicHelp": false,
|
|
1195
|
+
"multiple": false,
|
|
1196
|
+
"type": "option"
|
|
1197
|
+
},
|
|
1198
|
+
"subject": {
|
|
1199
|
+
"char": "s",
|
|
1200
|
+
"name": "subject",
|
|
1201
|
+
"required": true,
|
|
1202
|
+
"summary": "Subject (title) of the new work item.",
|
|
1203
|
+
"hasDynamicHelp": false,
|
|
1204
|
+
"multiple": false,
|
|
1205
|
+
"type": "option"
|
|
1206
|
+
},
|
|
1207
|
+
"description": {
|
|
1208
|
+
"char": "d",
|
|
1209
|
+
"name": "description",
|
|
1210
|
+
"summary": "Description of the new work item; if not specified, the description is blank.",
|
|
1135
1211
|
"hasDynamicHelp": false,
|
|
1136
1212
|
"multiple": false,
|
|
1137
1213
|
"type": "option"
|
|
@@ -1404,13 +1480,13 @@
|
|
|
1404
1480
|
"update.js"
|
|
1405
1481
|
]
|
|
1406
1482
|
},
|
|
1407
|
-
"
|
|
1483
|
+
"project:deploy:pipeline:quick": {
|
|
1408
1484
|
"aliases": [],
|
|
1409
1485
|
"args": {},
|
|
1410
|
-
"description": "
|
|
1486
|
+
"description": "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.\n\nBefore 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.\n\nExecuting 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.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.",
|
|
1411
1487
|
"examples": [
|
|
1412
|
-
"
|
|
1413
|
-
"
|
|
1488
|
+
"Run a quick deploy using your default Devops Center org and a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1489
|
+
"Asynchronously run a quick deploy of the most recently validated deployment using an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --devops-center-username my-prod-org"
|
|
1414
1490
|
],
|
|
1415
1491
|
"flags": {
|
|
1416
1492
|
"json": {
|
|
@@ -1428,64 +1504,96 @@
|
|
|
1428
1504
|
"multiple": false,
|
|
1429
1505
|
"type": "option"
|
|
1430
1506
|
},
|
|
1431
|
-
"
|
|
1432
|
-
"
|
|
1433
|
-
"name": "
|
|
1434
|
-
"
|
|
1435
|
-
"
|
|
1436
|
-
"
|
|
1507
|
+
"async": {
|
|
1508
|
+
"description": "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\".",
|
|
1509
|
+
"name": "async",
|
|
1510
|
+
"summary": "Run the command asynchronously.",
|
|
1511
|
+
"allowNo": false,
|
|
1512
|
+
"type": "boolean"
|
|
1513
|
+
},
|
|
1514
|
+
"concise": {
|
|
1515
|
+
"exclusive": [
|
|
1516
|
+
"verbose"
|
|
1517
|
+
],
|
|
1518
|
+
"name": "concise",
|
|
1519
|
+
"summary": "Show concise output of the command result.",
|
|
1520
|
+
"allowNo": false,
|
|
1521
|
+
"type": "boolean"
|
|
1522
|
+
},
|
|
1523
|
+
"verbose": {
|
|
1524
|
+
"name": "verbose",
|
|
1525
|
+
"summary": "Show verbose output of the command result.",
|
|
1526
|
+
"allowNo": false,
|
|
1527
|
+
"type": "boolean"
|
|
1528
|
+
},
|
|
1529
|
+
"wait": {
|
|
1530
|
+
"char": "w",
|
|
1531
|
+
"description": "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\".",
|
|
1532
|
+
"exclusive": [
|
|
1533
|
+
"async"
|
|
1534
|
+
],
|
|
1535
|
+
"name": "wait",
|
|
1536
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1537
|
+
"default": "33 minutes",
|
|
1437
1538
|
"hasDynamicHelp": true,
|
|
1539
|
+
"helpValue": "<minutes>",
|
|
1438
1540
|
"multiple": false,
|
|
1439
1541
|
"type": "option"
|
|
1440
1542
|
},
|
|
1441
|
-
"
|
|
1442
|
-
"
|
|
1443
|
-
"name": "
|
|
1444
|
-
"
|
|
1543
|
+
"devops-center-username": {
|
|
1544
|
+
"char": "c",
|
|
1545
|
+
"name": "devops-center-username",
|
|
1546
|
+
"required": true,
|
|
1547
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
1548
|
+
"hasDynamicHelp": true,
|
|
1445
1549
|
"multiple": false,
|
|
1446
1550
|
"type": "option"
|
|
1447
1551
|
},
|
|
1448
|
-
"
|
|
1449
|
-
"char": "
|
|
1450
|
-
"
|
|
1451
|
-
"
|
|
1552
|
+
"job-id": {
|
|
1553
|
+
"char": "i",
|
|
1554
|
+
"description": "The job ID is valid for 10 days from when you started the validation.",
|
|
1555
|
+
"name": "job-id",
|
|
1556
|
+
"summary": "Job ID of the validated deployment to quick deploy.",
|
|
1452
1557
|
"hasDynamicHelp": false,
|
|
1453
1558
|
"multiple": false,
|
|
1454
1559
|
"type": "option"
|
|
1455
1560
|
},
|
|
1456
|
-
"
|
|
1457
|
-
"char": "
|
|
1458
|
-
"
|
|
1459
|
-
"
|
|
1460
|
-
"
|
|
1461
|
-
"
|
|
1462
|
-
"type": "
|
|
1561
|
+
"use-most-recent": {
|
|
1562
|
+
"char": "r",
|
|
1563
|
+
"description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find the job ID.",
|
|
1564
|
+
"name": "use-most-recent",
|
|
1565
|
+
"summary": "Use the job ID of the most recently validated deployment.",
|
|
1566
|
+
"allowNo": false,
|
|
1567
|
+
"type": "boolean"
|
|
1463
1568
|
}
|
|
1464
1569
|
},
|
|
1465
1570
|
"hasDynamicHelp": true,
|
|
1466
1571
|
"hiddenAliases": [],
|
|
1467
|
-
"id": "
|
|
1572
|
+
"id": "project:deploy:pipeline:quick",
|
|
1468
1573
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1469
1574
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
1470
1575
|
"pluginType": "core",
|
|
1576
|
+
"state": "beta",
|
|
1471
1577
|
"strict": true,
|
|
1472
|
-
"summary": "
|
|
1578
|
+
"summary": "Quickly deploy a validated deployment to an org.",
|
|
1473
1579
|
"enableJsonFlag": true,
|
|
1474
1580
|
"isESM": true,
|
|
1475
1581
|
"relativePath": [
|
|
1476
1582
|
"lib",
|
|
1477
1583
|
"commands",
|
|
1478
|
-
"
|
|
1479
|
-
"
|
|
1480
|
-
"
|
|
1584
|
+
"project",
|
|
1585
|
+
"deploy",
|
|
1586
|
+
"pipeline",
|
|
1587
|
+
"quick.js"
|
|
1481
1588
|
]
|
|
1482
1589
|
},
|
|
1483
|
-
"
|
|
1590
|
+
"project:deploy:pipeline:report": {
|
|
1484
1591
|
"aliases": [],
|
|
1485
1592
|
"args": {},
|
|
1486
|
-
"description": "
|
|
1593
|
+
"description": "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.\n\nRun 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.",
|
|
1487
1594
|
"examples": [
|
|
1488
|
-
"
|
|
1595
|
+
"Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --job-id 0Af0x000017yLUFCA2",
|
|
1596
|
+
"Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --use-most-recent"
|
|
1489
1597
|
],
|
|
1490
1598
|
"flags": {
|
|
1491
1599
|
"json": {
|
|
@@ -1503,65 +1611,60 @@
|
|
|
1503
1611
|
"multiple": false,
|
|
1504
1612
|
"type": "option"
|
|
1505
1613
|
},
|
|
1506
|
-
"
|
|
1507
|
-
"char": "
|
|
1508
|
-
"name": "
|
|
1509
|
-
"noCacheDefault": true,
|
|
1614
|
+
"devops-center-username": {
|
|
1615
|
+
"char": "c",
|
|
1616
|
+
"name": "devops-center-username",
|
|
1510
1617
|
"required": true,
|
|
1511
|
-
"summary": "Username or alias of the
|
|
1618
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
1512
1619
|
"hasDynamicHelp": true,
|
|
1513
1620
|
"multiple": false,
|
|
1514
1621
|
"type": "option"
|
|
1515
1622
|
},
|
|
1516
|
-
"
|
|
1517
|
-
"
|
|
1518
|
-
"
|
|
1519
|
-
"
|
|
1520
|
-
"
|
|
1521
|
-
"type": "option"
|
|
1522
|
-
},
|
|
1523
|
-
"pipeline-id": {
|
|
1524
|
-
"name": "pipeline-id",
|
|
1525
|
-
"required": true,
|
|
1526
|
-
"summary": "ID of the pipeline.",
|
|
1623
|
+
"job-id": {
|
|
1624
|
+
"char": "i",
|
|
1625
|
+
"description": "The job ID is valid for 10 days from when you started the deploy operation.",
|
|
1626
|
+
"name": "job-id",
|
|
1627
|
+
"summary": "Job ID of the pipeline deployment to check the status of.",
|
|
1527
1628
|
"hasDynamicHelp": false,
|
|
1528
1629
|
"multiple": false,
|
|
1529
1630
|
"type": "option"
|
|
1530
1631
|
},
|
|
1531
|
-
"
|
|
1532
|
-
"
|
|
1533
|
-
"
|
|
1534
|
-
"
|
|
1535
|
-
"
|
|
1536
|
-
"
|
|
1537
|
-
"type": "
|
|
1632
|
+
"use-most-recent": {
|
|
1633
|
+
"char": "r",
|
|
1634
|
+
"description": "For performance reasons, this flag uses job IDs for deploy operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find the job ID.",
|
|
1635
|
+
"name": "use-most-recent",
|
|
1636
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1637
|
+
"allowNo": false,
|
|
1638
|
+
"type": "boolean"
|
|
1538
1639
|
}
|
|
1539
1640
|
},
|
|
1540
1641
|
"hasDynamicHelp": true,
|
|
1541
1642
|
"hiddenAliases": [],
|
|
1542
|
-
"id": "
|
|
1643
|
+
"id": "project:deploy:pipeline:report",
|
|
1543
1644
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1544
1645
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
1545
1646
|
"pluginType": "core",
|
|
1647
|
+
"state": "beta",
|
|
1546
1648
|
"strict": true,
|
|
1547
|
-
"summary": "
|
|
1649
|
+
"summary": "Check the status of a pipeline deploy operation.",
|
|
1548
1650
|
"enableJsonFlag": true,
|
|
1549
1651
|
"isESM": true,
|
|
1550
1652
|
"relativePath": [
|
|
1551
1653
|
"lib",
|
|
1552
1654
|
"commands",
|
|
1553
|
-
"devops",
|
|
1554
|
-
"pipeline",
|
|
1555
1655
|
"project",
|
|
1556
|
-
"
|
|
1656
|
+
"deploy",
|
|
1657
|
+
"pipeline",
|
|
1658
|
+
"report.js"
|
|
1557
1659
|
]
|
|
1558
1660
|
},
|
|
1559
|
-
"
|
|
1661
|
+
"project:deploy:pipeline:resume": {
|
|
1560
1662
|
"aliases": [],
|
|
1561
1663
|
"args": {},
|
|
1562
|
-
"description": "
|
|
1664
|
+
"description": "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. \n\nUse this command to resume watching a pipeline deploy operation if the original command times out or you specified the --async flag.\n\nRun 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.",
|
|
1563
1665
|
"examples": [
|
|
1564
|
-
"
|
|
1666
|
+
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1667
|
+
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1565
1668
|
],
|
|
1566
1669
|
"flags": {
|
|
1567
1670
|
"json": {
|
|
@@ -1579,66 +1682,89 @@
|
|
|
1579
1682
|
"multiple": false,
|
|
1580
1683
|
"type": "option"
|
|
1581
1684
|
},
|
|
1582
|
-
"
|
|
1583
|
-
"char": "
|
|
1584
|
-
"name": "
|
|
1585
|
-
"noCacheDefault": true,
|
|
1685
|
+
"devops-center-username": {
|
|
1686
|
+
"char": "c",
|
|
1687
|
+
"name": "devops-center-username",
|
|
1586
1688
|
"required": true,
|
|
1587
|
-
"summary": "Username or alias of the
|
|
1689
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
1588
1690
|
"hasDynamicHelp": true,
|
|
1589
1691
|
"multiple": false,
|
|
1590
1692
|
"type": "option"
|
|
1591
1693
|
},
|
|
1592
|
-
"
|
|
1593
|
-
"
|
|
1594
|
-
"
|
|
1694
|
+
"job-id": {
|
|
1695
|
+
"char": "i",
|
|
1696
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy pipeline start\n- sf project deploy pipeline validate\n- sf project deploy pipeline quick\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
1697
|
+
"name": "job-id",
|
|
1698
|
+
"summary": "Job ID of the pipeline deploy operation you want to resume.",
|
|
1595
1699
|
"hasDynamicHelp": false,
|
|
1596
1700
|
"multiple": false,
|
|
1597
1701
|
"type": "option"
|
|
1598
1702
|
},
|
|
1599
|
-
"
|
|
1600
|
-
"
|
|
1601
|
-
"
|
|
1602
|
-
"
|
|
1603
|
-
"
|
|
1604
|
-
"
|
|
1605
|
-
"type": "
|
|
1703
|
+
"use-most-recent": {
|
|
1704
|
+
"char": "r",
|
|
1705
|
+
"description": "For performance reasons, this flag uses job IDs for operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find a job ID.",
|
|
1706
|
+
"name": "use-most-recent",
|
|
1707
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1708
|
+
"allowNo": false,
|
|
1709
|
+
"type": "boolean"
|
|
1606
1710
|
},
|
|
1607
|
-
"
|
|
1608
|
-
"
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
"
|
|
1711
|
+
"concise": {
|
|
1712
|
+
"exclusive": [
|
|
1713
|
+
"verbose"
|
|
1714
|
+
],
|
|
1715
|
+
"name": "concise",
|
|
1716
|
+
"summary": "Show concise output of the command result.",
|
|
1717
|
+
"allowNo": false,
|
|
1718
|
+
"type": "boolean"
|
|
1719
|
+
},
|
|
1720
|
+
"verbose": {
|
|
1721
|
+
"name": "verbose",
|
|
1722
|
+
"summary": "Show verbose output of the command result.",
|
|
1723
|
+
"allowNo": false,
|
|
1724
|
+
"type": "boolean"
|
|
1725
|
+
},
|
|
1726
|
+
"wait": {
|
|
1727
|
+
"char": "w",
|
|
1728
|
+
"description": "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\".",
|
|
1729
|
+
"exclusive": [
|
|
1730
|
+
"async"
|
|
1731
|
+
],
|
|
1732
|
+
"name": "wait",
|
|
1733
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1734
|
+
"default": "33 minutes",
|
|
1735
|
+
"hasDynamicHelp": true,
|
|
1736
|
+
"helpValue": "<minutes>",
|
|
1612
1737
|
"multiple": false,
|
|
1613
1738
|
"type": "option"
|
|
1614
1739
|
}
|
|
1615
1740
|
},
|
|
1616
1741
|
"hasDynamicHelp": true,
|
|
1617
1742
|
"hiddenAliases": [],
|
|
1618
|
-
"id": "
|
|
1743
|
+
"id": "project:deploy:pipeline:resume",
|
|
1619
1744
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1620
1745
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
1621
1746
|
"pluginType": "core",
|
|
1747
|
+
"state": "beta",
|
|
1622
1748
|
"strict": true,
|
|
1623
|
-
"summary": "
|
|
1749
|
+
"summary": "Resume watching a pipeline deploy operation.",
|
|
1624
1750
|
"enableJsonFlag": true,
|
|
1625
1751
|
"isESM": true,
|
|
1626
1752
|
"relativePath": [
|
|
1627
1753
|
"lib",
|
|
1628
1754
|
"commands",
|
|
1629
|
-
"devops",
|
|
1630
|
-
"pipeline",
|
|
1631
1755
|
"project",
|
|
1632
|
-
"
|
|
1756
|
+
"deploy",
|
|
1757
|
+
"pipeline",
|
|
1758
|
+
"resume.js"
|
|
1633
1759
|
]
|
|
1634
1760
|
},
|
|
1635
|
-
"
|
|
1761
|
+
"project:deploy:pipeline:start": {
|
|
1636
1762
|
"aliases": [],
|
|
1637
1763
|
"args": {},
|
|
1638
|
-
"description": "
|
|
1764
|
+
"description": "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.\n\nBefore you run this command, changes in the pipeline stage's branch must be merged in the source control repository.",
|
|
1639
1765
|
"examples": [
|
|
1640
|
-
"
|
|
1641
|
-
"
|
|
1766
|
+
"Deploy changes in the Staging branch to the Staging environment (sandbox), if the previous stage is the bundling stage:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox --bundle-version-name 1.0",
|
|
1767
|
+
"Deploy all changes in the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
|
|
1642
1768
|
],
|
|
1643
1769
|
"flags": {
|
|
1644
1770
|
"json": {
|
|
@@ -1656,74 +1782,138 @@
|
|
|
1656
1782
|
"multiple": false,
|
|
1657
1783
|
"type": "option"
|
|
1658
1784
|
},
|
|
1659
|
-
"
|
|
1660
|
-
"char": "
|
|
1661
|
-
"name": "
|
|
1662
|
-
"noCacheDefault": true,
|
|
1785
|
+
"branch-name": {
|
|
1786
|
+
"char": "b",
|
|
1787
|
+
"name": "branch-name",
|
|
1663
1788
|
"required": true,
|
|
1664
|
-
"summary": "
|
|
1665
|
-
"hasDynamicHelp":
|
|
1789
|
+
"summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
|
|
1790
|
+
"hasDynamicHelp": false,
|
|
1666
1791
|
"multiple": false,
|
|
1667
1792
|
"type": "option"
|
|
1668
1793
|
},
|
|
1669
|
-
"
|
|
1670
|
-
"
|
|
1671
|
-
"
|
|
1794
|
+
"bundle-version-name": {
|
|
1795
|
+
"char": "v",
|
|
1796
|
+
"description": "You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.",
|
|
1797
|
+
"name": "bundle-version-name",
|
|
1798
|
+
"summary": "Version name of the bundle.",
|
|
1672
1799
|
"hasDynamicHelp": false,
|
|
1673
1800
|
"multiple": false,
|
|
1674
1801
|
"type": "option"
|
|
1675
1802
|
},
|
|
1676
|
-
"
|
|
1677
|
-
"
|
|
1803
|
+
"deploy-all": {
|
|
1804
|
+
"char": "a",
|
|
1805
|
+
"description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
|
|
1806
|
+
"name": "deploy-all",
|
|
1807
|
+
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
1808
|
+
"allowNo": false,
|
|
1809
|
+
"type": "boolean"
|
|
1810
|
+
},
|
|
1811
|
+
"devops-center-project-name": {
|
|
1812
|
+
"char": "p",
|
|
1813
|
+
"name": "devops-center-project-name",
|
|
1678
1814
|
"required": true,
|
|
1679
|
-
"summary": "
|
|
1815
|
+
"summary": "Name of the DevOps Center project.",
|
|
1680
1816
|
"hasDynamicHelp": false,
|
|
1681
1817
|
"multiple": false,
|
|
1682
1818
|
"type": "option"
|
|
1683
1819
|
},
|
|
1684
|
-
"
|
|
1685
|
-
"char": "
|
|
1686
|
-
"name": "
|
|
1820
|
+
"devops-center-username": {
|
|
1821
|
+
"char": "c",
|
|
1822
|
+
"name": "devops-center-username",
|
|
1687
1823
|
"required": true,
|
|
1688
|
-
"summary": "
|
|
1689
|
-
"hasDynamicHelp":
|
|
1824
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
1825
|
+
"hasDynamicHelp": true,
|
|
1690
1826
|
"multiple": false,
|
|
1691
1827
|
"type": "option"
|
|
1692
1828
|
},
|
|
1693
|
-
"
|
|
1694
|
-
"
|
|
1695
|
-
"
|
|
1696
|
-
"
|
|
1829
|
+
"tests": {
|
|
1830
|
+
"char": "t",
|
|
1831
|
+
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
1832
|
+
"name": "tests",
|
|
1833
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1834
|
+
"hasDynamicHelp": false,
|
|
1835
|
+
"multiple": true,
|
|
1836
|
+
"type": "option"
|
|
1837
|
+
},
|
|
1838
|
+
"test-level": {
|
|
1839
|
+
"char": "l",
|
|
1840
|
+
"description": "Valid values are:\n\n- 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.\n\n- 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.\n\n- 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.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf 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)",
|
|
1841
|
+
"name": "test-level",
|
|
1842
|
+
"summary": "Deployment Apex testing level.",
|
|
1697
1843
|
"hasDynamicHelp": false,
|
|
1698
1844
|
"multiple": false,
|
|
1845
|
+
"options": [
|
|
1846
|
+
"NoTestRun",
|
|
1847
|
+
"RunSpecifiedTests",
|
|
1848
|
+
"RunLocalTests",
|
|
1849
|
+
"RunAllTestsInOrg"
|
|
1850
|
+
],
|
|
1851
|
+
"type": "option"
|
|
1852
|
+
},
|
|
1853
|
+
"async": {
|
|
1854
|
+
"description": "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\".",
|
|
1855
|
+
"name": "async",
|
|
1856
|
+
"summary": "Run the command asynchronously.",
|
|
1857
|
+
"allowNo": false,
|
|
1858
|
+
"type": "boolean"
|
|
1859
|
+
},
|
|
1860
|
+
"wait": {
|
|
1861
|
+
"char": "w",
|
|
1862
|
+
"description": "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\".",
|
|
1863
|
+
"exclusive": [
|
|
1864
|
+
"async"
|
|
1865
|
+
],
|
|
1866
|
+
"name": "wait",
|
|
1867
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1868
|
+
"default": "33 minutes",
|
|
1869
|
+
"hasDynamicHelp": true,
|
|
1870
|
+
"helpValue": "<minutes>",
|
|
1871
|
+
"multiple": false,
|
|
1699
1872
|
"type": "option"
|
|
1873
|
+
},
|
|
1874
|
+
"verbose": {
|
|
1875
|
+
"name": "verbose",
|
|
1876
|
+
"summary": "Show verbose output of the command result.",
|
|
1877
|
+
"allowNo": false,
|
|
1878
|
+
"type": "boolean"
|
|
1879
|
+
},
|
|
1880
|
+
"concise": {
|
|
1881
|
+
"exclusive": [
|
|
1882
|
+
"verbose"
|
|
1883
|
+
],
|
|
1884
|
+
"name": "concise",
|
|
1885
|
+
"summary": "Show concise output of the command result.",
|
|
1886
|
+
"allowNo": false,
|
|
1887
|
+
"type": "boolean"
|
|
1700
1888
|
}
|
|
1701
1889
|
},
|
|
1702
1890
|
"hasDynamicHelp": true,
|
|
1703
1891
|
"hiddenAliases": [],
|
|
1704
|
-
"id": "
|
|
1892
|
+
"id": "project:deploy:pipeline:start",
|
|
1705
1893
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1706
1894
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
1707
1895
|
"pluginType": "core",
|
|
1896
|
+
"state": "beta",
|
|
1708
1897
|
"strict": true,
|
|
1709
|
-
"summary": "
|
|
1898
|
+
"summary": "Deploy changes from a branch to the pipeline stage’s org.",
|
|
1710
1899
|
"enableJsonFlag": true,
|
|
1711
1900
|
"isESM": true,
|
|
1712
1901
|
"relativePath": [
|
|
1713
1902
|
"lib",
|
|
1714
1903
|
"commands",
|
|
1715
|
-
"
|
|
1904
|
+
"project",
|
|
1905
|
+
"deploy",
|
|
1716
1906
|
"pipeline",
|
|
1717
|
-
"
|
|
1718
|
-
"add.js"
|
|
1907
|
+
"start.js"
|
|
1719
1908
|
]
|
|
1720
1909
|
},
|
|
1721
|
-
"
|
|
1910
|
+
"project:deploy:pipeline:validate": {
|
|
1722
1911
|
"aliases": [],
|
|
1723
1912
|
"args": {},
|
|
1724
|
-
"description": "
|
|
1913
|
+
"description": "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.\n\nA 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.",
|
|
1725
1914
|
"examples": [
|
|
1726
|
-
"
|
|
1915
|
+
"Perform a validate-only deployment from the Staging branch to the Staging environment (sandbox):\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox",
|
|
1916
|
+
"Perform a validate-only deployment of all changes from the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
|
|
1727
1917
|
],
|
|
1728
1918
|
"flags": {
|
|
1729
1919
|
"json": {
|
|
@@ -1741,65 +1931,137 @@
|
|
|
1741
1931
|
"multiple": false,
|
|
1742
1932
|
"type": "option"
|
|
1743
1933
|
},
|
|
1744
|
-
"
|
|
1745
|
-
"char": "
|
|
1746
|
-
"name": "
|
|
1747
|
-
"noCacheDefault": true,
|
|
1934
|
+
"branch-name": {
|
|
1935
|
+
"char": "b",
|
|
1936
|
+
"name": "branch-name",
|
|
1748
1937
|
"required": true,
|
|
1749
|
-
"summary": "
|
|
1750
|
-
"hasDynamicHelp":
|
|
1938
|
+
"summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
|
|
1939
|
+
"hasDynamicHelp": false,
|
|
1751
1940
|
"multiple": false,
|
|
1752
1941
|
"type": "option"
|
|
1753
1942
|
},
|
|
1754
|
-
"
|
|
1755
|
-
"
|
|
1756
|
-
"
|
|
1943
|
+
"bundle-version-name": {
|
|
1944
|
+
"char": "v",
|
|
1945
|
+
"description": "You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.",
|
|
1946
|
+
"name": "bundle-version-name",
|
|
1947
|
+
"summary": "Version name of the bundle.",
|
|
1757
1948
|
"hasDynamicHelp": false,
|
|
1758
1949
|
"multiple": false,
|
|
1759
1950
|
"type": "option"
|
|
1760
1951
|
},
|
|
1761
|
-
"
|
|
1762
|
-
"
|
|
1952
|
+
"deploy-all": {
|
|
1953
|
+
"char": "a",
|
|
1954
|
+
"description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
|
|
1955
|
+
"name": "deploy-all",
|
|
1956
|
+
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
1957
|
+
"allowNo": false,
|
|
1958
|
+
"type": "boolean"
|
|
1959
|
+
},
|
|
1960
|
+
"devops-center-project-name": {
|
|
1961
|
+
"char": "p",
|
|
1962
|
+
"name": "devops-center-project-name",
|
|
1763
1963
|
"required": true,
|
|
1764
|
-
"summary": "
|
|
1964
|
+
"summary": "Name of the DevOps Center project.",
|
|
1765
1965
|
"hasDynamicHelp": false,
|
|
1766
1966
|
"multiple": false,
|
|
1767
1967
|
"type": "option"
|
|
1768
1968
|
},
|
|
1769
|
-
"
|
|
1770
|
-
"
|
|
1969
|
+
"devops-center-username": {
|
|
1970
|
+
"char": "c",
|
|
1971
|
+
"name": "devops-center-username",
|
|
1771
1972
|
"required": true,
|
|
1772
|
-
"summary": "
|
|
1973
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
1974
|
+
"hasDynamicHelp": true,
|
|
1975
|
+
"multiple": false,
|
|
1976
|
+
"type": "option"
|
|
1977
|
+
},
|
|
1978
|
+
"tests": {
|
|
1979
|
+
"char": "t",
|
|
1980
|
+
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
1981
|
+
"name": "tests",
|
|
1982
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1983
|
+
"hasDynamicHelp": false,
|
|
1984
|
+
"multiple": true,
|
|
1985
|
+
"type": "option"
|
|
1986
|
+
},
|
|
1987
|
+
"test-level": {
|
|
1988
|
+
"char": "l",
|
|
1989
|
+
"description": "Valid values are:\n\n- 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.\n\n- 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.\n\n- 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.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf 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)",
|
|
1990
|
+
"name": "test-level",
|
|
1991
|
+
"summary": "Deployment Apex testing level.",
|
|
1773
1992
|
"hasDynamicHelp": false,
|
|
1774
1993
|
"multiple": false,
|
|
1994
|
+
"options": [
|
|
1995
|
+
"NoTestRun",
|
|
1996
|
+
"RunSpecifiedTests",
|
|
1997
|
+
"RunLocalTests",
|
|
1998
|
+
"RunAllTestsInOrg"
|
|
1999
|
+
],
|
|
2000
|
+
"type": "option"
|
|
2001
|
+
},
|
|
2002
|
+
"async": {
|
|
2003
|
+
"description": "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\".",
|
|
2004
|
+
"name": "async",
|
|
2005
|
+
"summary": "Run the command asynchronously.",
|
|
2006
|
+
"allowNo": false,
|
|
2007
|
+
"type": "boolean"
|
|
2008
|
+
},
|
|
2009
|
+
"wait": {
|
|
2010
|
+
"char": "w",
|
|
2011
|
+
"description": "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\".",
|
|
2012
|
+
"exclusive": [
|
|
2013
|
+
"async"
|
|
2014
|
+
],
|
|
2015
|
+
"name": "wait",
|
|
2016
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2017
|
+
"default": "33 minutes",
|
|
2018
|
+
"hasDynamicHelp": true,
|
|
2019
|
+
"helpValue": "<minutes>",
|
|
2020
|
+
"multiple": false,
|
|
1775
2021
|
"type": "option"
|
|
2022
|
+
},
|
|
2023
|
+
"verbose": {
|
|
2024
|
+
"name": "verbose",
|
|
2025
|
+
"summary": "Show verbose output of the command result.",
|
|
2026
|
+
"allowNo": false,
|
|
2027
|
+
"type": "boolean"
|
|
2028
|
+
},
|
|
2029
|
+
"concise": {
|
|
2030
|
+
"exclusive": [
|
|
2031
|
+
"verbose"
|
|
2032
|
+
],
|
|
2033
|
+
"name": "concise",
|
|
2034
|
+
"summary": "Show concise output of the command result.",
|
|
2035
|
+
"allowNo": false,
|
|
2036
|
+
"type": "boolean"
|
|
1776
2037
|
}
|
|
1777
2038
|
},
|
|
1778
2039
|
"hasDynamicHelp": true,
|
|
1779
2040
|
"hiddenAliases": [],
|
|
1780
|
-
"id": "
|
|
2041
|
+
"id": "project:deploy:pipeline:validate",
|
|
1781
2042
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1782
2043
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
1783
2044
|
"pluginType": "core",
|
|
2045
|
+
"state": "beta",
|
|
1784
2046
|
"strict": true,
|
|
1785
|
-
"summary": "
|
|
2047
|
+
"summary": "Perform a validate-only deployment from a branch to the pipeline stage’s org.",
|
|
1786
2048
|
"enableJsonFlag": true,
|
|
1787
2049
|
"isESM": true,
|
|
1788
2050
|
"relativePath": [
|
|
1789
2051
|
"lib",
|
|
1790
2052
|
"commands",
|
|
1791
|
-
"
|
|
2053
|
+
"project",
|
|
2054
|
+
"deploy",
|
|
1792
2055
|
"pipeline",
|
|
1793
|
-
"
|
|
1794
|
-
"delete.js"
|
|
2056
|
+
"validate.js"
|
|
1795
2057
|
]
|
|
1796
2058
|
},
|
|
1797
|
-
"devops:pipeline:
|
|
2059
|
+
"devops:pipeline:project:add": {
|
|
1798
2060
|
"aliases": [],
|
|
1799
2061
|
"args": {},
|
|
1800
|
-
"description": "
|
|
2062
|
+
"description": "You can attach a project to only one pipeline.",
|
|
1801
2063
|
"examples": [
|
|
1802
|
-
"
|
|
2064
|
+
"Attach a project to a pipeline using the project ID and pipeline ID.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id 0Hn000000000001"
|
|
1803
2065
|
],
|
|
1804
2066
|
"flags": {
|
|
1805
2067
|
"json": {
|
|
@@ -1834,20 +2096,18 @@
|
|
|
1834
2096
|
"multiple": false,
|
|
1835
2097
|
"type": "option"
|
|
1836
2098
|
},
|
|
1837
|
-
"
|
|
1838
|
-
"
|
|
1839
|
-
"name": "stage-id",
|
|
2099
|
+
"pipeline-id": {
|
|
2100
|
+
"name": "pipeline-id",
|
|
1840
2101
|
"required": true,
|
|
1841
|
-
"summary": "ID of the pipeline
|
|
2102
|
+
"summary": "ID of the pipeline.",
|
|
1842
2103
|
"hasDynamicHelp": false,
|
|
1843
2104
|
"multiple": false,
|
|
1844
2105
|
"type": "option"
|
|
1845
2106
|
},
|
|
1846
|
-
"
|
|
1847
|
-
"
|
|
1848
|
-
"name": "name",
|
|
2107
|
+
"project-id": {
|
|
2108
|
+
"name": "project-id",
|
|
1849
2109
|
"required": true,
|
|
1850
|
-
"summary": "
|
|
2110
|
+
"summary": "ID of the DevOps Center project.",
|
|
1851
2111
|
"hasDynamicHelp": false,
|
|
1852
2112
|
"multiple": false,
|
|
1853
2113
|
"type": "option"
|
|
@@ -1855,12 +2115,12 @@
|
|
|
1855
2115
|
},
|
|
1856
2116
|
"hasDynamicHelp": true,
|
|
1857
2117
|
"hiddenAliases": [],
|
|
1858
|
-
"id": "devops:pipeline:
|
|
2118
|
+
"id": "devops:pipeline:project:add",
|
|
1859
2119
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1860
2120
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
1861
2121
|
"pluginType": "core",
|
|
1862
2122
|
"strict": true,
|
|
1863
|
-
"summary": "
|
|
2123
|
+
"summary": "Attach a DevOps Center project to a pipeline.",
|
|
1864
2124
|
"enableJsonFlag": true,
|
|
1865
2125
|
"isESM": true,
|
|
1866
2126
|
"relativePath": [
|
|
@@ -1868,17 +2128,16 @@
|
|
|
1868
2128
|
"commands",
|
|
1869
2129
|
"devops",
|
|
1870
2130
|
"pipeline",
|
|
1871
|
-
"
|
|
1872
|
-
"
|
|
2131
|
+
"project",
|
|
2132
|
+
"add.js"
|
|
1873
2133
|
]
|
|
1874
2134
|
},
|
|
1875
|
-
"devops:
|
|
2135
|
+
"devops:pipeline:project:delete": {
|
|
1876
2136
|
"aliases": [],
|
|
1877
2137
|
"args": {},
|
|
1878
|
-
"description": "
|
|
2138
|
+
"description": "Deletes the junction record that connects the project to the pipeline. The project itself is not deleted.",
|
|
1879
2139
|
"examples": [
|
|
1880
|
-
"
|
|
1881
|
-
"Create and add a branch to a pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000002 --branch-name integration --create-vcs-branch"
|
|
2140
|
+
"Remove a project from a pipeline using the project ID and pipeline ID.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id 0Hn000000000001"
|
|
1882
2141
|
],
|
|
1883
2142
|
"flags": {
|
|
1884
2143
|
"json": {
|
|
@@ -1916,66 +2175,46 @@
|
|
|
1916
2175
|
"pipeline-id": {
|
|
1917
2176
|
"name": "pipeline-id",
|
|
1918
2177
|
"required": true,
|
|
1919
|
-
"summary": "ID of the pipeline
|
|
1920
|
-
"hasDynamicHelp": false,
|
|
1921
|
-
"multiple": false,
|
|
1922
|
-
"type": "option"
|
|
1923
|
-
},
|
|
1924
|
-
"stage-id": {
|
|
1925
|
-
"name": "stage-id",
|
|
1926
|
-
"required": true,
|
|
1927
|
-
"summary": "ID of the pipeline stage to associate the branch with.",
|
|
2178
|
+
"summary": "ID of the pipeline.",
|
|
1928
2179
|
"hasDynamicHelp": false,
|
|
1929
2180
|
"multiple": false,
|
|
1930
2181
|
"type": "option"
|
|
1931
2182
|
},
|
|
1932
|
-
"
|
|
1933
|
-
"
|
|
1934
|
-
"name": "branch-name",
|
|
2183
|
+
"project-id": {
|
|
2184
|
+
"name": "project-id",
|
|
1935
2185
|
"required": true,
|
|
1936
|
-
"summary": "
|
|
2186
|
+
"summary": "ID of the DevOps Center project.",
|
|
1937
2187
|
"hasDynamicHelp": false,
|
|
1938
2188
|
"multiple": false,
|
|
1939
2189
|
"type": "option"
|
|
1940
|
-
},
|
|
1941
|
-
"create-vcs-branch": {
|
|
1942
|
-
"name": "create-vcs-branch",
|
|
1943
|
-
"summary": "Create the branch in the remote repository if it doesn't already exist.",
|
|
1944
|
-
"allowNo": false,
|
|
1945
|
-
"type": "boolean"
|
|
1946
|
-
},
|
|
1947
|
-
"force": {
|
|
1948
|
-
"name": "force",
|
|
1949
|
-
"summary": "Replace the stage's existing branch. By default, the command blocks if the stage already has a branch to avoid orphaning it. With this flag, the new branch is associated and the previous branch record is removed if no other stage references it.",
|
|
1950
|
-
"allowNo": false,
|
|
1951
|
-
"type": "boolean"
|
|
1952
2190
|
}
|
|
1953
2191
|
},
|
|
1954
2192
|
"hasDynamicHelp": true,
|
|
1955
2193
|
"hiddenAliases": [],
|
|
1956
|
-
"id": "devops:
|
|
2194
|
+
"id": "devops:pipeline:project:delete",
|
|
1957
2195
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
1958
2196
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
1959
2197
|
"pluginType": "core",
|
|
1960
2198
|
"strict": true,
|
|
1961
|
-
"summary": "
|
|
2199
|
+
"summary": "Remove a DevOps Center project's connection to a pipeline.",
|
|
1962
2200
|
"enableJsonFlag": true,
|
|
1963
2201
|
"isESM": true,
|
|
1964
2202
|
"relativePath": [
|
|
1965
2203
|
"lib",
|
|
1966
2204
|
"commands",
|
|
1967
2205
|
"devops",
|
|
1968
|
-
"
|
|
1969
|
-
"
|
|
1970
|
-
"
|
|
2206
|
+
"pipeline",
|
|
2207
|
+
"project",
|
|
2208
|
+
"delete.js"
|
|
1971
2209
|
]
|
|
1972
2210
|
},
|
|
1973
|
-
"devops:stage:
|
|
2211
|
+
"devops:pipeline:stage:add": {
|
|
1974
2212
|
"aliases": [],
|
|
1975
2213
|
"args": {},
|
|
1976
|
-
"description": "
|
|
2214
|
+
"description": "Inserts an empty stage before the stage specified by `--next-stage-id`. The new stage doesn't include a branch or environment. Configure them separately after you create the stage.",
|
|
1977
2215
|
"examples": [
|
|
1978
|
-
"
|
|
2216
|
+
"Add a Development stage before Integration in a specific pipeline.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --name \"Development\" --next-stage-id 0Xc000000000002",
|
|
2217
|
+
"Add a QA stage before UAT in a specific pipeline.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --name \"QA\" --next-stage-id 0Xc000000000003"
|
|
1979
2218
|
],
|
|
1980
2219
|
"flags": {
|
|
1981
2220
|
"json": {
|
|
@@ -2013,15 +2252,24 @@
|
|
|
2013
2252
|
"pipeline-id": {
|
|
2014
2253
|
"name": "pipeline-id",
|
|
2015
2254
|
"required": true,
|
|
2016
|
-
"summary": "ID of the pipeline
|
|
2255
|
+
"summary": "ID of the pipeline where the stage is added.",
|
|
2017
2256
|
"hasDynamicHelp": false,
|
|
2018
2257
|
"multiple": false,
|
|
2019
2258
|
"type": "option"
|
|
2020
2259
|
},
|
|
2021
|
-
"
|
|
2022
|
-
"
|
|
2260
|
+
"name": {
|
|
2261
|
+
"char": "n",
|
|
2262
|
+
"name": "name",
|
|
2023
2263
|
"required": true,
|
|
2024
|
-
"summary": "
|
|
2264
|
+
"summary": "Name of the pipeline stage, such as Integration, UAT, or Staging.",
|
|
2265
|
+
"hasDynamicHelp": false,
|
|
2266
|
+
"multiple": false,
|
|
2267
|
+
"type": "option"
|
|
2268
|
+
},
|
|
2269
|
+
"next-stage-id": {
|
|
2270
|
+
"name": "next-stage-id",
|
|
2271
|
+
"required": true,
|
|
2272
|
+
"summary": "ID of the stage that follows the new stage in the pipeline.",
|
|
2025
2273
|
"hasDynamicHelp": false,
|
|
2026
2274
|
"multiple": false,
|
|
2027
2275
|
"type": "option"
|
|
@@ -2029,29 +2277,29 @@
|
|
|
2029
2277
|
},
|
|
2030
2278
|
"hasDynamicHelp": true,
|
|
2031
2279
|
"hiddenAliases": [],
|
|
2032
|
-
"id": "devops:stage:
|
|
2280
|
+
"id": "devops:pipeline:stage:add",
|
|
2033
2281
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2034
2282
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2035
2283
|
"pluginType": "core",
|
|
2036
2284
|
"strict": true,
|
|
2037
|
-
"summary": "
|
|
2285
|
+
"summary": "Add a stage to a DevOps Center pipeline.",
|
|
2038
2286
|
"enableJsonFlag": true,
|
|
2039
2287
|
"isESM": true,
|
|
2040
2288
|
"relativePath": [
|
|
2041
2289
|
"lib",
|
|
2042
2290
|
"commands",
|
|
2043
2291
|
"devops",
|
|
2292
|
+
"pipeline",
|
|
2044
2293
|
"stage",
|
|
2045
|
-
"
|
|
2046
|
-
"delete.js"
|
|
2294
|
+
"add.js"
|
|
2047
2295
|
]
|
|
2048
2296
|
},
|
|
2049
|
-
"devops:stage:
|
|
2297
|
+
"devops:pipeline:stage:delete": {
|
|
2050
2298
|
"aliases": [],
|
|
2051
2299
|
"args": {},
|
|
2052
|
-
"description": "
|
|
2300
|
+
"description": "Deletes the specified stage from the pipeline. If the stage sits between two other stages, the predecessor stage is automatically re-linked to the successor so the pipeline chain stays intact.",
|
|
2053
2301
|
"examples": [
|
|
2054
|
-
"
|
|
2302
|
+
"Delete a stage from a pipeline:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --stage-id 0Xc000000000002"
|
|
2055
2303
|
],
|
|
2056
2304
|
"flags": {
|
|
2057
2305
|
"json": {
|
|
@@ -2097,70 +2345,37 @@
|
|
|
2097
2345
|
"stage-id": {
|
|
2098
2346
|
"name": "stage-id",
|
|
2099
2347
|
"required": true,
|
|
2100
|
-
"summary": "ID of the
|
|
2101
|
-
"hasDynamicHelp": false,
|
|
2102
|
-
"multiple": false,
|
|
2103
|
-
"type": "option"
|
|
2104
|
-
},
|
|
2105
|
-
"environment-name": {
|
|
2106
|
-
"char": "e",
|
|
2107
|
-
"name": "environment-name",
|
|
2108
|
-
"required": true,
|
|
2109
|
-
"summary": "Name of the environment.",
|
|
2348
|
+
"summary": "ID of the stage to delete.",
|
|
2110
2349
|
"hasDynamicHelp": false,
|
|
2111
2350
|
"multiple": false,
|
|
2112
2351
|
"type": "option"
|
|
2113
|
-
},
|
|
2114
|
-
"org-type": {
|
|
2115
|
-
"name": "org-type",
|
|
2116
|
-
"required": true,
|
|
2117
|
-
"summary": "Type of the Salesforce org. Valid values: Production, Sandbox.",
|
|
2118
|
-
"hasDynamicHelp": false,
|
|
2119
|
-
"multiple": false,
|
|
2120
|
-
"options": [
|
|
2121
|
-
"Production",
|
|
2122
|
-
"Sandbox"
|
|
2123
|
-
],
|
|
2124
|
-
"type": "option"
|
|
2125
|
-
},
|
|
2126
|
-
"no-browser": {
|
|
2127
|
-
"name": "no-browser",
|
|
2128
|
-
"summary": "Don't auto-open the browser for OAuth authentication. The redirect URL is printed for manual use.",
|
|
2129
|
-
"allowNo": false,
|
|
2130
|
-
"type": "boolean"
|
|
2131
|
-
},
|
|
2132
|
-
"force": {
|
|
2133
|
-
"name": "force",
|
|
2134
|
-
"summary": "Replace the stage's existing environment. By default, the command blocks if the stage already has an environment to avoid orphaning it. With this flag, the new environment is added first and the previous one is removed only after the new environment is associated successfully.",
|
|
2135
|
-
"allowNo": false,
|
|
2136
|
-
"type": "boolean"
|
|
2137
2352
|
}
|
|
2138
2353
|
},
|
|
2139
2354
|
"hasDynamicHelp": true,
|
|
2140
2355
|
"hiddenAliases": [],
|
|
2141
|
-
"id": "devops:stage:
|
|
2356
|
+
"id": "devops:pipeline:stage:delete",
|
|
2142
2357
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2143
2358
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2144
2359
|
"pluginType": "core",
|
|
2145
2360
|
"strict": true,
|
|
2146
|
-
"summary": "
|
|
2361
|
+
"summary": "Delete a stage from a DevOps Center pipeline.",
|
|
2147
2362
|
"enableJsonFlag": true,
|
|
2148
2363
|
"isESM": true,
|
|
2149
2364
|
"relativePath": [
|
|
2150
2365
|
"lib",
|
|
2151
2366
|
"commands",
|
|
2152
2367
|
"devops",
|
|
2368
|
+
"pipeline",
|
|
2153
2369
|
"stage",
|
|
2154
|
-
"
|
|
2155
|
-
"add.js"
|
|
2370
|
+
"delete.js"
|
|
2156
2371
|
]
|
|
2157
2372
|
},
|
|
2158
|
-
"devops:stage:
|
|
2373
|
+
"devops:pipeline:stage:update": {
|
|
2159
2374
|
"aliases": [],
|
|
2160
2375
|
"args": {},
|
|
2161
|
-
"description": "
|
|
2376
|
+
"description": "Updates the name of a pipeline stage.",
|
|
2162
2377
|
"examples": [
|
|
2163
|
-
"
|
|
2378
|
+
"Rename a pipeline stage.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --stage-id 1QV000000000001 --name \"Integration\""
|
|
2164
2379
|
],
|
|
2165
2380
|
"flags": {
|
|
2166
2381
|
"json": {
|
|
@@ -2195,19 +2410,20 @@
|
|
|
2195
2410
|
"multiple": false,
|
|
2196
2411
|
"type": "option"
|
|
2197
2412
|
},
|
|
2198
|
-
"
|
|
2199
|
-
"
|
|
2413
|
+
"stage-id": {
|
|
2414
|
+
"char": "s",
|
|
2415
|
+
"name": "stage-id",
|
|
2200
2416
|
"required": true,
|
|
2201
|
-
"summary": "ID of the pipeline
|
|
2417
|
+
"summary": "ID of the pipeline stage to update.",
|
|
2202
2418
|
"hasDynamicHelp": false,
|
|
2203
2419
|
"multiple": false,
|
|
2204
2420
|
"type": "option"
|
|
2205
2421
|
},
|
|
2206
|
-
"
|
|
2207
|
-
"char": "
|
|
2208
|
-
"name": "
|
|
2422
|
+
"name": {
|
|
2423
|
+
"char": "n",
|
|
2424
|
+
"name": "name",
|
|
2209
2425
|
"required": true,
|
|
2210
|
-
"summary": "
|
|
2426
|
+
"summary": "New name for the pipeline stage.",
|
|
2211
2427
|
"hasDynamicHelp": false,
|
|
2212
2428
|
"multiple": false,
|
|
2213
2429
|
"type": "option"
|
|
@@ -2215,30 +2431,30 @@
|
|
|
2215
2431
|
},
|
|
2216
2432
|
"hasDynamicHelp": true,
|
|
2217
2433
|
"hiddenAliases": [],
|
|
2218
|
-
"id": "devops:stage:
|
|
2434
|
+
"id": "devops:pipeline:stage:update",
|
|
2219
2435
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2220
2436
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2221
2437
|
"pluginType": "core",
|
|
2222
2438
|
"strict": true,
|
|
2223
|
-
"summary": "
|
|
2439
|
+
"summary": "Update a DevOps Center pipeline stage.",
|
|
2224
2440
|
"enableJsonFlag": true,
|
|
2225
2441
|
"isESM": true,
|
|
2226
2442
|
"relativePath": [
|
|
2227
2443
|
"lib",
|
|
2228
2444
|
"commands",
|
|
2229
2445
|
"devops",
|
|
2446
|
+
"pipeline",
|
|
2230
2447
|
"stage",
|
|
2231
|
-
"
|
|
2232
|
-
"delete.js"
|
|
2448
|
+
"update.js"
|
|
2233
2449
|
]
|
|
2234
2450
|
},
|
|
2235
|
-
"
|
|
2451
|
+
"devops:stage:branch:add": {
|
|
2236
2452
|
"aliases": [],
|
|
2237
2453
|
"args": {},
|
|
2238
|
-
"description": "
|
|
2454
|
+
"description": "By default, the branch must exist in the repository. Use --create-vcs-branch to create a branch if it doesn't exist.\nEach pipeline stage supports only one branch. If the stage already has a branch, the command blocks so the existing branch isn't orphaned; pass --force to replace it.",
|
|
2239
2455
|
"examples": [
|
|
2240
|
-
"
|
|
2241
|
-
"
|
|
2456
|
+
"Add an existing branch to a stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000001 --branch-name main",
|
|
2457
|
+
"Create and add a branch to a pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000002 --branch-name integration --create-vcs-branch"
|
|
2242
2458
|
],
|
|
2243
2459
|
"flags": {
|
|
2244
2460
|
"json": {
|
|
@@ -2256,96 +2472,86 @@
|
|
|
2256
2472
|
"multiple": false,
|
|
2257
2473
|
"type": "option"
|
|
2258
2474
|
},
|
|
2259
|
-
"
|
|
2260
|
-
"
|
|
2261
|
-
"name": "
|
|
2262
|
-
"
|
|
2263
|
-
"
|
|
2264
|
-
"
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
"
|
|
2268
|
-
"verbose"
|
|
2269
|
-
],
|
|
2270
|
-
"name": "concise",
|
|
2271
|
-
"summary": "Show concise output of the command result.",
|
|
2272
|
-
"allowNo": false,
|
|
2273
|
-
"type": "boolean"
|
|
2475
|
+
"target-org": {
|
|
2476
|
+
"char": "o",
|
|
2477
|
+
"name": "target-org",
|
|
2478
|
+
"noCacheDefault": true,
|
|
2479
|
+
"required": true,
|
|
2480
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2481
|
+
"hasDynamicHelp": true,
|
|
2482
|
+
"multiple": false,
|
|
2483
|
+
"type": "option"
|
|
2274
2484
|
},
|
|
2275
|
-
"
|
|
2276
|
-
"
|
|
2277
|
-
"
|
|
2278
|
-
"
|
|
2279
|
-
"
|
|
2485
|
+
"api-version": {
|
|
2486
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2487
|
+
"name": "api-version",
|
|
2488
|
+
"hasDynamicHelp": false,
|
|
2489
|
+
"multiple": false,
|
|
2490
|
+
"type": "option"
|
|
2280
2491
|
},
|
|
2281
|
-
"
|
|
2282
|
-
"
|
|
2283
|
-
"
|
|
2284
|
-
"
|
|
2285
|
-
|
|
2286
|
-
],
|
|
2287
|
-
"name": "wait",
|
|
2288
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2289
|
-
"default": "33 minutes",
|
|
2290
|
-
"hasDynamicHelp": true,
|
|
2291
|
-
"helpValue": "<minutes>",
|
|
2492
|
+
"pipeline-id": {
|
|
2493
|
+
"name": "pipeline-id",
|
|
2494
|
+
"required": true,
|
|
2495
|
+
"summary": "ID of the pipeline that contains the stage.",
|
|
2496
|
+
"hasDynamicHelp": false,
|
|
2292
2497
|
"multiple": false,
|
|
2293
2498
|
"type": "option"
|
|
2294
2499
|
},
|
|
2295
|
-
"
|
|
2296
|
-
"
|
|
2297
|
-
"name": "devops-center-username",
|
|
2500
|
+
"stage-id": {
|
|
2501
|
+
"name": "stage-id",
|
|
2298
2502
|
"required": true,
|
|
2299
|
-
"summary": "
|
|
2300
|
-
"hasDynamicHelp":
|
|
2503
|
+
"summary": "ID of the pipeline stage to associate the branch with.",
|
|
2504
|
+
"hasDynamicHelp": false,
|
|
2301
2505
|
"multiple": false,
|
|
2302
2506
|
"type": "option"
|
|
2303
2507
|
},
|
|
2304
|
-
"
|
|
2305
|
-
"char": "
|
|
2306
|
-
"
|
|
2307
|
-
"
|
|
2308
|
-
"summary": "
|
|
2508
|
+
"branch-name": {
|
|
2509
|
+
"char": "b",
|
|
2510
|
+
"name": "branch-name",
|
|
2511
|
+
"required": true,
|
|
2512
|
+
"summary": "Name of the repository branch to assign to the stage.",
|
|
2309
2513
|
"hasDynamicHelp": false,
|
|
2310
2514
|
"multiple": false,
|
|
2311
2515
|
"type": "option"
|
|
2312
2516
|
},
|
|
2313
|
-
"
|
|
2314
|
-
"
|
|
2315
|
-
"
|
|
2316
|
-
"
|
|
2317
|
-
"
|
|
2517
|
+
"create-vcs-branch": {
|
|
2518
|
+
"name": "create-vcs-branch",
|
|
2519
|
+
"summary": "Create the branch in the remote repository if it doesn't already exist.",
|
|
2520
|
+
"allowNo": false,
|
|
2521
|
+
"type": "boolean"
|
|
2522
|
+
},
|
|
2523
|
+
"force": {
|
|
2524
|
+
"name": "force",
|
|
2525
|
+
"summary": "Replace the stage's existing branch. By default, the command blocks if the stage already has a branch to avoid orphaning it. With this flag, the new branch is associated and the previous branch record is removed if no other stage references it.",
|
|
2318
2526
|
"allowNo": false,
|
|
2319
2527
|
"type": "boolean"
|
|
2320
2528
|
}
|
|
2321
2529
|
},
|
|
2322
2530
|
"hasDynamicHelp": true,
|
|
2323
2531
|
"hiddenAliases": [],
|
|
2324
|
-
"id": "
|
|
2532
|
+
"id": "devops:stage:branch:add",
|
|
2325
2533
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2326
2534
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2327
2535
|
"pluginType": "core",
|
|
2328
|
-
"state": "beta",
|
|
2329
2536
|
"strict": true,
|
|
2330
|
-
"summary": "
|
|
2537
|
+
"summary": "Add a source code repository branch to a pipeline stage.",
|
|
2331
2538
|
"enableJsonFlag": true,
|
|
2332
2539
|
"isESM": true,
|
|
2333
2540
|
"relativePath": [
|
|
2334
2541
|
"lib",
|
|
2335
2542
|
"commands",
|
|
2336
|
-
"
|
|
2337
|
-
"
|
|
2338
|
-
"
|
|
2339
|
-
"
|
|
2543
|
+
"devops",
|
|
2544
|
+
"stage",
|
|
2545
|
+
"branch",
|
|
2546
|
+
"add.js"
|
|
2340
2547
|
]
|
|
2341
2548
|
},
|
|
2342
|
-
"
|
|
2549
|
+
"devops:stage:branch:delete": {
|
|
2343
2550
|
"aliases": [],
|
|
2344
2551
|
"args": {},
|
|
2345
|
-
"description": "
|
|
2552
|
+
"description": "Removes the branch linked to the specified pipeline stage. Because branches are configured from right to left (a stage can have a branch only after the stage to its right does), removing a branch also removes the branches from all upstream stages (to the left) in the pipeline, keeping it in a valid state. The branch records in the repository are not deleted; only their association with the stages is removed. The stage must belong to an inactive pipeline.",
|
|
2346
2553
|
"examples": [
|
|
2347
|
-
"
|
|
2348
|
-
"Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --use-most-recent"
|
|
2554
|
+
"Delete the branch associated with a pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000001"
|
|
2349
2555
|
],
|
|
2350
2556
|
"flags": {
|
|
2351
2557
|
"json": {
|
|
@@ -2363,60 +2569,65 @@
|
|
|
2363
2569
|
"multiple": false,
|
|
2364
2570
|
"type": "option"
|
|
2365
2571
|
},
|
|
2366
|
-
"
|
|
2367
|
-
"char": "
|
|
2368
|
-
"name": "
|
|
2572
|
+
"target-org": {
|
|
2573
|
+
"char": "o",
|
|
2574
|
+
"name": "target-org",
|
|
2575
|
+
"noCacheDefault": true,
|
|
2369
2576
|
"required": true,
|
|
2370
|
-
"summary": "Username or alias of the
|
|
2577
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2371
2578
|
"hasDynamicHelp": true,
|
|
2372
2579
|
"multiple": false,
|
|
2373
2580
|
"type": "option"
|
|
2374
2581
|
},
|
|
2375
|
-
"
|
|
2376
|
-
"
|
|
2377
|
-
"
|
|
2378
|
-
"name": "job-id",
|
|
2379
|
-
"summary": "Job ID of the pipeline deployment to check the status of.",
|
|
2582
|
+
"api-version": {
|
|
2583
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2584
|
+
"name": "api-version",
|
|
2380
2585
|
"hasDynamicHelp": false,
|
|
2381
2586
|
"multiple": false,
|
|
2382
2587
|
"type": "option"
|
|
2383
2588
|
},
|
|
2384
|
-
"
|
|
2385
|
-
"
|
|
2386
|
-
"
|
|
2387
|
-
"
|
|
2388
|
-
"
|
|
2389
|
-
"
|
|
2390
|
-
"type": "
|
|
2589
|
+
"pipeline-id": {
|
|
2590
|
+
"name": "pipeline-id",
|
|
2591
|
+
"required": true,
|
|
2592
|
+
"summary": "ID of the pipeline that contains the stage. Used to verify the pipeline is inactive before deleting.",
|
|
2593
|
+
"hasDynamicHelp": false,
|
|
2594
|
+
"multiple": false,
|
|
2595
|
+
"type": "option"
|
|
2596
|
+
},
|
|
2597
|
+
"stage-id": {
|
|
2598
|
+
"name": "stage-id",
|
|
2599
|
+
"required": true,
|
|
2600
|
+
"summary": "ID of the pipeline stage whose branch you want to delete.",
|
|
2601
|
+
"hasDynamicHelp": false,
|
|
2602
|
+
"multiple": false,
|
|
2603
|
+
"type": "option"
|
|
2391
2604
|
}
|
|
2392
2605
|
},
|
|
2393
2606
|
"hasDynamicHelp": true,
|
|
2394
2607
|
"hiddenAliases": [],
|
|
2395
|
-
"id": "
|
|
2608
|
+
"id": "devops:stage:branch:delete",
|
|
2396
2609
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2397
2610
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2398
2611
|
"pluginType": "core",
|
|
2399
|
-
"state": "beta",
|
|
2400
2612
|
"strict": true,
|
|
2401
|
-
"summary": "
|
|
2613
|
+
"summary": "Delete the source code repository branch associated with a pipeline stage.",
|
|
2402
2614
|
"enableJsonFlag": true,
|
|
2403
2615
|
"isESM": true,
|
|
2404
2616
|
"relativePath": [
|
|
2405
2617
|
"lib",
|
|
2406
2618
|
"commands",
|
|
2407
|
-
"
|
|
2408
|
-
"
|
|
2409
|
-
"
|
|
2410
|
-
"
|
|
2619
|
+
"devops",
|
|
2620
|
+
"stage",
|
|
2621
|
+
"branch",
|
|
2622
|
+
"delete.js"
|
|
2411
2623
|
]
|
|
2412
2624
|
},
|
|
2413
|
-
"
|
|
2625
|
+
"devops:stage:environment:add": {
|
|
2414
2626
|
"aliases": [],
|
|
2415
2627
|
"args": {},
|
|
2416
|
-
"description": "
|
|
2628
|
+
"description": "This command triggers an OAuth flow to authenticate the environment. A browser window opens automatically for you to log in.",
|
|
2417
2629
|
"examples": [
|
|
2418
|
-
"
|
|
2419
|
-
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
2630
|
+
"Add a production environment to a stage using its ID:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --stage-id 0Xp000000000001 --environment-name Production_Org --org-type Production"
|
|
2420
2631
|
],
|
|
2421
2632
|
"flags": {
|
|
2422
2633
|
"json": {
|
|
@@ -2434,238 +2645,98 @@
|
|
|
2434
2645
|
"multiple": false,
|
|
2435
2646
|
"type": "option"
|
|
2436
2647
|
},
|
|
2437
|
-
"
|
|
2438
|
-
"char": "
|
|
2439
|
-
"name": "
|
|
2648
|
+
"target-org": {
|
|
2649
|
+
"char": "o",
|
|
2650
|
+
"name": "target-org",
|
|
2651
|
+
"noCacheDefault": true,
|
|
2440
2652
|
"required": true,
|
|
2441
|
-
"summary": "Username or alias of the
|
|
2653
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2442
2654
|
"hasDynamicHelp": true,
|
|
2443
2655
|
"multiple": false,
|
|
2444
2656
|
"type": "option"
|
|
2445
2657
|
},
|
|
2446
|
-
"
|
|
2447
|
-
"
|
|
2448
|
-
"
|
|
2449
|
-
"name": "job-id",
|
|
2450
|
-
"summary": "Job ID of the pipeline deploy operation you want to resume.",
|
|
2658
|
+
"api-version": {
|
|
2659
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2660
|
+
"name": "api-version",
|
|
2451
2661
|
"hasDynamicHelp": false,
|
|
2452
2662
|
"multiple": false,
|
|
2453
2663
|
"type": "option"
|
|
2454
2664
|
},
|
|
2455
|
-
"
|
|
2456
|
-
"
|
|
2457
|
-
"description": "For performance reasons, this flag uses job IDs for operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find a job ID.",
|
|
2458
|
-
"name": "use-most-recent",
|
|
2459
|
-
"summary": "Use the job ID of the most recent deploy operation.",
|
|
2460
|
-
"allowNo": false,
|
|
2461
|
-
"type": "boolean"
|
|
2462
|
-
},
|
|
2463
|
-
"concise": {
|
|
2464
|
-
"exclusive": [
|
|
2465
|
-
"verbose"
|
|
2466
|
-
],
|
|
2467
|
-
"name": "concise",
|
|
2468
|
-
"summary": "Show concise output of the command result.",
|
|
2469
|
-
"allowNo": false,
|
|
2470
|
-
"type": "boolean"
|
|
2471
|
-
},
|
|
2472
|
-
"verbose": {
|
|
2473
|
-
"name": "verbose",
|
|
2474
|
-
"summary": "Show verbose output of the command result.",
|
|
2475
|
-
"allowNo": false,
|
|
2476
|
-
"type": "boolean"
|
|
2477
|
-
},
|
|
2478
|
-
"wait": {
|
|
2479
|
-
"char": "w",
|
|
2480
|
-
"description": "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\".",
|
|
2481
|
-
"exclusive": [
|
|
2482
|
-
"async"
|
|
2483
|
-
],
|
|
2484
|
-
"name": "wait",
|
|
2485
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2486
|
-
"default": "33 minutes",
|
|
2487
|
-
"hasDynamicHelp": true,
|
|
2488
|
-
"helpValue": "<minutes>",
|
|
2489
|
-
"multiple": false,
|
|
2490
|
-
"type": "option"
|
|
2491
|
-
}
|
|
2492
|
-
},
|
|
2493
|
-
"hasDynamicHelp": true,
|
|
2494
|
-
"hiddenAliases": [],
|
|
2495
|
-
"id": "project:deploy:pipeline:resume",
|
|
2496
|
-
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2497
|
-
"pluginName": "@salesforce/plugin-devops-center",
|
|
2498
|
-
"pluginType": "core",
|
|
2499
|
-
"state": "beta",
|
|
2500
|
-
"strict": true,
|
|
2501
|
-
"summary": "Resume watching a pipeline deploy operation.",
|
|
2502
|
-
"enableJsonFlag": true,
|
|
2503
|
-
"isESM": true,
|
|
2504
|
-
"relativePath": [
|
|
2505
|
-
"lib",
|
|
2506
|
-
"commands",
|
|
2507
|
-
"project",
|
|
2508
|
-
"deploy",
|
|
2509
|
-
"pipeline",
|
|
2510
|
-
"resume.js"
|
|
2511
|
-
]
|
|
2512
|
-
},
|
|
2513
|
-
"project:deploy:pipeline:start": {
|
|
2514
|
-
"aliases": [],
|
|
2515
|
-
"args": {},
|
|
2516
|
-
"description": "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.\n\nBefore you run this command, changes in the pipeline stage's branch must be merged in the source control repository.",
|
|
2517
|
-
"examples": [
|
|
2518
|
-
"Deploy changes in the Staging branch to the Staging environment (sandbox), if the previous stage is the bundling stage:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox --bundle-version-name 1.0",
|
|
2519
|
-
"Deploy all changes in the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
|
|
2520
|
-
],
|
|
2521
|
-
"flags": {
|
|
2522
|
-
"json": {
|
|
2523
|
-
"description": "Format output as json.",
|
|
2524
|
-
"helpGroup": "GLOBAL",
|
|
2525
|
-
"name": "json",
|
|
2526
|
-
"allowNo": false,
|
|
2527
|
-
"type": "boolean"
|
|
2528
|
-
},
|
|
2529
|
-
"flags-dir": {
|
|
2530
|
-
"helpGroup": "GLOBAL",
|
|
2531
|
-
"name": "flags-dir",
|
|
2532
|
-
"summary": "Import flag values from a directory.",
|
|
2533
|
-
"hasDynamicHelp": false,
|
|
2534
|
-
"multiple": false,
|
|
2535
|
-
"type": "option"
|
|
2536
|
-
},
|
|
2537
|
-
"branch-name": {
|
|
2538
|
-
"char": "b",
|
|
2539
|
-
"name": "branch-name",
|
|
2665
|
+
"pipeline-id": {
|
|
2666
|
+
"name": "pipeline-id",
|
|
2540
2667
|
"required": true,
|
|
2541
|
-
"summary": "
|
|
2668
|
+
"summary": "ID of the pipeline that contains the stage.",
|
|
2542
2669
|
"hasDynamicHelp": false,
|
|
2543
2670
|
"multiple": false,
|
|
2544
2671
|
"type": "option"
|
|
2545
2672
|
},
|
|
2546
|
-
"
|
|
2547
|
-
"
|
|
2548
|
-
"
|
|
2549
|
-
"
|
|
2550
|
-
"summary": "Version name of the bundle.",
|
|
2673
|
+
"stage-id": {
|
|
2674
|
+
"name": "stage-id",
|
|
2675
|
+
"required": true,
|
|
2676
|
+
"summary": "ID of the pipeline stage.",
|
|
2551
2677
|
"hasDynamicHelp": false,
|
|
2552
2678
|
"multiple": false,
|
|
2553
2679
|
"type": "option"
|
|
2554
2680
|
},
|
|
2555
|
-
"
|
|
2556
|
-
"char": "
|
|
2557
|
-
"
|
|
2558
|
-
"name": "deploy-all",
|
|
2559
|
-
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
2560
|
-
"allowNo": false,
|
|
2561
|
-
"type": "boolean"
|
|
2562
|
-
},
|
|
2563
|
-
"devops-center-project-name": {
|
|
2564
|
-
"char": "p",
|
|
2565
|
-
"name": "devops-center-project-name",
|
|
2681
|
+
"environment-name": {
|
|
2682
|
+
"char": "e",
|
|
2683
|
+
"name": "environment-name",
|
|
2566
2684
|
"required": true,
|
|
2567
|
-
"summary": "Name of the
|
|
2685
|
+
"summary": "Name of the environment.",
|
|
2568
2686
|
"hasDynamicHelp": false,
|
|
2569
2687
|
"multiple": false,
|
|
2570
2688
|
"type": "option"
|
|
2571
2689
|
},
|
|
2572
|
-
"
|
|
2573
|
-
"
|
|
2574
|
-
"name": "devops-center-username",
|
|
2690
|
+
"org-type": {
|
|
2691
|
+
"name": "org-type",
|
|
2575
2692
|
"required": true,
|
|
2576
|
-
"summary": "
|
|
2577
|
-
"hasDynamicHelp": true,
|
|
2578
|
-
"multiple": false,
|
|
2579
|
-
"type": "option"
|
|
2580
|
-
},
|
|
2581
|
-
"tests": {
|
|
2582
|
-
"char": "t",
|
|
2583
|
-
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
2584
|
-
"name": "tests",
|
|
2585
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2586
|
-
"hasDynamicHelp": false,
|
|
2587
|
-
"multiple": true,
|
|
2588
|
-
"type": "option"
|
|
2589
|
-
},
|
|
2590
|
-
"test-level": {
|
|
2591
|
-
"char": "l",
|
|
2592
|
-
"description": "Valid values are:\n\n- 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.\n\n- 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.\n\n- 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.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf 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)",
|
|
2593
|
-
"name": "test-level",
|
|
2594
|
-
"summary": "Deployment Apex testing level.",
|
|
2693
|
+
"summary": "Type of the Salesforce org. Valid values: Production, Sandbox.",
|
|
2595
2694
|
"hasDynamicHelp": false,
|
|
2596
2695
|
"multiple": false,
|
|
2597
2696
|
"options": [
|
|
2598
|
-
"
|
|
2599
|
-
"
|
|
2600
|
-
"RunLocalTests",
|
|
2601
|
-
"RunAllTestsInOrg"
|
|
2602
|
-
],
|
|
2603
|
-
"type": "option"
|
|
2604
|
-
},
|
|
2605
|
-
"async": {
|
|
2606
|
-
"description": "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\".",
|
|
2607
|
-
"name": "async",
|
|
2608
|
-
"summary": "Run the command asynchronously.",
|
|
2609
|
-
"allowNo": false,
|
|
2610
|
-
"type": "boolean"
|
|
2611
|
-
},
|
|
2612
|
-
"wait": {
|
|
2613
|
-
"char": "w",
|
|
2614
|
-
"description": "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\".",
|
|
2615
|
-
"exclusive": [
|
|
2616
|
-
"async"
|
|
2697
|
+
"Production",
|
|
2698
|
+
"Sandbox"
|
|
2617
2699
|
],
|
|
2618
|
-
"name": "wait",
|
|
2619
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2620
|
-
"default": "33 minutes",
|
|
2621
|
-
"hasDynamicHelp": true,
|
|
2622
|
-
"helpValue": "<minutes>",
|
|
2623
|
-
"multiple": false,
|
|
2624
2700
|
"type": "option"
|
|
2625
2701
|
},
|
|
2626
|
-
"
|
|
2627
|
-
"name": "
|
|
2628
|
-
"summary": "
|
|
2702
|
+
"no-browser": {
|
|
2703
|
+
"name": "no-browser",
|
|
2704
|
+
"summary": "Don't auto-open the browser for OAuth authentication. The redirect URL is printed for manual use.",
|
|
2629
2705
|
"allowNo": false,
|
|
2630
2706
|
"type": "boolean"
|
|
2631
2707
|
},
|
|
2632
|
-
"
|
|
2633
|
-
"
|
|
2634
|
-
|
|
2635
|
-
],
|
|
2636
|
-
"name": "concise",
|
|
2637
|
-
"summary": "Show concise output of the command result.",
|
|
2708
|
+
"force": {
|
|
2709
|
+
"name": "force",
|
|
2710
|
+
"summary": "Replace the stage's existing environment. By default, the command blocks if the stage already has an environment to avoid orphaning it. With this flag, the new environment is added first and the previous one is removed only after the new environment is associated successfully.",
|
|
2638
2711
|
"allowNo": false,
|
|
2639
2712
|
"type": "boolean"
|
|
2640
2713
|
}
|
|
2641
2714
|
},
|
|
2642
2715
|
"hasDynamicHelp": true,
|
|
2643
2716
|
"hiddenAliases": [],
|
|
2644
|
-
"id": "
|
|
2717
|
+
"id": "devops:stage:environment:add",
|
|
2645
2718
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2646
2719
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2647
2720
|
"pluginType": "core",
|
|
2648
|
-
"state": "beta",
|
|
2649
2721
|
"strict": true,
|
|
2650
|
-
"summary": "
|
|
2722
|
+
"summary": "Add a Salesforce environment to a pipeline stage.",
|
|
2651
2723
|
"enableJsonFlag": true,
|
|
2652
2724
|
"isESM": true,
|
|
2653
2725
|
"relativePath": [
|
|
2654
2726
|
"lib",
|
|
2655
2727
|
"commands",
|
|
2656
|
-
"
|
|
2657
|
-
"
|
|
2658
|
-
"
|
|
2659
|
-
"
|
|
2728
|
+
"devops",
|
|
2729
|
+
"stage",
|
|
2730
|
+
"environment",
|
|
2731
|
+
"add.js"
|
|
2660
2732
|
]
|
|
2661
2733
|
},
|
|
2662
|
-
"
|
|
2734
|
+
"devops:stage:environment:delete": {
|
|
2663
2735
|
"aliases": [],
|
|
2664
2736
|
"args": {},
|
|
2665
|
-
"description": "
|
|
2737
|
+
"description": "Removes the specified environment from the pipeline stage. The environment must belong to an inactive pipeline.",
|
|
2666
2738
|
"examples": [
|
|
2667
|
-
"
|
|
2668
|
-
"Perform a validate-only deployment of all changes from the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
|
|
2739
|
+
"Delete an environment:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --environment-id 0Xe000000000001"
|
|
2669
2740
|
],
|
|
2670
2741
|
"flags": {
|
|
2671
2742
|
"json": {
|
|
@@ -2683,131 +2754,60 @@
|
|
|
2683
2754
|
"multiple": false,
|
|
2684
2755
|
"type": "option"
|
|
2685
2756
|
},
|
|
2686
|
-
"
|
|
2687
|
-
"char": "
|
|
2688
|
-
"name": "
|
|
2757
|
+
"target-org": {
|
|
2758
|
+
"char": "o",
|
|
2759
|
+
"name": "target-org",
|
|
2760
|
+
"noCacheDefault": true,
|
|
2689
2761
|
"required": true,
|
|
2690
|
-
"summary": "
|
|
2691
|
-
"hasDynamicHelp":
|
|
2762
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2763
|
+
"hasDynamicHelp": true,
|
|
2692
2764
|
"multiple": false,
|
|
2693
2765
|
"type": "option"
|
|
2694
2766
|
},
|
|
2695
|
-
"
|
|
2696
|
-
"
|
|
2697
|
-
"
|
|
2698
|
-
"name": "bundle-version-name",
|
|
2699
|
-
"summary": "Version name of the bundle.",
|
|
2767
|
+
"api-version": {
|
|
2768
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2769
|
+
"name": "api-version",
|
|
2700
2770
|
"hasDynamicHelp": false,
|
|
2701
2771
|
"multiple": false,
|
|
2702
2772
|
"type": "option"
|
|
2703
2773
|
},
|
|
2704
|
-
"
|
|
2705
|
-
"
|
|
2706
|
-
"description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
|
|
2707
|
-
"name": "deploy-all",
|
|
2708
|
-
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
2709
|
-
"allowNo": false,
|
|
2710
|
-
"type": "boolean"
|
|
2711
|
-
},
|
|
2712
|
-
"devops-center-project-name": {
|
|
2713
|
-
"char": "p",
|
|
2714
|
-
"name": "devops-center-project-name",
|
|
2774
|
+
"pipeline-id": {
|
|
2775
|
+
"name": "pipeline-id",
|
|
2715
2776
|
"required": true,
|
|
2716
|
-
"summary": "
|
|
2777
|
+
"summary": "ID of the pipeline. Used to verify the pipeline is inactive before deleting.",
|
|
2717
2778
|
"hasDynamicHelp": false,
|
|
2718
2779
|
"multiple": false,
|
|
2719
2780
|
"type": "option"
|
|
2720
2781
|
},
|
|
2721
|
-
"
|
|
2722
|
-
"char": "
|
|
2723
|
-
"name": "
|
|
2782
|
+
"environment-id": {
|
|
2783
|
+
"char": "e",
|
|
2784
|
+
"name": "environment-id",
|
|
2724
2785
|
"required": true,
|
|
2725
|
-
"summary": "
|
|
2726
|
-
"hasDynamicHelp": true,
|
|
2727
|
-
"multiple": false,
|
|
2728
|
-
"type": "option"
|
|
2729
|
-
},
|
|
2730
|
-
"tests": {
|
|
2731
|
-
"char": "t",
|
|
2732
|
-
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
2733
|
-
"name": "tests",
|
|
2734
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2735
|
-
"hasDynamicHelp": false,
|
|
2736
|
-
"multiple": true,
|
|
2737
|
-
"type": "option"
|
|
2738
|
-
},
|
|
2739
|
-
"test-level": {
|
|
2740
|
-
"char": "l",
|
|
2741
|
-
"description": "Valid values are:\n\n- 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.\n\n- 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.\n\n- 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.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf 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)",
|
|
2742
|
-
"name": "test-level",
|
|
2743
|
-
"summary": "Deployment Apex testing level.",
|
|
2786
|
+
"summary": "ID of the environment to delete.",
|
|
2744
2787
|
"hasDynamicHelp": false,
|
|
2745
2788
|
"multiple": false,
|
|
2746
|
-
"options": [
|
|
2747
|
-
"NoTestRun",
|
|
2748
|
-
"RunSpecifiedTests",
|
|
2749
|
-
"RunLocalTests",
|
|
2750
|
-
"RunAllTestsInOrg"
|
|
2751
|
-
],
|
|
2752
|
-
"type": "option"
|
|
2753
|
-
},
|
|
2754
|
-
"async": {
|
|
2755
|
-
"description": "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\".",
|
|
2756
|
-
"name": "async",
|
|
2757
|
-
"summary": "Run the command asynchronously.",
|
|
2758
|
-
"allowNo": false,
|
|
2759
|
-
"type": "boolean"
|
|
2760
|
-
},
|
|
2761
|
-
"wait": {
|
|
2762
|
-
"char": "w",
|
|
2763
|
-
"description": "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\".",
|
|
2764
|
-
"exclusive": [
|
|
2765
|
-
"async"
|
|
2766
|
-
],
|
|
2767
|
-
"name": "wait",
|
|
2768
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2769
|
-
"default": "33 minutes",
|
|
2770
|
-
"hasDynamicHelp": true,
|
|
2771
|
-
"helpValue": "<minutes>",
|
|
2772
|
-
"multiple": false,
|
|
2773
2789
|
"type": "option"
|
|
2774
|
-
},
|
|
2775
|
-
"verbose": {
|
|
2776
|
-
"name": "verbose",
|
|
2777
|
-
"summary": "Show verbose output of the command result.",
|
|
2778
|
-
"allowNo": false,
|
|
2779
|
-
"type": "boolean"
|
|
2780
|
-
},
|
|
2781
|
-
"concise": {
|
|
2782
|
-
"exclusive": [
|
|
2783
|
-
"verbose"
|
|
2784
|
-
],
|
|
2785
|
-
"name": "concise",
|
|
2786
|
-
"summary": "Show concise output of the command result.",
|
|
2787
|
-
"allowNo": false,
|
|
2788
|
-
"type": "boolean"
|
|
2789
2790
|
}
|
|
2790
2791
|
},
|
|
2791
2792
|
"hasDynamicHelp": true,
|
|
2792
2793
|
"hiddenAliases": [],
|
|
2793
|
-
"id": "
|
|
2794
|
+
"id": "devops:stage:environment:delete",
|
|
2794
2795
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2795
2796
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2796
2797
|
"pluginType": "core",
|
|
2797
|
-
"state": "beta",
|
|
2798
2798
|
"strict": true,
|
|
2799
|
-
"summary": "
|
|
2799
|
+
"summary": "Delete an environment from a DevOps Center pipeline stage.",
|
|
2800
2800
|
"enableJsonFlag": true,
|
|
2801
2801
|
"isESM": true,
|
|
2802
2802
|
"relativePath": [
|
|
2803
2803
|
"lib",
|
|
2804
2804
|
"commands",
|
|
2805
|
-
"
|
|
2806
|
-
"
|
|
2807
|
-
"
|
|
2808
|
-
"
|
|
2805
|
+
"devops",
|
|
2806
|
+
"stage",
|
|
2807
|
+
"environment",
|
|
2808
|
+
"delete.js"
|
|
2809
2809
|
]
|
|
2810
2810
|
}
|
|
2811
2811
|
},
|
|
2812
|
-
"version": "2.3.
|
|
2812
|
+
"version": "2.3.4"
|
|
2813
2813
|
}
|