@salesforce/plugin-deploy-retrieve 3.6.14 → 3.6.16-dev.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -17
- package/lib/commands/project/deploy/preview.js +4 -0
- package/lib/commands/project/deploy/preview.js.map +1 -1
- package/oclif.manifest.json +1044 -1044
- package/package.json +7 -9
- package/npm-shrinkwrap.json +0 -14229
- package/oclif.lock +0 -7947
package/oclif.manifest.json
CHANGED
|
@@ -218,7 +218,7 @@
|
|
|
218
218
|
"deprecateAliases": true,
|
|
219
219
|
"name": "output-dir",
|
|
220
220
|
"summary": "Output directory to store the Metadata API–formatted files in.",
|
|
221
|
-
"default": "
|
|
221
|
+
"default": "metadataPackage_1715713968400",
|
|
222
222
|
"hasDynamicHelp": false,
|
|
223
223
|
"multiple": false,
|
|
224
224
|
"type": "option"
|
|
@@ -311,16 +311,18 @@
|
|
|
311
311
|
"source:convert:project"
|
|
312
312
|
]
|
|
313
313
|
},
|
|
314
|
-
"project:
|
|
314
|
+
"project:delete:source": {
|
|
315
315
|
"aliases": [
|
|
316
|
-
"
|
|
316
|
+
"force:source:delete"
|
|
317
317
|
],
|
|
318
318
|
"args": {},
|
|
319
319
|
"deprecateAliases": true,
|
|
320
|
-
"description": "Use this command to
|
|
320
|
+
"description": "Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, \"<%= config.bin %> project deploy start\".\n\nWhen you run this command, both the local source file and the metadata component in the org are deleted.\n\nTo delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
321
321
|
"examples": [
|
|
322
|
-
"
|
|
323
|
-
"
|
|
322
|
+
"Delete all local Apex source files and all Apex classes from the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch",
|
|
323
|
+
"Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata \"Profile: My Profile\" --no-prompt",
|
|
324
|
+
"Run the tests that aren’t in any managed packages as part of the deletion; if the delete succeeds, and the org has source-tracking enabled, update the source tracking information:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source",
|
|
325
|
+
"Delete the Apex source files in a directory and the corresponding components from your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes"
|
|
324
326
|
],
|
|
325
327
|
"flags": {
|
|
326
328
|
"json": {
|
|
@@ -338,104 +340,206 @@
|
|
|
338
340
|
"multiple": false,
|
|
339
341
|
"type": "option"
|
|
340
342
|
},
|
|
343
|
+
"api-version": {
|
|
344
|
+
"aliases": [
|
|
345
|
+
"apiversion"
|
|
346
|
+
],
|
|
347
|
+
"deprecateAliases": true,
|
|
348
|
+
"description": "Override the api version used for api requests made by this command",
|
|
349
|
+
"name": "api-version",
|
|
350
|
+
"hasDynamicHelp": false,
|
|
351
|
+
"multiple": false,
|
|
352
|
+
"type": "option"
|
|
353
|
+
},
|
|
354
|
+
"loglevel": {
|
|
355
|
+
"deprecated": {
|
|
356
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
357
|
+
},
|
|
358
|
+
"hidden": true,
|
|
359
|
+
"name": "loglevel",
|
|
360
|
+
"hasDynamicHelp": false,
|
|
361
|
+
"multiple": false,
|
|
362
|
+
"type": "option"
|
|
363
|
+
},
|
|
341
364
|
"target-org": {
|
|
365
|
+
"aliases": [
|
|
366
|
+
"targetusername",
|
|
367
|
+
"u"
|
|
368
|
+
],
|
|
342
369
|
"char": "o",
|
|
343
|
-
"
|
|
370
|
+
"deprecateAliases": true,
|
|
344
371
|
"name": "target-org",
|
|
345
372
|
"noCacheDefault": true,
|
|
346
|
-
"
|
|
373
|
+
"required": true,
|
|
374
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
347
375
|
"hasDynamicHelp": true,
|
|
348
376
|
"multiple": false,
|
|
349
377
|
"type": "option"
|
|
350
378
|
},
|
|
351
|
-
"
|
|
352
|
-
"
|
|
353
|
-
|
|
354
|
-
"wait"
|
|
379
|
+
"check-only": {
|
|
380
|
+
"aliases": [
|
|
381
|
+
"checkonly"
|
|
355
382
|
],
|
|
356
|
-
"
|
|
357
|
-
"
|
|
383
|
+
"char": "c",
|
|
384
|
+
"deprecateAliases": true,
|
|
385
|
+
"description": "IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nValidates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.\n\nIf you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --chec-konly parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.\n\nIf your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.\n\nNote: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.\n\n 1. For a deletion with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to delete the Master-Detail field, or the deletion fails. During the deletion, detail records are permanently deleted from the Recycle Bin and cannot be recovered.\n\n 2. For a deletion that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deletion to succeed. However, a successful deletion permanently deletes any detail records in the Recycle Bin.",
|
|
386
|
+
"name": "check-only",
|
|
387
|
+
"summary": "Validate delete command but don't delete anything from the org or the local project.",
|
|
358
388
|
"allowNo": false,
|
|
359
389
|
"type": "boolean"
|
|
360
390
|
},
|
|
361
|
-
"
|
|
362
|
-
"char": "
|
|
363
|
-
"description": "
|
|
364
|
-
"name": "
|
|
365
|
-
"summary": "
|
|
391
|
+
"wait": {
|
|
392
|
+
"char": "w",
|
|
393
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
|
|
394
|
+
"name": "wait",
|
|
395
|
+
"summary": "Number of minutes to wait for the command to finish.",
|
|
396
|
+
"hasDynamicHelp": true,
|
|
397
|
+
"multiple": false,
|
|
398
|
+
"type": "option"
|
|
399
|
+
},
|
|
400
|
+
"tests": {
|
|
401
|
+
"description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
|
|
402
|
+
"helpGroup": "Test",
|
|
403
|
+
"name": "tests",
|
|
404
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
405
|
+
"hasDynamicHelp": false,
|
|
406
|
+
"multiple": true,
|
|
407
|
+
"type": "option"
|
|
408
|
+
},
|
|
409
|
+
"test-level": {
|
|
410
|
+
"aliases": [
|
|
411
|
+
"testlevel"
|
|
412
|
+
],
|
|
413
|
+
"char": "l",
|
|
414
|
+
"deprecateAliases": true,
|
|
415
|
+
"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 and target org. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
|
|
416
|
+
"helpGroup": "Test",
|
|
417
|
+
"name": "test-level",
|
|
418
|
+
"summary": "Deployment Apex testing level.",
|
|
366
419
|
"hasDynamicHelp": false,
|
|
367
420
|
"multiple": false,
|
|
421
|
+
"options": [
|
|
422
|
+
"NoTestRun",
|
|
423
|
+
"RunSpecifiedTests",
|
|
424
|
+
"RunLocalTests",
|
|
425
|
+
"RunAllTestsInOrg"
|
|
426
|
+
],
|
|
368
427
|
"type": "option"
|
|
369
428
|
},
|
|
370
|
-
"
|
|
429
|
+
"no-prompt": {
|
|
430
|
+
"aliases": [
|
|
431
|
+
"noprompt"
|
|
432
|
+
],
|
|
371
433
|
"char": "r",
|
|
372
|
-
"
|
|
373
|
-
"name": "
|
|
374
|
-
"summary": "
|
|
434
|
+
"deprecateAliases": true,
|
|
435
|
+
"name": "no-prompt",
|
|
436
|
+
"summary": "Don't prompt for delete confirmation.",
|
|
375
437
|
"allowNo": false,
|
|
376
438
|
"type": "boolean"
|
|
377
439
|
},
|
|
378
|
-
"
|
|
379
|
-
"char": "
|
|
380
|
-
"description": "If
|
|
381
|
-
"
|
|
382
|
-
|
|
440
|
+
"metadata": {
|
|
441
|
+
"char": "m",
|
|
442
|
+
"description": "If you specify this parameter, don’t specify --source-dir.",
|
|
443
|
+
"name": "metadata",
|
|
444
|
+
"summary": "Metadata components to delete.",
|
|
445
|
+
"delimiter": ",",
|
|
446
|
+
"hasDynamicHelp": false,
|
|
447
|
+
"multiple": true,
|
|
448
|
+
"type": "option"
|
|
449
|
+
},
|
|
450
|
+
"source-dir": {
|
|
451
|
+
"aliases": [
|
|
452
|
+
"sourcepath"
|
|
383
453
|
],
|
|
384
|
-
"
|
|
385
|
-
"
|
|
386
|
-
"
|
|
387
|
-
"
|
|
388
|
-
"
|
|
454
|
+
"char": "p",
|
|
455
|
+
"deprecateAliases": true,
|
|
456
|
+
"description": "The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this parameter, don’t specify --metadata.",
|
|
457
|
+
"name": "source-dir",
|
|
458
|
+
"summary": "Source file paths to delete.",
|
|
459
|
+
"delimiter": ",",
|
|
460
|
+
"hasDynamicHelp": false,
|
|
461
|
+
"multiple": true,
|
|
389
462
|
"type": "option"
|
|
463
|
+
},
|
|
464
|
+
"track-source": {
|
|
465
|
+
"aliases": [
|
|
466
|
+
"tracksource"
|
|
467
|
+
],
|
|
468
|
+
"char": "t",
|
|
469
|
+
"deprecateAliases": true,
|
|
470
|
+
"exclusive": [
|
|
471
|
+
"check-only"
|
|
472
|
+
],
|
|
473
|
+
"name": "track-source",
|
|
474
|
+
"summary": "If the delete succeeds, update the source tracking information.",
|
|
475
|
+
"allowNo": false,
|
|
476
|
+
"type": "boolean"
|
|
477
|
+
},
|
|
478
|
+
"force-overwrite": {
|
|
479
|
+
"aliases": [
|
|
480
|
+
"forceoverwrite"
|
|
481
|
+
],
|
|
482
|
+
"char": "f",
|
|
483
|
+
"dependsOn": [
|
|
484
|
+
"track-source"
|
|
485
|
+
],
|
|
486
|
+
"deprecateAliases": true,
|
|
487
|
+
"name": "force-overwrite",
|
|
488
|
+
"summary": "Ignore conflict warnings and overwrite changes to the org.",
|
|
489
|
+
"allowNo": false,
|
|
490
|
+
"type": "boolean"
|
|
491
|
+
},
|
|
492
|
+
"verbose": {
|
|
493
|
+
"name": "verbose",
|
|
494
|
+
"summary": "Verbose output of the delete result.",
|
|
495
|
+
"allowNo": false,
|
|
496
|
+
"type": "boolean"
|
|
390
497
|
}
|
|
391
498
|
},
|
|
392
499
|
"hasDynamicHelp": true,
|
|
393
500
|
"hiddenAliases": [],
|
|
394
|
-
"id": "project:
|
|
501
|
+
"id": "project:delete:source",
|
|
395
502
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
396
503
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
397
504
|
"pluginType": "core",
|
|
398
505
|
"strict": true,
|
|
399
|
-
"summary": "
|
|
506
|
+
"summary": "Delete source from your project and from a non-source-tracked org.",
|
|
400
507
|
"enableJsonFlag": true,
|
|
508
|
+
"requiresProject": true,
|
|
401
509
|
"isESM": true,
|
|
402
510
|
"relativePath": [
|
|
403
511
|
"lib",
|
|
404
512
|
"commands",
|
|
405
513
|
"project",
|
|
406
|
-
"
|
|
407
|
-
"
|
|
514
|
+
"delete",
|
|
515
|
+
"source.js"
|
|
408
516
|
],
|
|
409
517
|
"aliasPermutations": [
|
|
410
|
-
"
|
|
411
|
-
"
|
|
412
|
-
"
|
|
413
|
-
"
|
|
414
|
-
"
|
|
415
|
-
"
|
|
518
|
+
"force:source:delete",
|
|
519
|
+
"source:force:delete",
|
|
520
|
+
"source:delete:force",
|
|
521
|
+
"force:delete:source",
|
|
522
|
+
"delete:force:source",
|
|
523
|
+
"delete:source:force"
|
|
416
524
|
],
|
|
417
525
|
"permutations": [
|
|
418
|
-
"project:
|
|
419
|
-
"
|
|
420
|
-
"
|
|
421
|
-
"project:
|
|
422
|
-
"
|
|
423
|
-
"
|
|
526
|
+
"project:delete:source",
|
|
527
|
+
"delete:project:source",
|
|
528
|
+
"delete:source:project",
|
|
529
|
+
"project:source:delete",
|
|
530
|
+
"source:project:delete",
|
|
531
|
+
"source:delete:project"
|
|
424
532
|
]
|
|
425
533
|
},
|
|
426
|
-
"project:
|
|
534
|
+
"project:delete:tracking": {
|
|
427
535
|
"aliases": [
|
|
428
|
-
"
|
|
536
|
+
"force:source:tracking:clear"
|
|
429
537
|
],
|
|
430
538
|
"args": {},
|
|
431
539
|
"deprecateAliases": true,
|
|
432
|
-
"description": "
|
|
540
|
+
"description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nDeletes all local source tracking information. When you next run 'project deploy preview', Salesforce CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts.",
|
|
433
541
|
"examples": [
|
|
434
|
-
"
|
|
435
|
-
"Preview the deployment of source files in a directory, such as force-app, to your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
|
|
436
|
-
"Preview the deployment of all Apex classes to an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch",
|
|
437
|
-
"Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
438
|
-
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
542
|
+
"Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
|
|
439
543
|
],
|
|
440
544
|
"flags": {
|
|
441
545
|
"json": {
|
|
@@ -453,78 +557,62 @@
|
|
|
453
557
|
"multiple": false,
|
|
454
558
|
"type": "option"
|
|
455
559
|
},
|
|
456
|
-
"
|
|
457
|
-
"
|
|
458
|
-
|
|
459
|
-
"name": "ignore-conflicts",
|
|
460
|
-
"summary": "Don't display conflicts in preview of the deployment.",
|
|
461
|
-
"allowNo": false,
|
|
462
|
-
"type": "boolean"
|
|
463
|
-
},
|
|
464
|
-
"manifest": {
|
|
465
|
-
"char": "x",
|
|
466
|
-
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
467
|
-
"exclusive": [
|
|
468
|
-
"source-dir",
|
|
469
|
-
"metadata"
|
|
560
|
+
"api-version": {
|
|
561
|
+
"aliases": [
|
|
562
|
+
"apiversion"
|
|
470
563
|
],
|
|
471
|
-
"
|
|
472
|
-
"
|
|
564
|
+
"deprecateAliases": true,
|
|
565
|
+
"description": "Override the api version used for api requests made by this command",
|
|
566
|
+
"name": "api-version",
|
|
473
567
|
"hasDynamicHelp": false,
|
|
474
568
|
"multiple": false,
|
|
475
569
|
"type": "option"
|
|
476
570
|
},
|
|
477
|
-
"
|
|
478
|
-
"
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
"name": "metadata",
|
|
484
|
-
"summary": "Metadata component names to preview.",
|
|
571
|
+
"loglevel": {
|
|
572
|
+
"deprecated": {
|
|
573
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
574
|
+
},
|
|
575
|
+
"hidden": true,
|
|
576
|
+
"name": "loglevel",
|
|
485
577
|
"hasDynamicHelp": false,
|
|
486
|
-
"multiple":
|
|
487
|
-
"type": "option"
|
|
488
|
-
},
|
|
489
|
-
"source-dir": {
|
|
490
|
-
"char": "d",
|
|
491
|
-
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
|
|
492
|
-
"exclusive": [
|
|
493
|
-
"manifest",
|
|
494
|
-
"metadata"
|
|
495
|
-
],
|
|
496
|
-
"name": "source-dir",
|
|
497
|
-
"summary": "Path to the local source files to preview.",
|
|
498
|
-
"hasDynamicHelp": false,
|
|
499
|
-
"multiple": true,
|
|
578
|
+
"multiple": false,
|
|
500
579
|
"type": "option"
|
|
501
580
|
},
|
|
502
581
|
"target-org": {
|
|
582
|
+
"aliases": [
|
|
583
|
+
"targetusername",
|
|
584
|
+
"u"
|
|
585
|
+
],
|
|
503
586
|
"char": "o",
|
|
504
|
-
"
|
|
587
|
+
"deprecateAliases": true,
|
|
505
588
|
"name": "target-org",
|
|
506
589
|
"noCacheDefault": true,
|
|
507
590
|
"required": true,
|
|
508
|
-
"summary": "
|
|
591
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
509
592
|
"hasDynamicHelp": true,
|
|
510
593
|
"multiple": false,
|
|
511
594
|
"type": "option"
|
|
512
595
|
},
|
|
513
|
-
"
|
|
514
|
-
"
|
|
515
|
-
|
|
596
|
+
"no-prompt": {
|
|
597
|
+
"aliases": [
|
|
598
|
+
"noprompt"
|
|
599
|
+
],
|
|
600
|
+
"char": "p",
|
|
601
|
+
"deprecateAliases": true,
|
|
602
|
+
"name": "no-prompt",
|
|
603
|
+
"summary": "Don't prompt for source tracking override confirmation.",
|
|
516
604
|
"allowNo": false,
|
|
517
605
|
"type": "boolean"
|
|
518
606
|
}
|
|
519
607
|
},
|
|
520
608
|
"hasDynamicHelp": true,
|
|
521
609
|
"hiddenAliases": [],
|
|
522
|
-
"id": "project:
|
|
610
|
+
"id": "project:delete:tracking",
|
|
523
611
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
524
612
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
525
613
|
"pluginType": "core",
|
|
526
614
|
"strict": true,
|
|
527
|
-
"summary": "
|
|
615
|
+
"summary": "Delete all local source tracking information.",
|
|
528
616
|
"enableJsonFlag": true,
|
|
529
617
|
"requiresProject": true,
|
|
530
618
|
"isESM": true,
|
|
@@ -532,36 +620,54 @@
|
|
|
532
620
|
"lib",
|
|
533
621
|
"commands",
|
|
534
622
|
"project",
|
|
535
|
-
"
|
|
536
|
-
"
|
|
623
|
+
"delete",
|
|
624
|
+
"tracking.js"
|
|
537
625
|
],
|
|
538
626
|
"aliasPermutations": [
|
|
539
|
-
"
|
|
540
|
-
"
|
|
541
|
-
"
|
|
542
|
-
"
|
|
543
|
-
"
|
|
544
|
-
"
|
|
627
|
+
"force:source:tracking:clear",
|
|
628
|
+
"source:force:tracking:clear",
|
|
629
|
+
"source:tracking:force:clear",
|
|
630
|
+
"source:tracking:clear:force",
|
|
631
|
+
"force:tracking:source:clear",
|
|
632
|
+
"tracking:force:source:clear",
|
|
633
|
+
"tracking:source:force:clear",
|
|
634
|
+
"tracking:source:clear:force",
|
|
635
|
+
"force:tracking:clear:source",
|
|
636
|
+
"tracking:force:clear:source",
|
|
637
|
+
"tracking:clear:force:source",
|
|
638
|
+
"tracking:clear:source:force",
|
|
639
|
+
"force:source:clear:tracking",
|
|
640
|
+
"source:force:clear:tracking",
|
|
641
|
+
"source:clear:force:tracking",
|
|
642
|
+
"source:clear:tracking:force",
|
|
643
|
+
"force:clear:source:tracking",
|
|
644
|
+
"clear:force:source:tracking",
|
|
645
|
+
"clear:source:force:tracking",
|
|
646
|
+
"clear:source:tracking:force",
|
|
647
|
+
"force:clear:tracking:source",
|
|
648
|
+
"clear:force:tracking:source",
|
|
649
|
+
"clear:tracking:force:source",
|
|
650
|
+
"clear:tracking:source:force"
|
|
545
651
|
],
|
|
546
652
|
"permutations": [
|
|
547
|
-
"project:
|
|
548
|
-
"
|
|
549
|
-
"
|
|
550
|
-
"project:
|
|
551
|
-
"
|
|
552
|
-
"
|
|
653
|
+
"project:delete:tracking",
|
|
654
|
+
"delete:project:tracking",
|
|
655
|
+
"delete:tracking:project",
|
|
656
|
+
"project:tracking:delete",
|
|
657
|
+
"tracking:project:delete",
|
|
658
|
+
"tracking:delete:project"
|
|
553
659
|
]
|
|
554
660
|
},
|
|
555
|
-
"project:deploy:
|
|
661
|
+
"project:deploy:cancel": {
|
|
556
662
|
"aliases": [
|
|
557
|
-
"deploy:metadata:
|
|
663
|
+
"deploy:metadata:cancel"
|
|
558
664
|
],
|
|
559
665
|
"args": {},
|
|
560
666
|
"deprecateAliases": true,
|
|
561
|
-
"description": "
|
|
667
|
+
"description": "Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
562
668
|
"examples": [
|
|
563
|
-
"
|
|
564
|
-
"
|
|
669
|
+
"Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
670
|
+
"Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
565
671
|
],
|
|
566
672
|
"flags": {
|
|
567
673
|
"json": {
|
|
@@ -579,8 +685,18 @@
|
|
|
579
685
|
"multiple": false,
|
|
580
686
|
"type": "option"
|
|
581
687
|
},
|
|
688
|
+
"target-org": {
|
|
689
|
+
"char": "o",
|
|
690
|
+
"description": "Overrides your default org.",
|
|
691
|
+
"name": "target-org",
|
|
692
|
+
"noCacheDefault": true,
|
|
693
|
+
"summary": "Login username or alias for the target org.",
|
|
694
|
+
"hasDynamicHelp": true,
|
|
695
|
+
"multiple": false,
|
|
696
|
+
"type": "option"
|
|
697
|
+
},
|
|
582
698
|
"async": {
|
|
583
|
-
"description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the
|
|
699
|
+
"description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run \"<%= config.bin %> project deploy resume\". To check the status of the cancellation, run \"<%= config.bin %> project deploy report\".",
|
|
584
700
|
"exclusive": [
|
|
585
701
|
"wait"
|
|
586
702
|
],
|
|
@@ -589,153 +705,84 @@
|
|
|
589
705
|
"allowNo": false,
|
|
590
706
|
"type": "boolean"
|
|
591
707
|
},
|
|
592
|
-
"concise": {
|
|
593
|
-
"exclusive": [
|
|
594
|
-
"verbose"
|
|
595
|
-
],
|
|
596
|
-
"name": "concise",
|
|
597
|
-
"summary": "Show concise output of the deploy result.",
|
|
598
|
-
"allowNo": false,
|
|
599
|
-
"type": "boolean"
|
|
600
|
-
},
|
|
601
708
|
"job-id": {
|
|
602
709
|
"char": "i",
|
|
603
|
-
"description": "
|
|
710
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
604
711
|
"name": "job-id",
|
|
605
|
-
"summary": "Job ID of the
|
|
712
|
+
"summary": "Job ID of the deploy operation you want to cancel.",
|
|
606
713
|
"hasDynamicHelp": false,
|
|
607
714
|
"multiple": false,
|
|
608
715
|
"type": "option"
|
|
609
716
|
},
|
|
610
|
-
"target-org": {
|
|
611
|
-
"char": "o",
|
|
612
|
-
"description": "Overrides your default org.",
|
|
613
|
-
"name": "target-org",
|
|
614
|
-
"noCacheDefault": true,
|
|
615
|
-
"summary": "Login username or alias for the target org.",
|
|
616
|
-
"hasDynamicHelp": true,
|
|
617
|
-
"multiple": false,
|
|
618
|
-
"type": "option"
|
|
619
|
-
},
|
|
620
717
|
"use-most-recent": {
|
|
621
718
|
"char": "r",
|
|
622
|
-
"description": "For performance reasons, this flag uses
|
|
719
|
+
"description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.",
|
|
623
720
|
"name": "use-most-recent",
|
|
624
|
-
"summary": "Use the job ID of the most
|
|
625
|
-
"allowNo": false,
|
|
626
|
-
"type": "boolean"
|
|
627
|
-
},
|
|
628
|
-
"verbose": {
|
|
629
|
-
"exclusive": [
|
|
630
|
-
"concise"
|
|
631
|
-
],
|
|
632
|
-
"name": "verbose",
|
|
633
|
-
"summary": "Show verbose output of the deploy result.",
|
|
721
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
634
722
|
"allowNo": false,
|
|
635
723
|
"type": "boolean"
|
|
636
724
|
},
|
|
637
725
|
"wait": {
|
|
638
726
|
"char": "w",
|
|
639
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the
|
|
727
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run \"<%= config.bin %> project deploy resume\". To check the status of the cancellation, run \"<%= config.bin %> project deploy report\".",
|
|
640
728
|
"exclusive": [
|
|
641
729
|
"async"
|
|
642
730
|
],
|
|
643
731
|
"name": "wait",
|
|
644
732
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
645
|
-
"default": "33 minutes",
|
|
646
733
|
"hasDynamicHelp": true,
|
|
647
734
|
"helpValue": "<minutes>",
|
|
648
735
|
"multiple": false,
|
|
649
736
|
"type": "option"
|
|
650
|
-
},
|
|
651
|
-
"api-version": {
|
|
652
|
-
"char": "a",
|
|
653
|
-
"description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
|
|
654
|
-
"name": "api-version",
|
|
655
|
-
"summary": "Target API version for the deploy.",
|
|
656
|
-
"hasDynamicHelp": false,
|
|
657
|
-
"multiple": false,
|
|
658
|
-
"type": "option"
|
|
659
737
|
}
|
|
660
738
|
},
|
|
661
739
|
"hasDynamicHelp": true,
|
|
662
740
|
"hiddenAliases": [],
|
|
663
|
-
"id": "project:deploy:
|
|
741
|
+
"id": "project:deploy:cancel",
|
|
664
742
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
665
743
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
666
744
|
"pluginType": "core",
|
|
667
745
|
"strict": true,
|
|
668
|
-
"summary": "
|
|
746
|
+
"summary": "Cancel a deploy operation.",
|
|
669
747
|
"enableJsonFlag": true,
|
|
670
|
-
"errorCodes": {
|
|
671
|
-
"header": "ERROR CODES",
|
|
672
|
-
"body": [
|
|
673
|
-
{
|
|
674
|
-
"name": "Succeeded (0)",
|
|
675
|
-
"description": "The deploy succeeded."
|
|
676
|
-
},
|
|
677
|
-
{
|
|
678
|
-
"name": "Canceled (1)",
|
|
679
|
-
"description": "The deploy was canceled."
|
|
680
|
-
},
|
|
681
|
-
{
|
|
682
|
-
"name": "Failed (1)",
|
|
683
|
-
"description": "The deploy failed."
|
|
684
|
-
},
|
|
685
|
-
{
|
|
686
|
-
"name": "SucceededPartial (68)",
|
|
687
|
-
"description": "The deploy partially succeeded."
|
|
688
|
-
},
|
|
689
|
-
{
|
|
690
|
-
"name": "InProgress (69)",
|
|
691
|
-
"description": "The deploy is in progress."
|
|
692
|
-
},
|
|
693
|
-
{
|
|
694
|
-
"name": "Pending (69)",
|
|
695
|
-
"description": "The deploy is pending."
|
|
696
|
-
},
|
|
697
|
-
{
|
|
698
|
-
"name": "Canceling (69)",
|
|
699
|
-
"description": "The deploy is being canceled."
|
|
700
|
-
}
|
|
701
|
-
]
|
|
702
|
-
},
|
|
703
748
|
"isESM": true,
|
|
704
749
|
"relativePath": [
|
|
705
750
|
"lib",
|
|
706
751
|
"commands",
|
|
707
752
|
"project",
|
|
708
753
|
"deploy",
|
|
709
|
-
"
|
|
754
|
+
"cancel.js"
|
|
710
755
|
],
|
|
711
756
|
"aliasPermutations": [
|
|
712
|
-
"deploy:metadata:
|
|
713
|
-
"metadata:deploy:
|
|
714
|
-
"metadata:
|
|
715
|
-
"deploy:
|
|
716
|
-
"
|
|
717
|
-
"
|
|
757
|
+
"deploy:metadata:cancel",
|
|
758
|
+
"metadata:deploy:cancel",
|
|
759
|
+
"metadata:cancel:deploy",
|
|
760
|
+
"deploy:cancel:metadata",
|
|
761
|
+
"cancel:deploy:metadata",
|
|
762
|
+
"cancel:metadata:deploy"
|
|
718
763
|
],
|
|
719
764
|
"permutations": [
|
|
720
|
-
"project:deploy:
|
|
721
|
-
"deploy:project:
|
|
722
|
-
"deploy:
|
|
723
|
-
"project:
|
|
724
|
-
"
|
|
725
|
-
"
|
|
765
|
+
"project:deploy:cancel",
|
|
766
|
+
"deploy:project:cancel",
|
|
767
|
+
"deploy:cancel:project",
|
|
768
|
+
"project:cancel:deploy",
|
|
769
|
+
"cancel:project:deploy",
|
|
770
|
+
"cancel:deploy:project"
|
|
726
771
|
]
|
|
727
772
|
},
|
|
728
|
-
"project:deploy:
|
|
773
|
+
"project:deploy:preview": {
|
|
729
774
|
"aliases": [
|
|
730
|
-
"deploy:metadata:
|
|
775
|
+
"deploy:metadata:preview"
|
|
731
776
|
],
|
|
732
777
|
"args": {},
|
|
733
778
|
"deprecateAliases": true,
|
|
734
|
-
"description": "
|
|
779
|
+
"description": "You must run this command from within a project.\n\nThe command outputs a table that describes what will happen if you run the \"<%= config.bin %> project deploy start\" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.\n\nIf your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
735
780
|
"examples": [
|
|
736
|
-
"
|
|
737
|
-
"
|
|
738
|
-
"
|
|
781
|
+
"NOTE: The commands to preview a deployment and actually deploy it use similar flags. We provide a few preview examples here, but see the help for \"<%= config.bin %> project deploy start\" for more examples that you can adapt for previewing.",
|
|
782
|
+
"Preview the deployment of source files in a directory, such as force-app, to your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
|
|
783
|
+
"Preview the deployment of all Apex classes to an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch",
|
|
784
|
+
"Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
785
|
+
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
739
786
|
],
|
|
740
787
|
"flags": {
|
|
741
788
|
"json": {
|
|
@@ -753,134 +800,115 @@
|
|
|
753
800
|
"multiple": false,
|
|
754
801
|
"type": "option"
|
|
755
802
|
},
|
|
756
|
-
"
|
|
757
|
-
"char": "
|
|
758
|
-
"description": "
|
|
759
|
-
"name": "
|
|
760
|
-
"
|
|
761
|
-
"summary": "Login username or alias for the target org.",
|
|
762
|
-
"hasDynamicHelp": true,
|
|
763
|
-
"multiple": false,
|
|
764
|
-
"type": "option"
|
|
765
|
-
},
|
|
766
|
-
"job-id": {
|
|
767
|
-
"char": "i",
|
|
768
|
-
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
769
|
-
"name": "job-id",
|
|
770
|
-
"summary": "Job ID of the deploy operation you want to check the status of.",
|
|
771
|
-
"hasDynamicHelp": false,
|
|
772
|
-
"multiple": false,
|
|
773
|
-
"type": "option"
|
|
774
|
-
},
|
|
775
|
-
"use-most-recent": {
|
|
776
|
-
"char": "r",
|
|
777
|
-
"description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.",
|
|
778
|
-
"name": "use-most-recent",
|
|
779
|
-
"summary": "Use the job ID of the most recent deploy operation.",
|
|
803
|
+
"ignore-conflicts": {
|
|
804
|
+
"char": "c",
|
|
805
|
+
"description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
|
|
806
|
+
"name": "ignore-conflicts",
|
|
807
|
+
"summary": "Don't display conflicts in preview of the deployment.",
|
|
780
808
|
"allowNo": false,
|
|
781
809
|
"type": "boolean"
|
|
782
810
|
},
|
|
783
|
-
"
|
|
784
|
-
"
|
|
785
|
-
"
|
|
786
|
-
"
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
"multiple": true,
|
|
790
|
-
"options": [
|
|
791
|
-
"clover",
|
|
792
|
-
"cobertura",
|
|
793
|
-
"html-spa",
|
|
794
|
-
"html",
|
|
795
|
-
"json",
|
|
796
|
-
"json-summary",
|
|
797
|
-
"lcovonly",
|
|
798
|
-
"none",
|
|
799
|
-
"teamcity",
|
|
800
|
-
"text",
|
|
801
|
-
"text-summary"
|
|
811
|
+
"manifest": {
|
|
812
|
+
"char": "x",
|
|
813
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
814
|
+
"exclusive": [
|
|
815
|
+
"source-dir",
|
|
816
|
+
"metadata"
|
|
802
817
|
],
|
|
818
|
+
"name": "manifest",
|
|
819
|
+
"summary": "Full file path for manifest (package.xml) of components to preview.",
|
|
820
|
+
"hasDynamicHelp": false,
|
|
821
|
+
"multiple": false,
|
|
803
822
|
"type": "option"
|
|
804
823
|
},
|
|
805
|
-
"
|
|
806
|
-
"
|
|
807
|
-
"
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
824
|
+
"metadata": {
|
|
825
|
+
"char": "m",
|
|
826
|
+
"exclusive": [
|
|
827
|
+
"manifest",
|
|
828
|
+
"source-dir"
|
|
829
|
+
],
|
|
830
|
+
"name": "metadata",
|
|
831
|
+
"summary": "Metadata component names to preview.",
|
|
832
|
+
"hasDynamicHelp": false,
|
|
833
|
+
"multiple": true,
|
|
834
|
+
"type": "option"
|
|
811
835
|
},
|
|
812
|
-
"
|
|
813
|
-
"
|
|
814
|
-
"
|
|
815
|
-
"
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
"flags": [
|
|
819
|
-
"coverage-formatters",
|
|
820
|
-
"junit"
|
|
821
|
-
]
|
|
822
|
-
}
|
|
836
|
+
"source-dir": {
|
|
837
|
+
"char": "d",
|
|
838
|
+
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
|
|
839
|
+
"exclusive": [
|
|
840
|
+
"manifest",
|
|
841
|
+
"metadata"
|
|
823
842
|
],
|
|
824
|
-
"
|
|
843
|
+
"name": "source-dir",
|
|
844
|
+
"summary": "Path to the local source files to preview.",
|
|
825
845
|
"hasDynamicHelp": false,
|
|
826
|
-
"multiple":
|
|
846
|
+
"multiple": true,
|
|
827
847
|
"type": "option"
|
|
828
848
|
},
|
|
829
|
-
"
|
|
830
|
-
"char": "
|
|
831
|
-
"description": "
|
|
832
|
-
"name": "
|
|
833
|
-
"
|
|
849
|
+
"target-org": {
|
|
850
|
+
"char": "o",
|
|
851
|
+
"description": "Overrides your default org.",
|
|
852
|
+
"name": "target-org",
|
|
853
|
+
"noCacheDefault": true,
|
|
854
|
+
"required": true,
|
|
855
|
+
"summary": "Login username or alias for the target org.",
|
|
834
856
|
"hasDynamicHelp": true,
|
|
835
|
-
"helpValue": "<minutes>",
|
|
836
857
|
"multiple": false,
|
|
837
858
|
"type": "option"
|
|
859
|
+
},
|
|
860
|
+
"concise": {
|
|
861
|
+
"name": "concise",
|
|
862
|
+
"summary": "Show only the changes that will be deployed; omits files that are forceignored.",
|
|
863
|
+
"allowNo": false,
|
|
864
|
+
"type": "boolean"
|
|
838
865
|
}
|
|
839
866
|
},
|
|
840
867
|
"hasDynamicHelp": true,
|
|
841
868
|
"hiddenAliases": [],
|
|
842
|
-
"id": "project:deploy:
|
|
869
|
+
"id": "project:deploy:preview",
|
|
843
870
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
844
871
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
845
872
|
"pluginType": "core",
|
|
846
873
|
"strict": true,
|
|
847
|
-
"summary": "
|
|
874
|
+
"summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
|
|
848
875
|
"enableJsonFlag": true,
|
|
876
|
+
"requiresProject": true,
|
|
849
877
|
"isESM": true,
|
|
850
878
|
"relativePath": [
|
|
851
879
|
"lib",
|
|
852
880
|
"commands",
|
|
853
881
|
"project",
|
|
854
882
|
"deploy",
|
|
855
|
-
"
|
|
883
|
+
"preview.js"
|
|
856
884
|
],
|
|
857
885
|
"aliasPermutations": [
|
|
858
|
-
"deploy:metadata:
|
|
859
|
-
"metadata:deploy:
|
|
860
|
-
"metadata:
|
|
861
|
-
"deploy:
|
|
862
|
-
"
|
|
863
|
-
"
|
|
886
|
+
"deploy:metadata:preview",
|
|
887
|
+
"metadata:deploy:preview",
|
|
888
|
+
"metadata:preview:deploy",
|
|
889
|
+
"deploy:preview:metadata",
|
|
890
|
+
"preview:deploy:metadata",
|
|
891
|
+
"preview:metadata:deploy"
|
|
864
892
|
],
|
|
865
893
|
"permutations": [
|
|
866
|
-
"project:deploy:
|
|
867
|
-
"deploy:project:
|
|
868
|
-
"deploy:
|
|
869
|
-
"project:
|
|
870
|
-
"
|
|
871
|
-
"
|
|
894
|
+
"project:deploy:preview",
|
|
895
|
+
"deploy:project:preview",
|
|
896
|
+
"deploy:preview:project",
|
|
897
|
+
"project:preview:deploy",
|
|
898
|
+
"preview:project:deploy",
|
|
899
|
+
"preview:deploy:project"
|
|
872
900
|
]
|
|
873
901
|
},
|
|
874
|
-
"project:deploy:
|
|
902
|
+
"project:deploy:quick": {
|
|
875
903
|
"aliases": [
|
|
876
|
-
"deploy:metadata:
|
|
904
|
+
"deploy:metadata:quick"
|
|
877
905
|
],
|
|
878
906
|
"args": {},
|
|
879
907
|
"deprecateAliases": true,
|
|
880
|
-
"description": "
|
|
908
|
+
"description": "Before you run this command, first create a validated deployment with the \"<%= config.bin %> project deploy 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.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. Use `sf project deploy start` instead.",
|
|
881
909
|
"examples": [
|
|
882
|
-
"
|
|
883
|
-
"
|
|
910
|
+
"Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
911
|
+
"Asynchronously run a quick deploy of the most recently validated deployment to an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --target-org my-prod-org"
|
|
884
912
|
],
|
|
885
913
|
"flags": {
|
|
886
914
|
"json": {
|
|
@@ -898,29 +926,49 @@
|
|
|
898
926
|
"multiple": false,
|
|
899
927
|
"type": "option"
|
|
900
928
|
},
|
|
929
|
+
"async": {
|
|
930
|
+
"description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
|
|
931
|
+
"exclusive": [
|
|
932
|
+
"wait"
|
|
933
|
+
],
|
|
934
|
+
"name": "async",
|
|
935
|
+
"summary": "Run the command asynchronously.",
|
|
936
|
+
"allowNo": false,
|
|
937
|
+
"type": "boolean"
|
|
938
|
+
},
|
|
901
939
|
"concise": {
|
|
902
940
|
"exclusive": [
|
|
903
941
|
"verbose"
|
|
904
942
|
],
|
|
905
943
|
"name": "concise",
|
|
906
|
-
"summary": "Show concise output of the deploy
|
|
944
|
+
"summary": "Show concise output of the deploy result.",
|
|
907
945
|
"allowNo": false,
|
|
908
946
|
"type": "boolean"
|
|
909
947
|
},
|
|
910
948
|
"job-id": {
|
|
911
949
|
"char": "i",
|
|
912
|
-
"description": "
|
|
950
|
+
"description": "The job ID is valid for 10 days from when you started the validation.",
|
|
913
951
|
"name": "job-id",
|
|
914
|
-
"summary": "Job ID of the
|
|
952
|
+
"summary": "Job ID of the deployment you want to quick deploy.",
|
|
915
953
|
"hasDynamicHelp": false,
|
|
916
954
|
"multiple": false,
|
|
917
955
|
"type": "option"
|
|
918
956
|
},
|
|
957
|
+
"target-org": {
|
|
958
|
+
"char": "o",
|
|
959
|
+
"description": "Overrides your default org.",
|
|
960
|
+
"name": "target-org",
|
|
961
|
+
"noCacheDefault": true,
|
|
962
|
+
"summary": "Login username or alias for the target org.",
|
|
963
|
+
"hasDynamicHelp": true,
|
|
964
|
+
"multiple": false,
|
|
965
|
+
"type": "option"
|
|
966
|
+
},
|
|
919
967
|
"use-most-recent": {
|
|
920
968
|
"char": "r",
|
|
921
|
-
"description": "For performance reasons, this flag uses job IDs
|
|
969
|
+
"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 a job ID.",
|
|
922
970
|
"name": "use-most-recent",
|
|
923
|
-
"summary": "Use the job ID of the most
|
|
971
|
+
"summary": "Use the job ID of the most recently validated deployment.",
|
|
924
972
|
"allowNo": false,
|
|
925
973
|
"type": "boolean"
|
|
926
974
|
},
|
|
@@ -929,62 +977,29 @@
|
|
|
929
977
|
"concise"
|
|
930
978
|
],
|
|
931
979
|
"name": "verbose",
|
|
932
|
-
"summary": "Show verbose output of the deploy
|
|
980
|
+
"summary": "Show verbose output of the deploy result.",
|
|
933
981
|
"allowNo": false,
|
|
934
982
|
"type": "boolean"
|
|
935
983
|
},
|
|
936
984
|
"wait": {
|
|
937
985
|
"char": "w",
|
|
938
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy
|
|
986
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
|
|
987
|
+
"exclusive": [
|
|
988
|
+
"async"
|
|
989
|
+
],
|
|
939
990
|
"name": "wait",
|
|
940
991
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
992
|
+
"default": "33 minutes",
|
|
941
993
|
"hasDynamicHelp": true,
|
|
942
994
|
"helpValue": "<minutes>",
|
|
943
995
|
"multiple": false,
|
|
944
996
|
"type": "option"
|
|
945
997
|
},
|
|
946
|
-
"
|
|
947
|
-
"
|
|
948
|
-
"
|
|
949
|
-
"name": "
|
|
950
|
-
"summary": "
|
|
951
|
-
"hasDynamicHelp": false,
|
|
952
|
-
"multiple": true,
|
|
953
|
-
"options": [
|
|
954
|
-
"clover",
|
|
955
|
-
"cobertura",
|
|
956
|
-
"html-spa",
|
|
957
|
-
"html",
|
|
958
|
-
"json",
|
|
959
|
-
"json-summary",
|
|
960
|
-
"lcovonly",
|
|
961
|
-
"none",
|
|
962
|
-
"teamcity",
|
|
963
|
-
"text",
|
|
964
|
-
"text-summary"
|
|
965
|
-
],
|
|
966
|
-
"type": "option"
|
|
967
|
-
},
|
|
968
|
-
"junit": {
|
|
969
|
-
"helpGroup": "Test",
|
|
970
|
-
"name": "junit",
|
|
971
|
-
"summary": "Output JUnit test results.",
|
|
972
|
-
"allowNo": false,
|
|
973
|
-
"type": "boolean"
|
|
974
|
-
},
|
|
975
|
-
"results-dir": {
|
|
976
|
-
"helpGroup": "Test",
|
|
977
|
-
"name": "results-dir",
|
|
978
|
-
"relationships": [
|
|
979
|
-
{
|
|
980
|
-
"type": "some",
|
|
981
|
-
"flags": [
|
|
982
|
-
"coverage-formatters",
|
|
983
|
-
"junit"
|
|
984
|
-
]
|
|
985
|
-
}
|
|
986
|
-
],
|
|
987
|
-
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
998
|
+
"api-version": {
|
|
999
|
+
"char": "a",
|
|
1000
|
+
"description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
|
|
1001
|
+
"name": "api-version",
|
|
1002
|
+
"summary": "Target API version for the deploy.",
|
|
988
1003
|
"hasDynamicHelp": false,
|
|
989
1004
|
"multiple": false,
|
|
990
1005
|
"type": "option"
|
|
@@ -992,22 +1007,13 @@
|
|
|
992
1007
|
},
|
|
993
1008
|
"hasDynamicHelp": true,
|
|
994
1009
|
"hiddenAliases": [],
|
|
995
|
-
"id": "project:deploy:
|
|
1010
|
+
"id": "project:deploy:quick",
|
|
996
1011
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
997
1012
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
998
1013
|
"pluginType": "core",
|
|
999
1014
|
"strict": true,
|
|
1000
|
-
"summary": "
|
|
1015
|
+
"summary": "Quickly deploy a validated deployment to an org.",
|
|
1001
1016
|
"enableJsonFlag": true,
|
|
1002
|
-
"envVariablesSection": {
|
|
1003
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1004
|
-
"body": [
|
|
1005
|
-
{
|
|
1006
|
-
"name": "SF_USE_PROGRESS_BAR",
|
|
1007
|
-
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1008
|
-
}
|
|
1009
|
-
]
|
|
1010
|
-
},
|
|
1011
1017
|
"errorCodes": {
|
|
1012
1018
|
"header": "ERROR CODES",
|
|
1013
1019
|
"body": [
|
|
@@ -1047,43 +1053,36 @@
|
|
|
1047
1053
|
"commands",
|
|
1048
1054
|
"project",
|
|
1049
1055
|
"deploy",
|
|
1050
|
-
"
|
|
1056
|
+
"quick.js"
|
|
1051
1057
|
],
|
|
1052
1058
|
"aliasPermutations": [
|
|
1053
|
-
"deploy:metadata:
|
|
1054
|
-
"metadata:deploy:
|
|
1055
|
-
"metadata:
|
|
1056
|
-
"deploy:
|
|
1057
|
-
"
|
|
1058
|
-
"
|
|
1059
|
+
"deploy:metadata:quick",
|
|
1060
|
+
"metadata:deploy:quick",
|
|
1061
|
+
"metadata:quick:deploy",
|
|
1062
|
+
"deploy:quick:metadata",
|
|
1063
|
+
"quick:deploy:metadata",
|
|
1064
|
+
"quick:metadata:deploy"
|
|
1059
1065
|
],
|
|
1060
1066
|
"permutations": [
|
|
1061
|
-
"project:deploy:
|
|
1062
|
-
"deploy:project:
|
|
1063
|
-
"deploy:
|
|
1064
|
-
"project:
|
|
1065
|
-
"
|
|
1066
|
-
"
|
|
1067
|
+
"project:deploy:quick",
|
|
1068
|
+
"deploy:project:quick",
|
|
1069
|
+
"deploy:quick:project",
|
|
1070
|
+
"project:quick:deploy",
|
|
1071
|
+
"quick:project:deploy",
|
|
1072
|
+
"quick:deploy:project"
|
|
1067
1073
|
]
|
|
1068
1074
|
},
|
|
1069
|
-
"project:deploy:
|
|
1075
|
+
"project:deploy:report": {
|
|
1070
1076
|
"aliases": [
|
|
1071
|
-
"deploy:metadata"
|
|
1077
|
+
"deploy:metadata:report"
|
|
1072
1078
|
],
|
|
1073
1079
|
"args": {},
|
|
1074
1080
|
"deprecateAliases": true,
|
|
1075
|
-
"description": "
|
|
1081
|
+
"description": "Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation. If you specify the --wait flag, the command polls for the status every second until the timeout of --wait minutes. If you don't specify the --wait flag, the command simply checks and displays the status of the deploy; the command doesn't poll for the status.\n\nYou typically don't specify the --target-org flag because the cached job already references the org to which you deployed. But if you run this command on a computer different than the one from which you deployed, then you must specify the --target-org and it must point to the same org.\n\nThis command doesn't update source tracking information.",
|
|
1076
1082
|
"examples": [
|
|
1077
|
-
"
|
|
1078
|
-
"
|
|
1079
|
-
"
|
|
1080
|
-
"Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
1081
|
-
"Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
|
|
1082
|
-
"Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings",
|
|
1083
|
-
"Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
|
|
1084
|
-
"Deploy all Apex classes and a profile that has a space in its name:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --metadata \"Profile:My Profile\"",
|
|
1085
|
-
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1086
|
-
"Run the tests that aren’t in any managed packages as part of a deployment:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests"
|
|
1083
|
+
"Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1084
|
+
"Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
|
|
1085
|
+
"Poll for the status using a job ID and target org:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30"
|
|
1087
1086
|
],
|
|
1088
1087
|
"flags": {
|
|
1089
1088
|
"json": {
|
|
@@ -1101,231 +1100,33 @@
|
|
|
1101
1100
|
"multiple": false,
|
|
1102
1101
|
"type": "option"
|
|
1103
1102
|
},
|
|
1104
|
-
"api-version": {
|
|
1105
|
-
"char": "a",
|
|
1106
|
-
"description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
|
|
1107
|
-
"name": "api-version",
|
|
1108
|
-
"summary": "Target API version for the deploy.",
|
|
1109
|
-
"hasDynamicHelp": false,
|
|
1110
|
-
"multiple": false,
|
|
1111
|
-
"type": "option"
|
|
1112
|
-
},
|
|
1113
|
-
"async": {
|
|
1114
|
-
"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 \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
|
|
1115
|
-
"exclusive": [
|
|
1116
|
-
"wait"
|
|
1117
|
-
],
|
|
1118
|
-
"name": "async",
|
|
1119
|
-
"summary": "Run the command asynchronously.",
|
|
1120
|
-
"allowNo": false,
|
|
1121
|
-
"type": "boolean"
|
|
1122
|
-
},
|
|
1123
|
-
"concise": {
|
|
1124
|
-
"exclusive": [
|
|
1125
|
-
"verbose"
|
|
1126
|
-
],
|
|
1127
|
-
"name": "concise",
|
|
1128
|
-
"summary": "Show concise output of the deploy result.",
|
|
1129
|
-
"allowNo": false,
|
|
1130
|
-
"type": "boolean"
|
|
1131
|
-
},
|
|
1132
|
-
"dry-run": {
|
|
1133
|
-
"name": "dry-run",
|
|
1134
|
-
"summary": "Validate deploy and run Apex tests but don’t save to the org.",
|
|
1135
|
-
"allowNo": false,
|
|
1136
|
-
"type": "boolean"
|
|
1137
|
-
},
|
|
1138
|
-
"ignore-conflicts": {
|
|
1139
|
-
"char": "c",
|
|
1140
|
-
"description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
|
|
1141
|
-
"name": "ignore-conflicts",
|
|
1142
|
-
"summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
|
|
1143
|
-
"allowNo": false,
|
|
1144
|
-
"type": "boolean"
|
|
1145
|
-
},
|
|
1146
|
-
"ignore-errors": {
|
|
1147
|
-
"char": "r",
|
|
1148
|
-
"description": "Never use this flag when deploying to a production org. If you specify it, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
|
|
1149
|
-
"name": "ignore-errors",
|
|
1150
|
-
"summary": "Ignore any errors and don’t roll back deployment.",
|
|
1151
|
-
"allowNo": false,
|
|
1152
|
-
"type": "boolean"
|
|
1153
|
-
},
|
|
1154
|
-
"ignore-warnings": {
|
|
1155
|
-
"char": "g",
|
|
1156
|
-
"description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
|
|
1157
|
-
"name": "ignore-warnings",
|
|
1158
|
-
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1159
|
-
"allowNo": false,
|
|
1160
|
-
"type": "boolean"
|
|
1161
|
-
},
|
|
1162
|
-
"manifest": {
|
|
1163
|
-
"char": "x",
|
|
1164
|
-
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1165
|
-
"exclusive": [
|
|
1166
|
-
"source-dir",
|
|
1167
|
-
"metadata",
|
|
1168
|
-
"metadata-dir"
|
|
1169
|
-
],
|
|
1170
|
-
"helpGroup": "Source Format",
|
|
1171
|
-
"name": "manifest",
|
|
1172
|
-
"summary": "Full file path for manifest (package.xml) of components to deploy.",
|
|
1173
|
-
"hasDynamicHelp": false,
|
|
1174
|
-
"multiple": false,
|
|
1175
|
-
"type": "option"
|
|
1176
|
-
},
|
|
1177
|
-
"metadata": {
|
|
1178
|
-
"char": "m",
|
|
1179
|
-
"exclusive": [
|
|
1180
|
-
"manifest",
|
|
1181
|
-
"source-dir",
|
|
1182
|
-
"metadata-dir"
|
|
1183
|
-
],
|
|
1184
|
-
"helpGroup": "Source Format",
|
|
1185
|
-
"name": "metadata",
|
|
1186
|
-
"summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
|
|
1187
|
-
"hasDynamicHelp": false,
|
|
1188
|
-
"multiple": true,
|
|
1189
|
-
"type": "option"
|
|
1190
|
-
},
|
|
1191
|
-
"metadata-dir": {
|
|
1192
|
-
"exclusive": [
|
|
1193
|
-
"manifest",
|
|
1194
|
-
"source-dir",
|
|
1195
|
-
"metadata"
|
|
1196
|
-
],
|
|
1197
|
-
"helpGroup": "Metadata API Format",
|
|
1198
|
-
"name": "metadata-dir",
|
|
1199
|
-
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1200
|
-
"hasDynamicHelp": false,
|
|
1201
|
-
"multiple": false,
|
|
1202
|
-
"type": "option"
|
|
1203
|
-
},
|
|
1204
|
-
"single-package": {
|
|
1205
|
-
"dependsOn": [
|
|
1206
|
-
"metadata-dir"
|
|
1207
|
-
],
|
|
1208
|
-
"helpGroup": "Metadata API Format",
|
|
1209
|
-
"name": "single-package",
|
|
1210
|
-
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1211
|
-
"allowNo": false,
|
|
1212
|
-
"type": "boolean"
|
|
1213
|
-
},
|
|
1214
|
-
"source-dir": {
|
|
1215
|
-
"char": "d",
|
|
1216
|
-
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
|
|
1217
|
-
"exclusive": [
|
|
1218
|
-
"manifest",
|
|
1219
|
-
"metadata",
|
|
1220
|
-
"metadata-dir"
|
|
1221
|
-
],
|
|
1222
|
-
"helpGroup": "Source Format",
|
|
1223
|
-
"name": "source-dir",
|
|
1224
|
-
"summary": "Path to the local source files to deploy.",
|
|
1225
|
-
"hasDynamicHelp": false,
|
|
1226
|
-
"multiple": true,
|
|
1227
|
-
"type": "option"
|
|
1228
|
-
},
|
|
1229
1103
|
"target-org": {
|
|
1230
1104
|
"char": "o",
|
|
1231
1105
|
"description": "Overrides your default org.",
|
|
1232
1106
|
"name": "target-org",
|
|
1233
1107
|
"noCacheDefault": true,
|
|
1234
|
-
"required": true,
|
|
1235
1108
|
"summary": "Login username or alias for the target org.",
|
|
1236
1109
|
"hasDynamicHelp": true,
|
|
1237
1110
|
"multiple": false,
|
|
1238
1111
|
"type": "option"
|
|
1239
1112
|
},
|
|
1240
|
-
"
|
|
1241
|
-
"char": "
|
|
1242
|
-
"description": "
|
|
1243
|
-
"
|
|
1244
|
-
"
|
|
1245
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1246
|
-
"hasDynamicHelp": false,
|
|
1247
|
-
"multiple": true,
|
|
1248
|
-
"type": "option"
|
|
1249
|
-
},
|
|
1250
|
-
"test-level": {
|
|
1251
|
-
"char": "l",
|
|
1252
|
-
"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\n If you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
|
|
1253
|
-
"helpGroup": "Test",
|
|
1254
|
-
"name": "test-level",
|
|
1255
|
-
"summary": "Deployment Apex testing level.",
|
|
1113
|
+
"job-id": {
|
|
1114
|
+
"char": "i",
|
|
1115
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
1116
|
+
"name": "job-id",
|
|
1117
|
+
"summary": "Job ID of the deploy operation you want to check the status of.",
|
|
1256
1118
|
"hasDynamicHelp": false,
|
|
1257
1119
|
"multiple": false,
|
|
1258
|
-
"options": [
|
|
1259
|
-
"NoTestRun",
|
|
1260
|
-
"RunSpecifiedTests",
|
|
1261
|
-
"RunLocalTests",
|
|
1262
|
-
"RunAllTestsInOrg"
|
|
1263
|
-
],
|
|
1264
|
-
"type": "option"
|
|
1265
|
-
},
|
|
1266
|
-
"verbose": {
|
|
1267
|
-
"exclusive": [
|
|
1268
|
-
"concise"
|
|
1269
|
-
],
|
|
1270
|
-
"name": "verbose",
|
|
1271
|
-
"summary": "Show verbose output of the deploy result.",
|
|
1272
|
-
"allowNo": false,
|
|
1273
|
-
"type": "boolean"
|
|
1274
|
-
},
|
|
1275
|
-
"wait": {
|
|
1276
|
-
"char": "w",
|
|
1277
|
-
"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 resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
|
|
1278
|
-
"exclusive": [
|
|
1279
|
-
"async"
|
|
1280
|
-
],
|
|
1281
|
-
"name": "wait",
|
|
1282
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1283
|
-
"hasDynamicHelp": true,
|
|
1284
|
-
"helpValue": "<minutes>",
|
|
1285
|
-
"multiple": false,
|
|
1286
1120
|
"type": "option"
|
|
1287
1121
|
},
|
|
1288
|
-
"
|
|
1289
|
-
"
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
"
|
|
1293
|
-
"name": "purge-on-delete",
|
|
1294
|
-
"relationships": [
|
|
1295
|
-
{
|
|
1296
|
-
"type": "some",
|
|
1297
|
-
"flags": [
|
|
1298
|
-
"pre-destructive-changes",
|
|
1299
|
-
"post-destructive-changes"
|
|
1300
|
-
]
|
|
1301
|
-
}
|
|
1302
|
-
],
|
|
1303
|
-
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1122
|
+
"use-most-recent": {
|
|
1123
|
+
"char": "r",
|
|
1124
|
+
"description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.",
|
|
1125
|
+
"name": "use-most-recent",
|
|
1126
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1304
1127
|
"allowNo": false,
|
|
1305
1128
|
"type": "boolean"
|
|
1306
1129
|
},
|
|
1307
|
-
"pre-destructive-changes": {
|
|
1308
|
-
"dependsOn": [
|
|
1309
|
-
"manifest"
|
|
1310
|
-
],
|
|
1311
|
-
"helpGroup": "Delete",
|
|
1312
|
-
"name": "pre-destructive-changes",
|
|
1313
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
|
|
1314
|
-
"hasDynamicHelp": false,
|
|
1315
|
-
"multiple": false,
|
|
1316
|
-
"type": "option"
|
|
1317
|
-
},
|
|
1318
|
-
"post-destructive-changes": {
|
|
1319
|
-
"dependsOn": [
|
|
1320
|
-
"manifest"
|
|
1321
|
-
],
|
|
1322
|
-
"helpGroup": "Delete",
|
|
1323
|
-
"name": "post-destructive-changes",
|
|
1324
|
-
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1325
|
-
"hasDynamicHelp": false,
|
|
1326
|
-
"multiple": false,
|
|
1327
|
-
"type": "option"
|
|
1328
|
-
},
|
|
1329
1130
|
"coverage-formatters": {
|
|
1330
1131
|
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1331
1132
|
"helpGroup": "Test",
|
|
@@ -1371,110 +1172,62 @@
|
|
|
1371
1172
|
"hasDynamicHelp": false,
|
|
1372
1173
|
"multiple": false,
|
|
1373
1174
|
"type": "option"
|
|
1175
|
+
},
|
|
1176
|
+
"wait": {
|
|
1177
|
+
"char": "w",
|
|
1178
|
+
"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 resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
|
|
1179
|
+
"name": "wait",
|
|
1180
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1181
|
+
"hasDynamicHelp": true,
|
|
1182
|
+
"helpValue": "<minutes>",
|
|
1183
|
+
"multiple": false,
|
|
1184
|
+
"type": "option"
|
|
1374
1185
|
}
|
|
1375
1186
|
},
|
|
1376
1187
|
"hasDynamicHelp": true,
|
|
1377
1188
|
"hiddenAliases": [],
|
|
1378
|
-
"id": "project:deploy:
|
|
1189
|
+
"id": "project:deploy:report",
|
|
1379
1190
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1380
1191
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1381
1192
|
"pluginType": "core",
|
|
1382
1193
|
"strict": true,
|
|
1383
|
-
"summary": "
|
|
1194
|
+
"summary": "Check or poll for the status of a deploy operation.",
|
|
1384
1195
|
"enableJsonFlag": true,
|
|
1385
|
-
"configurationVariablesSection": {
|
|
1386
|
-
"header": "CONFIGURATION VARIABLES",
|
|
1387
|
-
"body": [
|
|
1388
|
-
{
|
|
1389
|
-
"name": "target-org",
|
|
1390
|
-
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1391
|
-
},
|
|
1392
|
-
{
|
|
1393
|
-
"name": "org-api-version",
|
|
1394
|
-
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1395
|
-
}
|
|
1396
|
-
]
|
|
1397
|
-
},
|
|
1398
|
-
"envVariablesSection": {
|
|
1399
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1400
|
-
"body": [
|
|
1401
|
-
{
|
|
1402
|
-
"name": "SF_TARGET_ORG",
|
|
1403
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1404
|
-
},
|
|
1405
|
-
{
|
|
1406
|
-
"name": "SF_USE_PROGRESS_BAR",
|
|
1407
|
-
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1408
|
-
}
|
|
1409
|
-
]
|
|
1410
|
-
},
|
|
1411
|
-
"errorCodes": {
|
|
1412
|
-
"header": "ERROR CODES",
|
|
1413
|
-
"body": [
|
|
1414
|
-
{
|
|
1415
|
-
"name": "Succeeded (0)",
|
|
1416
|
-
"description": "The deploy succeeded."
|
|
1417
|
-
},
|
|
1418
|
-
{
|
|
1419
|
-
"name": "Canceled (1)",
|
|
1420
|
-
"description": "The deploy was canceled."
|
|
1421
|
-
},
|
|
1422
|
-
{
|
|
1423
|
-
"name": "Failed (1)",
|
|
1424
|
-
"description": "The deploy failed."
|
|
1425
|
-
},
|
|
1426
|
-
{
|
|
1427
|
-
"name": "SucceededPartial (68)",
|
|
1428
|
-
"description": "The deploy partially succeeded."
|
|
1429
|
-
},
|
|
1430
|
-
{
|
|
1431
|
-
"name": "InProgress (69)",
|
|
1432
|
-
"description": "The deploy is in progress."
|
|
1433
|
-
},
|
|
1434
|
-
{
|
|
1435
|
-
"name": "Pending (69)",
|
|
1436
|
-
"description": "The deploy is pending."
|
|
1437
|
-
},
|
|
1438
|
-
{
|
|
1439
|
-
"name": "Canceling (69)",
|
|
1440
|
-
"description": "The deploy is being canceled."
|
|
1441
|
-
}
|
|
1442
|
-
]
|
|
1443
|
-
},
|
|
1444
1196
|
"isESM": true,
|
|
1445
1197
|
"relativePath": [
|
|
1446
1198
|
"lib",
|
|
1447
1199
|
"commands",
|
|
1448
1200
|
"project",
|
|
1449
1201
|
"deploy",
|
|
1450
|
-
"
|
|
1202
|
+
"report.js"
|
|
1451
1203
|
],
|
|
1452
1204
|
"aliasPermutations": [
|
|
1453
|
-
"deploy:metadata",
|
|
1454
|
-
"metadata:deploy"
|
|
1205
|
+
"deploy:metadata:report",
|
|
1206
|
+
"metadata:deploy:report",
|
|
1207
|
+
"metadata:report:deploy",
|
|
1208
|
+
"deploy:report:metadata",
|
|
1209
|
+
"report:deploy:metadata",
|
|
1210
|
+
"report:metadata:deploy"
|
|
1455
1211
|
],
|
|
1456
1212
|
"permutations": [
|
|
1457
|
-
"project:deploy:
|
|
1458
|
-
"deploy:project:
|
|
1459
|
-
"deploy:
|
|
1460
|
-
"project:
|
|
1461
|
-
"
|
|
1462
|
-
"
|
|
1213
|
+
"project:deploy:report",
|
|
1214
|
+
"deploy:project:report",
|
|
1215
|
+
"deploy:report:project",
|
|
1216
|
+
"project:report:deploy",
|
|
1217
|
+
"report:project:deploy",
|
|
1218
|
+
"report:deploy:project"
|
|
1463
1219
|
]
|
|
1464
1220
|
},
|
|
1465
|
-
"project:deploy:
|
|
1221
|
+
"project:deploy:resume": {
|
|
1466
1222
|
"aliases": [
|
|
1467
|
-
"deploy:metadata:
|
|
1223
|
+
"deploy:metadata:resume"
|
|
1468
1224
|
],
|
|
1469
1225
|
"args": {},
|
|
1470
1226
|
"deprecateAliases": true,
|
|
1471
|
-
"description": "Use this command to
|
|
1227
|
+
"description": "Use this command to resume watching a deploy operation if the original command times out or you specified the --async flag. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations. This command doesn't resume the original operation itself, because the operation always continues after you've started it, regardless of whether you're watching it or not. When the deploy completes, source tracking information is updated as needed.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
1472
1228
|
"examples": [
|
|
1473
|
-
"
|
|
1474
|
-
"
|
|
1475
|
-
"Validate the deployment of all source files in two directories: \"force-app\" and \"force-app-utils\":\n<%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils",
|
|
1476
|
-
"Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\n<%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org",
|
|
1477
|
-
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
1229
|
+
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1230
|
+
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1478
1231
|
],
|
|
1479
1232
|
"flags": {
|
|
1480
1233
|
"json": {
|
|
@@ -1492,127 +1245,44 @@
|
|
|
1492
1245
|
"multiple": false,
|
|
1493
1246
|
"type": "option"
|
|
1494
1247
|
},
|
|
1495
|
-
"api-version": {
|
|
1496
|
-
"char": "a",
|
|
1497
|
-
"description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
|
|
1498
|
-
"name": "api-version",
|
|
1499
|
-
"summary": "Target API version for the validation.",
|
|
1500
|
-
"hasDynamicHelp": false,
|
|
1501
|
-
"multiple": false,
|
|
1502
|
-
"type": "option"
|
|
1503
|
-
},
|
|
1504
|
-
"async": {
|
|
1505
|
-
"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 watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
|
|
1506
|
-
"name": "async",
|
|
1507
|
-
"summary": "Run the command asynchronously.",
|
|
1508
|
-
"allowNo": false,
|
|
1509
|
-
"type": "boolean"
|
|
1510
|
-
},
|
|
1511
1248
|
"concise": {
|
|
1512
1249
|
"exclusive": [
|
|
1513
1250
|
"verbose"
|
|
1514
1251
|
],
|
|
1515
1252
|
"name": "concise",
|
|
1516
|
-
"summary": "Show concise output of the
|
|
1253
|
+
"summary": "Show concise output of the deploy operation result.",
|
|
1517
1254
|
"allowNo": false,
|
|
1518
1255
|
"type": "boolean"
|
|
1519
1256
|
},
|
|
1520
|
-
"
|
|
1521
|
-
"char": "
|
|
1522
|
-
"description": "
|
|
1523
|
-
"
|
|
1524
|
-
"
|
|
1525
|
-
"summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
|
|
1526
|
-
"hasDynamicHelp": false,
|
|
1527
|
-
"multiple": false,
|
|
1528
|
-
"type": "option"
|
|
1529
|
-
},
|
|
1530
|
-
"metadata": {
|
|
1531
|
-
"char": "m",
|
|
1532
|
-
"helpGroup": "Source Format",
|
|
1533
|
-
"name": "metadata",
|
|
1534
|
-
"summary": "Metadata component names to validate for deployment.",
|
|
1535
|
-
"hasDynamicHelp": false,
|
|
1536
|
-
"multiple": true,
|
|
1537
|
-
"type": "option"
|
|
1538
|
-
},
|
|
1539
|
-
"source-dir": {
|
|
1540
|
-
"char": "d",
|
|
1541
|
-
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
|
|
1542
|
-
"helpGroup": "Source Format",
|
|
1543
|
-
"name": "source-dir",
|
|
1544
|
-
"summary": "Path to the local source files to validate for deployment.",
|
|
1545
|
-
"hasDynamicHelp": false,
|
|
1546
|
-
"multiple": true,
|
|
1547
|
-
"type": "option"
|
|
1548
|
-
},
|
|
1549
|
-
"metadata-dir": {
|
|
1550
|
-
"helpGroup": "Metadata API Format",
|
|
1551
|
-
"name": "metadata-dir",
|
|
1552
|
-
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1257
|
+
"job-id": {
|
|
1258
|
+
"char": "i",
|
|
1259
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
1260
|
+
"name": "job-id",
|
|
1261
|
+
"summary": "Job ID of the deploy operation you want to resume.",
|
|
1553
1262
|
"hasDynamicHelp": false,
|
|
1554
1263
|
"multiple": false,
|
|
1555
1264
|
"type": "option"
|
|
1556
1265
|
},
|
|
1557
|
-
"
|
|
1558
|
-
"
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
"
|
|
1562
|
-
"name": "single-package",
|
|
1563
|
-
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1266
|
+
"use-most-recent": {
|
|
1267
|
+
"char": "r",
|
|
1268
|
+
"description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.",
|
|
1269
|
+
"name": "use-most-recent",
|
|
1270
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1564
1271
|
"allowNo": false,
|
|
1565
1272
|
"type": "boolean"
|
|
1566
1273
|
},
|
|
1567
|
-
"target-org": {
|
|
1568
|
-
"char": "o",
|
|
1569
|
-
"description": "Overrides your default org.",
|
|
1570
|
-
"name": "target-org",
|
|
1571
|
-
"noCacheDefault": true,
|
|
1572
|
-
"required": true,
|
|
1573
|
-
"summary": "Login username or alias for the target org.",
|
|
1574
|
-
"hasDynamicHelp": true,
|
|
1575
|
-
"multiple": false,
|
|
1576
|
-
"type": "option"
|
|
1577
|
-
},
|
|
1578
|
-
"tests": {
|
|
1579
|
-
"char": "t",
|
|
1580
|
-
"description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
|
|
1581
|
-
"helpGroup": "Test",
|
|
1582
|
-
"name": "tests",
|
|
1583
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1584
|
-
"hasDynamicHelp": false,
|
|
1585
|
-
"multiple": true,
|
|
1586
|
-
"type": "option"
|
|
1587
|
-
},
|
|
1588
|
-
"test-level": {
|
|
1589
|
-
"char": "l",
|
|
1590
|
-
"description": "Valid values are:\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.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.",
|
|
1591
|
-
"helpGroup": "Test",
|
|
1592
|
-
"name": "test-level",
|
|
1593
|
-
"summary": "Deployment Apex testing level.",
|
|
1594
|
-
"default": "RunLocalTests",
|
|
1595
|
-
"hasDynamicHelp": false,
|
|
1596
|
-
"multiple": false,
|
|
1597
|
-
"options": [
|
|
1598
|
-
"RunAllTestsInOrg",
|
|
1599
|
-
"RunLocalTests",
|
|
1600
|
-
"RunSpecifiedTests"
|
|
1601
|
-
],
|
|
1602
|
-
"type": "option"
|
|
1603
|
-
},
|
|
1604
1274
|
"verbose": {
|
|
1605
1275
|
"exclusive": [
|
|
1606
1276
|
"concise"
|
|
1607
1277
|
],
|
|
1608
1278
|
"name": "verbose",
|
|
1609
|
-
"summary": "Show verbose output of the
|
|
1279
|
+
"summary": "Show verbose output of the deploy operation result.",
|
|
1610
1280
|
"allowNo": false,
|
|
1611
1281
|
"type": "boolean"
|
|
1612
1282
|
},
|
|
1613
1283
|
"wait": {
|
|
1614
1284
|
"char": "w",
|
|
1615
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you
|
|
1285
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy operation, run this command again. To check the status of the deploy operation, run \"<%= config.bin %> project deploy report\".",
|
|
1616
1286
|
"name": "wait",
|
|
1617
1287
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1618
1288
|
"hasDynamicHelp": true,
|
|
@@ -1620,14 +1290,6 @@
|
|
|
1620
1290
|
"multiple": false,
|
|
1621
1291
|
"type": "option"
|
|
1622
1292
|
},
|
|
1623
|
-
"ignore-warnings": {
|
|
1624
|
-
"char": "g",
|
|
1625
|
-
"description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
|
|
1626
|
-
"name": "ignore-warnings",
|
|
1627
|
-
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1628
|
-
"allowNo": false,
|
|
1629
|
-
"type": "boolean"
|
|
1630
|
-
},
|
|
1631
1293
|
"coverage-formatters": {
|
|
1632
1294
|
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1633
1295
|
"helpGroup": "Test",
|
|
@@ -1673,78 +1335,20 @@
|
|
|
1673
1335
|
"hasDynamicHelp": false,
|
|
1674
1336
|
"multiple": false,
|
|
1675
1337
|
"type": "option"
|
|
1676
|
-
},
|
|
1677
|
-
"purge-on-delete": {
|
|
1678
|
-
"dependsOn": [
|
|
1679
|
-
"manifest"
|
|
1680
|
-
],
|
|
1681
|
-
"helpGroup": "Delete",
|
|
1682
|
-
"name": "purge-on-delete",
|
|
1683
|
-
"relationships": [
|
|
1684
|
-
{
|
|
1685
|
-
"type": "some",
|
|
1686
|
-
"flags": [
|
|
1687
|
-
"pre-destructive-changes",
|
|
1688
|
-
"post-destructive-changes"
|
|
1689
|
-
]
|
|
1690
|
-
}
|
|
1691
|
-
],
|
|
1692
|
-
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1693
|
-
"allowNo": false,
|
|
1694
|
-
"type": "boolean"
|
|
1695
|
-
},
|
|
1696
|
-
"pre-destructive-changes": {
|
|
1697
|
-
"dependsOn": [
|
|
1698
|
-
"manifest"
|
|
1699
|
-
],
|
|
1700
|
-
"helpGroup": "Delete",
|
|
1701
|
-
"name": "pre-destructive-changes",
|
|
1702
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
1703
|
-
"hasDynamicHelp": false,
|
|
1704
|
-
"multiple": false,
|
|
1705
|
-
"type": "option"
|
|
1706
|
-
},
|
|
1707
|
-
"post-destructive-changes": {
|
|
1708
|
-
"dependsOn": [
|
|
1709
|
-
"manifest"
|
|
1710
|
-
],
|
|
1711
|
-
"helpGroup": "Delete",
|
|
1712
|
-
"name": "post-destructive-changes",
|
|
1713
|
-
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1714
|
-
"hasDynamicHelp": false,
|
|
1715
|
-
"multiple": false,
|
|
1716
|
-
"type": "option"
|
|
1717
1338
|
}
|
|
1718
1339
|
},
|
|
1719
1340
|
"hasDynamicHelp": true,
|
|
1720
1341
|
"hiddenAliases": [],
|
|
1721
|
-
"id": "project:deploy:
|
|
1342
|
+
"id": "project:deploy:resume",
|
|
1722
1343
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1723
1344
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1724
1345
|
"pluginType": "core",
|
|
1725
1346
|
"strict": true,
|
|
1726
|
-
"summary": "
|
|
1347
|
+
"summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
|
|
1727
1348
|
"enableJsonFlag": true,
|
|
1728
|
-
"
|
|
1729
|
-
"header": "
|
|
1349
|
+
"envVariablesSection": {
|
|
1350
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1730
1351
|
"body": [
|
|
1731
|
-
{
|
|
1732
|
-
"name": "target-org",
|
|
1733
|
-
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1734
|
-
},
|
|
1735
|
-
{
|
|
1736
|
-
"name": "org-api-version",
|
|
1737
|
-
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1738
|
-
}
|
|
1739
|
-
]
|
|
1740
|
-
},
|
|
1741
|
-
"envVariablesSection": {
|
|
1742
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1743
|
-
"body": [
|
|
1744
|
-
{
|
|
1745
|
-
"name": "SF_TARGET_ORG",
|
|
1746
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1747
|
-
},
|
|
1748
1352
|
{
|
|
1749
1353
|
"name": "SF_USE_PROGRESS_BAR",
|
|
1750
1354
|
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
@@ -1790,37 +1394,43 @@
|
|
|
1790
1394
|
"commands",
|
|
1791
1395
|
"project",
|
|
1792
1396
|
"deploy",
|
|
1793
|
-
"
|
|
1397
|
+
"resume.js"
|
|
1794
1398
|
],
|
|
1795
1399
|
"aliasPermutations": [
|
|
1796
|
-
"deploy:metadata:
|
|
1797
|
-
"metadata:deploy:
|
|
1798
|
-
"metadata:
|
|
1799
|
-
"deploy:
|
|
1800
|
-
"
|
|
1801
|
-
"
|
|
1400
|
+
"deploy:metadata:resume",
|
|
1401
|
+
"metadata:deploy:resume",
|
|
1402
|
+
"metadata:resume:deploy",
|
|
1403
|
+
"deploy:resume:metadata",
|
|
1404
|
+
"resume:deploy:metadata",
|
|
1405
|
+
"resume:metadata:deploy"
|
|
1802
1406
|
],
|
|
1803
1407
|
"permutations": [
|
|
1804
|
-
"project:deploy:
|
|
1805
|
-
"deploy:project:
|
|
1806
|
-
"deploy:
|
|
1807
|
-
"project:
|
|
1808
|
-
"
|
|
1809
|
-
"
|
|
1408
|
+
"project:deploy:resume",
|
|
1409
|
+
"deploy:project:resume",
|
|
1410
|
+
"deploy:resume:project",
|
|
1411
|
+
"project:resume:deploy",
|
|
1412
|
+
"resume:project:deploy",
|
|
1413
|
+
"resume:deploy:project"
|
|
1810
1414
|
]
|
|
1811
1415
|
},
|
|
1812
|
-
"project:
|
|
1416
|
+
"project:deploy:start": {
|
|
1813
1417
|
"aliases": [
|
|
1814
|
-
"
|
|
1418
|
+
"deploy:metadata"
|
|
1815
1419
|
],
|
|
1816
1420
|
"args": {},
|
|
1817
1421
|
"deprecateAliases": true,
|
|
1818
|
-
"description": "
|
|
1422
|
+
"description": "You must run this command from within a project.\n\nMetadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
1819
1423
|
"examples": [
|
|
1820
|
-
"
|
|
1821
|
-
"
|
|
1822
|
-
"
|
|
1823
|
-
"
|
|
1424
|
+
"Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1425
|
+
"Deploy all source files in the \"force-app\" directory to an org with alias \"my-scratch\"; show only concise output, in other words don't print a list of all the source that was deployed:\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch --concise",
|
|
1426
|
+
"Deploy all the Apex classes and custom objects that are in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
|
|
1427
|
+
"Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
1428
|
+
"Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
|
|
1429
|
+
"Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings",
|
|
1430
|
+
"Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
|
|
1431
|
+
"Deploy all Apex classes and a profile that has a space in its name:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --metadata \"Profile:My Profile\"",
|
|
1432
|
+
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1433
|
+
"Run the tests that aren’t in any managed packages as part of a deployment:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests"
|
|
1824
1434
|
],
|
|
1825
1435
|
"flags": {
|
|
1826
1436
|
"json": {
|
|
@@ -1839,63 +1449,143 @@
|
|
|
1839
1449
|
"type": "option"
|
|
1840
1450
|
},
|
|
1841
1451
|
"api-version": {
|
|
1842
|
-
"
|
|
1843
|
-
|
|
1844
|
-
],
|
|
1845
|
-
"deprecateAliases": true,
|
|
1846
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1452
|
+
"char": "a",
|
|
1453
|
+
"description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
|
|
1847
1454
|
"name": "api-version",
|
|
1455
|
+
"summary": "Target API version for the deploy.",
|
|
1848
1456
|
"hasDynamicHelp": false,
|
|
1849
1457
|
"multiple": false,
|
|
1850
1458
|
"type": "option"
|
|
1851
1459
|
},
|
|
1852
|
-
"
|
|
1853
|
-
"
|
|
1854
|
-
|
|
1855
|
-
|
|
1856
|
-
|
|
1857
|
-
"name": "
|
|
1460
|
+
"async": {
|
|
1461
|
+
"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 \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
|
|
1462
|
+
"exclusive": [
|
|
1463
|
+
"wait"
|
|
1464
|
+
],
|
|
1465
|
+
"name": "async",
|
|
1466
|
+
"summary": "Run the command asynchronously.",
|
|
1467
|
+
"allowNo": false,
|
|
1468
|
+
"type": "boolean"
|
|
1469
|
+
},
|
|
1470
|
+
"concise": {
|
|
1471
|
+
"exclusive": [
|
|
1472
|
+
"verbose"
|
|
1473
|
+
],
|
|
1474
|
+
"name": "concise",
|
|
1475
|
+
"summary": "Show concise output of the deploy result.",
|
|
1476
|
+
"allowNo": false,
|
|
1477
|
+
"type": "boolean"
|
|
1478
|
+
},
|
|
1479
|
+
"dry-run": {
|
|
1480
|
+
"name": "dry-run",
|
|
1481
|
+
"summary": "Validate deploy and run Apex tests but don’t save to the org.",
|
|
1482
|
+
"allowNo": false,
|
|
1483
|
+
"type": "boolean"
|
|
1484
|
+
},
|
|
1485
|
+
"ignore-conflicts": {
|
|
1486
|
+
"char": "c",
|
|
1487
|
+
"description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
|
|
1488
|
+
"name": "ignore-conflicts",
|
|
1489
|
+
"summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
|
|
1490
|
+
"allowNo": false,
|
|
1491
|
+
"type": "boolean"
|
|
1492
|
+
},
|
|
1493
|
+
"ignore-errors": {
|
|
1494
|
+
"char": "r",
|
|
1495
|
+
"description": "Never use this flag when deploying to a production org. If you specify it, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
|
|
1496
|
+
"name": "ignore-errors",
|
|
1497
|
+
"summary": "Ignore any errors and don’t roll back deployment.",
|
|
1498
|
+
"allowNo": false,
|
|
1499
|
+
"type": "boolean"
|
|
1500
|
+
},
|
|
1501
|
+
"ignore-warnings": {
|
|
1502
|
+
"char": "g",
|
|
1503
|
+
"description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
|
|
1504
|
+
"name": "ignore-warnings",
|
|
1505
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1506
|
+
"allowNo": false,
|
|
1507
|
+
"type": "boolean"
|
|
1508
|
+
},
|
|
1509
|
+
"manifest": {
|
|
1510
|
+
"char": "x",
|
|
1511
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1512
|
+
"exclusive": [
|
|
1513
|
+
"source-dir",
|
|
1514
|
+
"metadata",
|
|
1515
|
+
"metadata-dir"
|
|
1516
|
+
],
|
|
1517
|
+
"helpGroup": "Source Format",
|
|
1518
|
+
"name": "manifest",
|
|
1519
|
+
"summary": "Full file path for manifest (package.xml) of components to deploy.",
|
|
1858
1520
|
"hasDynamicHelp": false,
|
|
1859
1521
|
"multiple": false,
|
|
1860
1522
|
"type": "option"
|
|
1861
1523
|
},
|
|
1862
|
-
"
|
|
1863
|
-
"
|
|
1864
|
-
|
|
1865
|
-
"
|
|
1524
|
+
"metadata": {
|
|
1525
|
+
"char": "m",
|
|
1526
|
+
"exclusive": [
|
|
1527
|
+
"manifest",
|
|
1528
|
+
"source-dir",
|
|
1529
|
+
"metadata-dir"
|
|
1866
1530
|
],
|
|
1867
|
-
"
|
|
1868
|
-
"
|
|
1869
|
-
"
|
|
1870
|
-
"
|
|
1871
|
-
"
|
|
1872
|
-
"
|
|
1873
|
-
|
|
1531
|
+
"helpGroup": "Source Format",
|
|
1532
|
+
"name": "metadata",
|
|
1533
|
+
"summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
|
|
1534
|
+
"hasDynamicHelp": false,
|
|
1535
|
+
"multiple": true,
|
|
1536
|
+
"type": "option"
|
|
1537
|
+
},
|
|
1538
|
+
"metadata-dir": {
|
|
1539
|
+
"exclusive": [
|
|
1540
|
+
"manifest",
|
|
1541
|
+
"source-dir",
|
|
1542
|
+
"metadata"
|
|
1543
|
+
],
|
|
1544
|
+
"helpGroup": "Metadata API Format",
|
|
1545
|
+
"name": "metadata-dir",
|
|
1546
|
+
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1547
|
+
"hasDynamicHelp": false,
|
|
1874
1548
|
"multiple": false,
|
|
1875
1549
|
"type": "option"
|
|
1876
1550
|
},
|
|
1877
|
-
"
|
|
1878
|
-
"
|
|
1879
|
-
"
|
|
1551
|
+
"single-package": {
|
|
1552
|
+
"dependsOn": [
|
|
1553
|
+
"metadata-dir"
|
|
1880
1554
|
],
|
|
1881
|
-
"
|
|
1882
|
-
"
|
|
1883
|
-
"
|
|
1884
|
-
"name": "check-only",
|
|
1885
|
-
"summary": "Validate delete command but don't delete anything from the org or the local project.",
|
|
1555
|
+
"helpGroup": "Metadata API Format",
|
|
1556
|
+
"name": "single-package",
|
|
1557
|
+
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1886
1558
|
"allowNo": false,
|
|
1887
1559
|
"type": "boolean"
|
|
1888
1560
|
},
|
|
1889
|
-
"
|
|
1890
|
-
"char": "
|
|
1891
|
-
"description": "
|
|
1892
|
-
"
|
|
1893
|
-
|
|
1561
|
+
"source-dir": {
|
|
1562
|
+
"char": "d",
|
|
1563
|
+
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
|
|
1564
|
+
"exclusive": [
|
|
1565
|
+
"manifest",
|
|
1566
|
+
"metadata",
|
|
1567
|
+
"metadata-dir"
|
|
1568
|
+
],
|
|
1569
|
+
"helpGroup": "Source Format",
|
|
1570
|
+
"name": "source-dir",
|
|
1571
|
+
"summary": "Path to the local source files to deploy.",
|
|
1572
|
+
"hasDynamicHelp": false,
|
|
1573
|
+
"multiple": true,
|
|
1574
|
+
"type": "option"
|
|
1575
|
+
},
|
|
1576
|
+
"target-org": {
|
|
1577
|
+
"char": "o",
|
|
1578
|
+
"description": "Overrides your default org.",
|
|
1579
|
+
"name": "target-org",
|
|
1580
|
+
"noCacheDefault": true,
|
|
1581
|
+
"required": true,
|
|
1582
|
+
"summary": "Login username or alias for the target org.",
|
|
1894
1583
|
"hasDynamicHelp": true,
|
|
1895
1584
|
"multiple": false,
|
|
1896
1585
|
"type": "option"
|
|
1897
1586
|
},
|
|
1898
1587
|
"tests": {
|
|
1588
|
+
"char": "t",
|
|
1899
1589
|
"description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
|
|
1900
1590
|
"helpGroup": "Test",
|
|
1901
1591
|
"name": "tests",
|
|
@@ -1905,12 +1595,8 @@
|
|
|
1905
1595
|
"type": "option"
|
|
1906
1596
|
},
|
|
1907
1597
|
"test-level": {
|
|
1908
|
-
"aliases": [
|
|
1909
|
-
"testlevel"
|
|
1910
|
-
],
|
|
1911
1598
|
"char": "l",
|
|
1912
|
-
"
|
|
1913
|
-
"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 and target org. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
|
|
1599
|
+
"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\n If you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
|
|
1914
1600
|
"helpGroup": "Test",
|
|
1915
1601
|
"name": "test-level",
|
|
1916
1602
|
"summary": "Deployment Apex testing level.",
|
|
@@ -1924,120 +1610,218 @@
|
|
|
1924
1610
|
],
|
|
1925
1611
|
"type": "option"
|
|
1926
1612
|
},
|
|
1927
|
-
"
|
|
1928
|
-
"
|
|
1929
|
-
"
|
|
1613
|
+
"verbose": {
|
|
1614
|
+
"exclusive": [
|
|
1615
|
+
"concise"
|
|
1930
1616
|
],
|
|
1931
|
-
"
|
|
1932
|
-
"
|
|
1933
|
-
"name": "no-prompt",
|
|
1934
|
-
"summary": "Don't prompt for delete confirmation.",
|
|
1617
|
+
"name": "verbose",
|
|
1618
|
+
"summary": "Show verbose output of the deploy result.",
|
|
1935
1619
|
"allowNo": false,
|
|
1936
1620
|
"type": "boolean"
|
|
1937
1621
|
},
|
|
1938
|
-
"
|
|
1939
|
-
"char": "
|
|
1940
|
-
"description": "If you
|
|
1941
|
-
"
|
|
1942
|
-
|
|
1943
|
-
|
|
1944
|
-
"
|
|
1945
|
-
"
|
|
1622
|
+
"wait": {
|
|
1623
|
+
"char": "w",
|
|
1624
|
+
"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 resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
|
|
1625
|
+
"exclusive": [
|
|
1626
|
+
"async"
|
|
1627
|
+
],
|
|
1628
|
+
"name": "wait",
|
|
1629
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1630
|
+
"hasDynamicHelp": true,
|
|
1631
|
+
"helpValue": "<minutes>",
|
|
1632
|
+
"multiple": false,
|
|
1946
1633
|
"type": "option"
|
|
1947
1634
|
},
|
|
1948
|
-
"
|
|
1949
|
-
"
|
|
1950
|
-
"
|
|
1635
|
+
"purge-on-delete": {
|
|
1636
|
+
"dependsOn": [
|
|
1637
|
+
"manifest"
|
|
1951
1638
|
],
|
|
1952
|
-
"
|
|
1953
|
-
"
|
|
1954
|
-
"
|
|
1955
|
-
|
|
1956
|
-
|
|
1957
|
-
|
|
1958
|
-
|
|
1959
|
-
|
|
1960
|
-
|
|
1961
|
-
|
|
1962
|
-
"track-source": {
|
|
1963
|
-
"aliases": [
|
|
1964
|
-
"tracksource"
|
|
1965
|
-
],
|
|
1966
|
-
"char": "t",
|
|
1967
|
-
"deprecateAliases": true,
|
|
1968
|
-
"exclusive": [
|
|
1969
|
-
"check-only"
|
|
1639
|
+
"helpGroup": "Delete",
|
|
1640
|
+
"name": "purge-on-delete",
|
|
1641
|
+
"relationships": [
|
|
1642
|
+
{
|
|
1643
|
+
"type": "some",
|
|
1644
|
+
"flags": [
|
|
1645
|
+
"pre-destructive-changes",
|
|
1646
|
+
"post-destructive-changes"
|
|
1647
|
+
]
|
|
1648
|
+
}
|
|
1970
1649
|
],
|
|
1971
|
-
"
|
|
1972
|
-
"summary": "If the delete succeeds, update the source tracking information.",
|
|
1650
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1973
1651
|
"allowNo": false,
|
|
1974
1652
|
"type": "boolean"
|
|
1975
1653
|
},
|
|
1976
|
-
"
|
|
1977
|
-
"
|
|
1978
|
-
"
|
|
1654
|
+
"pre-destructive-changes": {
|
|
1655
|
+
"dependsOn": [
|
|
1656
|
+
"manifest"
|
|
1979
1657
|
],
|
|
1980
|
-
"
|
|
1658
|
+
"helpGroup": "Delete",
|
|
1659
|
+
"name": "pre-destructive-changes",
|
|
1660
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
|
|
1661
|
+
"hasDynamicHelp": false,
|
|
1662
|
+
"multiple": false,
|
|
1663
|
+
"type": "option"
|
|
1664
|
+
},
|
|
1665
|
+
"post-destructive-changes": {
|
|
1981
1666
|
"dependsOn": [
|
|
1982
|
-
"
|
|
1667
|
+
"manifest"
|
|
1983
1668
|
],
|
|
1984
|
-
"
|
|
1985
|
-
"name": "
|
|
1986
|
-
"summary": "
|
|
1987
|
-
"
|
|
1988
|
-
"
|
|
1669
|
+
"helpGroup": "Delete",
|
|
1670
|
+
"name": "post-destructive-changes",
|
|
1671
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1672
|
+
"hasDynamicHelp": false,
|
|
1673
|
+
"multiple": false,
|
|
1674
|
+
"type": "option"
|
|
1989
1675
|
},
|
|
1990
|
-
"
|
|
1991
|
-
"
|
|
1992
|
-
"
|
|
1676
|
+
"coverage-formatters": {
|
|
1677
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1678
|
+
"helpGroup": "Test",
|
|
1679
|
+
"name": "coverage-formatters",
|
|
1680
|
+
"summary": "Format of the code coverage results.",
|
|
1681
|
+
"hasDynamicHelp": false,
|
|
1682
|
+
"multiple": true,
|
|
1683
|
+
"options": [
|
|
1684
|
+
"clover",
|
|
1685
|
+
"cobertura",
|
|
1686
|
+
"html-spa",
|
|
1687
|
+
"html",
|
|
1688
|
+
"json",
|
|
1689
|
+
"json-summary",
|
|
1690
|
+
"lcovonly",
|
|
1691
|
+
"none",
|
|
1692
|
+
"teamcity",
|
|
1693
|
+
"text",
|
|
1694
|
+
"text-summary"
|
|
1695
|
+
],
|
|
1696
|
+
"type": "option"
|
|
1697
|
+
},
|
|
1698
|
+
"junit": {
|
|
1699
|
+
"helpGroup": "Test",
|
|
1700
|
+
"name": "junit",
|
|
1701
|
+
"summary": "Output JUnit test results.",
|
|
1993
1702
|
"allowNo": false,
|
|
1994
1703
|
"type": "boolean"
|
|
1704
|
+
},
|
|
1705
|
+
"results-dir": {
|
|
1706
|
+
"helpGroup": "Test",
|
|
1707
|
+
"name": "results-dir",
|
|
1708
|
+
"relationships": [
|
|
1709
|
+
{
|
|
1710
|
+
"type": "some",
|
|
1711
|
+
"flags": [
|
|
1712
|
+
"coverage-formatters",
|
|
1713
|
+
"junit"
|
|
1714
|
+
]
|
|
1715
|
+
}
|
|
1716
|
+
],
|
|
1717
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
1718
|
+
"hasDynamicHelp": false,
|
|
1719
|
+
"multiple": false,
|
|
1720
|
+
"type": "option"
|
|
1995
1721
|
}
|
|
1996
1722
|
},
|
|
1997
1723
|
"hasDynamicHelp": true,
|
|
1998
1724
|
"hiddenAliases": [],
|
|
1999
|
-
"id": "project:
|
|
1725
|
+
"id": "project:deploy:start",
|
|
2000
1726
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2001
1727
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2002
1728
|
"pluginType": "core",
|
|
2003
1729
|
"strict": true,
|
|
2004
|
-
"summary": "
|
|
1730
|
+
"summary": "Deploy metadata to an org from your local project.",
|
|
2005
1731
|
"enableJsonFlag": true,
|
|
2006
|
-
"
|
|
1732
|
+
"configurationVariablesSection": {
|
|
1733
|
+
"header": "CONFIGURATION VARIABLES",
|
|
1734
|
+
"body": [
|
|
1735
|
+
{
|
|
1736
|
+
"name": "target-org",
|
|
1737
|
+
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1738
|
+
},
|
|
1739
|
+
{
|
|
1740
|
+
"name": "org-api-version",
|
|
1741
|
+
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1742
|
+
}
|
|
1743
|
+
]
|
|
1744
|
+
},
|
|
1745
|
+
"envVariablesSection": {
|
|
1746
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1747
|
+
"body": [
|
|
1748
|
+
{
|
|
1749
|
+
"name": "SF_TARGET_ORG",
|
|
1750
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1751
|
+
},
|
|
1752
|
+
{
|
|
1753
|
+
"name": "SF_USE_PROGRESS_BAR",
|
|
1754
|
+
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1755
|
+
}
|
|
1756
|
+
]
|
|
1757
|
+
},
|
|
1758
|
+
"errorCodes": {
|
|
1759
|
+
"header": "ERROR CODES",
|
|
1760
|
+
"body": [
|
|
1761
|
+
{
|
|
1762
|
+
"name": "Succeeded (0)",
|
|
1763
|
+
"description": "The deploy succeeded."
|
|
1764
|
+
},
|
|
1765
|
+
{
|
|
1766
|
+
"name": "Canceled (1)",
|
|
1767
|
+
"description": "The deploy was canceled."
|
|
1768
|
+
},
|
|
1769
|
+
{
|
|
1770
|
+
"name": "Failed (1)",
|
|
1771
|
+
"description": "The deploy failed."
|
|
1772
|
+
},
|
|
1773
|
+
{
|
|
1774
|
+
"name": "SucceededPartial (68)",
|
|
1775
|
+
"description": "The deploy partially succeeded."
|
|
1776
|
+
},
|
|
1777
|
+
{
|
|
1778
|
+
"name": "InProgress (69)",
|
|
1779
|
+
"description": "The deploy is in progress."
|
|
1780
|
+
},
|
|
1781
|
+
{
|
|
1782
|
+
"name": "Pending (69)",
|
|
1783
|
+
"description": "The deploy is pending."
|
|
1784
|
+
},
|
|
1785
|
+
{
|
|
1786
|
+
"name": "Canceling (69)",
|
|
1787
|
+
"description": "The deploy is being canceled."
|
|
1788
|
+
}
|
|
1789
|
+
]
|
|
1790
|
+
},
|
|
2007
1791
|
"isESM": true,
|
|
2008
1792
|
"relativePath": [
|
|
2009
1793
|
"lib",
|
|
2010
1794
|
"commands",
|
|
2011
1795
|
"project",
|
|
2012
|
-
"
|
|
2013
|
-
"
|
|
1796
|
+
"deploy",
|
|
1797
|
+
"start.js"
|
|
2014
1798
|
],
|
|
2015
1799
|
"aliasPermutations": [
|
|
2016
|
-
"
|
|
2017
|
-
"
|
|
2018
|
-
"source:delete:force",
|
|
2019
|
-
"force:delete:source",
|
|
2020
|
-
"delete:force:source",
|
|
2021
|
-
"delete:source:force"
|
|
1800
|
+
"deploy:metadata",
|
|
1801
|
+
"metadata:deploy"
|
|
2022
1802
|
],
|
|
2023
1803
|
"permutations": [
|
|
2024
|
-
"project:
|
|
2025
|
-
"
|
|
2026
|
-
"
|
|
2027
|
-
"project:
|
|
2028
|
-
"
|
|
2029
|
-
"
|
|
1804
|
+
"project:deploy:start",
|
|
1805
|
+
"deploy:project:start",
|
|
1806
|
+
"deploy:start:project",
|
|
1807
|
+
"project:start:deploy",
|
|
1808
|
+
"start:project:deploy",
|
|
1809
|
+
"start:deploy:project"
|
|
2030
1810
|
]
|
|
2031
1811
|
},
|
|
2032
|
-
"project:
|
|
1812
|
+
"project:deploy:validate": {
|
|
2033
1813
|
"aliases": [
|
|
2034
|
-
"
|
|
1814
|
+
"deploy:metadata:validate"
|
|
2035
1815
|
],
|
|
2036
1816
|
"args": {},
|
|
2037
1817
|
"deprecateAliases": true,
|
|
2038
|
-
"description": "
|
|
1818
|
+
"description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"<%= config.bin %> project deploy start\", except you're required to run Apex tests, and the command returns a job ID rather than executing the deployment. If the validation succeeds, then you pass this job ID to the \"<%= config.bin %> project deploy quick\" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests. The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nYou must run this command from within a project.\n\nThis command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.\n\nTo validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use \"sf project deploy start --dry-run --test-level RunLocalTests\" instead.",
|
|
2039
1819
|
"examples": [
|
|
2040
|
-
"
|
|
1820
|
+
"NOTE: These examples focus on validating large deployments. See the help for \"<%= config.bin %> project deploy start\" for examples of deploying smaller sets of metadata which you can also use to validate.",
|
|
1821
|
+
"Validate the deployment of all source files in the \"force-app\" directory to the default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
|
|
1822
|
+
"Validate the deployment of all source files in two directories: \"force-app\" and \"force-app-utils\":\n<%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils",
|
|
1823
|
+
"Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\n<%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org",
|
|
1824
|
+
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
2041
1825
|
],
|
|
2042
1826
|
"flags": {
|
|
2043
1827
|
"json": {
|
|
@@ -2056,104 +1840,320 @@
|
|
|
2056
1840
|
"type": "option"
|
|
2057
1841
|
},
|
|
2058
1842
|
"api-version": {
|
|
2059
|
-
"
|
|
2060
|
-
|
|
2061
|
-
],
|
|
2062
|
-
"deprecateAliases": true,
|
|
2063
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1843
|
+
"char": "a",
|
|
1844
|
+
"description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
|
|
2064
1845
|
"name": "api-version",
|
|
1846
|
+
"summary": "Target API version for the validation.",
|
|
2065
1847
|
"hasDynamicHelp": false,
|
|
2066
1848
|
"multiple": false,
|
|
2067
1849
|
"type": "option"
|
|
2068
1850
|
},
|
|
2069
|
-
"
|
|
2070
|
-
"
|
|
2071
|
-
|
|
2072
|
-
|
|
2073
|
-
"
|
|
2074
|
-
"
|
|
1851
|
+
"async": {
|
|
1852
|
+
"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 watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
|
|
1853
|
+
"name": "async",
|
|
1854
|
+
"summary": "Run the command asynchronously.",
|
|
1855
|
+
"allowNo": false,
|
|
1856
|
+
"type": "boolean"
|
|
1857
|
+
},
|
|
1858
|
+
"concise": {
|
|
1859
|
+
"exclusive": [
|
|
1860
|
+
"verbose"
|
|
1861
|
+
],
|
|
1862
|
+
"name": "concise",
|
|
1863
|
+
"summary": "Show concise output of the validation result.",
|
|
1864
|
+
"allowNo": false,
|
|
1865
|
+
"type": "boolean"
|
|
1866
|
+
},
|
|
1867
|
+
"manifest": {
|
|
1868
|
+
"char": "x",
|
|
1869
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1870
|
+
"helpGroup": "Source Format",
|
|
1871
|
+
"name": "manifest",
|
|
1872
|
+
"summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
|
|
2075
1873
|
"hasDynamicHelp": false,
|
|
2076
1874
|
"multiple": false,
|
|
2077
1875
|
"type": "option"
|
|
2078
1876
|
},
|
|
2079
|
-
"
|
|
2080
|
-
"
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
"
|
|
2085
|
-
"
|
|
2086
|
-
"name": "target-org",
|
|
2087
|
-
"noCacheDefault": true,
|
|
2088
|
-
"required": true,
|
|
2089
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2090
|
-
"hasDynamicHelp": true,
|
|
2091
|
-
"multiple": false,
|
|
1877
|
+
"metadata": {
|
|
1878
|
+
"char": "m",
|
|
1879
|
+
"helpGroup": "Source Format",
|
|
1880
|
+
"name": "metadata",
|
|
1881
|
+
"summary": "Metadata component names to validate for deployment.",
|
|
1882
|
+
"hasDynamicHelp": false,
|
|
1883
|
+
"multiple": true,
|
|
2092
1884
|
"type": "option"
|
|
2093
1885
|
},
|
|
2094
|
-
"
|
|
2095
|
-
"
|
|
2096
|
-
|
|
1886
|
+
"source-dir": {
|
|
1887
|
+
"char": "d",
|
|
1888
|
+
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
|
|
1889
|
+
"helpGroup": "Source Format",
|
|
1890
|
+
"name": "source-dir",
|
|
1891
|
+
"summary": "Path to the local source files to validate for deployment.",
|
|
1892
|
+
"hasDynamicHelp": false,
|
|
1893
|
+
"multiple": true,
|
|
1894
|
+
"type": "option"
|
|
1895
|
+
},
|
|
1896
|
+
"metadata-dir": {
|
|
1897
|
+
"helpGroup": "Metadata API Format",
|
|
1898
|
+
"name": "metadata-dir",
|
|
1899
|
+
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1900
|
+
"hasDynamicHelp": false,
|
|
1901
|
+
"multiple": false,
|
|
1902
|
+
"type": "option"
|
|
1903
|
+
},
|
|
1904
|
+
"single-package": {
|
|
1905
|
+
"dependsOn": [
|
|
1906
|
+
"metadata-dir"
|
|
2097
1907
|
],
|
|
2098
|
-
"
|
|
2099
|
-
"
|
|
2100
|
-
"
|
|
2101
|
-
"
|
|
1908
|
+
"helpGroup": "Metadata API Format",
|
|
1909
|
+
"name": "single-package",
|
|
1910
|
+
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1911
|
+
"allowNo": false,
|
|
1912
|
+
"type": "boolean"
|
|
1913
|
+
},
|
|
1914
|
+
"target-org": {
|
|
1915
|
+
"char": "o",
|
|
1916
|
+
"description": "Overrides your default org.",
|
|
1917
|
+
"name": "target-org",
|
|
1918
|
+
"noCacheDefault": true,
|
|
1919
|
+
"required": true,
|
|
1920
|
+
"summary": "Login username or alias for the target org.",
|
|
1921
|
+
"hasDynamicHelp": true,
|
|
1922
|
+
"multiple": false,
|
|
1923
|
+
"type": "option"
|
|
1924
|
+
},
|
|
1925
|
+
"tests": {
|
|
1926
|
+
"char": "t",
|
|
1927
|
+
"description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
|
|
1928
|
+
"helpGroup": "Test",
|
|
1929
|
+
"name": "tests",
|
|
1930
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1931
|
+
"hasDynamicHelp": false,
|
|
1932
|
+
"multiple": true,
|
|
1933
|
+
"type": "option"
|
|
1934
|
+
},
|
|
1935
|
+
"test-level": {
|
|
1936
|
+
"char": "l",
|
|
1937
|
+
"description": "Valid values are:\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.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.",
|
|
1938
|
+
"helpGroup": "Test",
|
|
1939
|
+
"name": "test-level",
|
|
1940
|
+
"summary": "Deployment Apex testing level.",
|
|
1941
|
+
"default": "RunLocalTests",
|
|
1942
|
+
"hasDynamicHelp": false,
|
|
1943
|
+
"multiple": false,
|
|
1944
|
+
"options": [
|
|
1945
|
+
"RunAllTestsInOrg",
|
|
1946
|
+
"RunLocalTests",
|
|
1947
|
+
"RunSpecifiedTests"
|
|
1948
|
+
],
|
|
1949
|
+
"type": "option"
|
|
1950
|
+
},
|
|
1951
|
+
"verbose": {
|
|
1952
|
+
"exclusive": [
|
|
1953
|
+
"concise"
|
|
1954
|
+
],
|
|
1955
|
+
"name": "verbose",
|
|
1956
|
+
"summary": "Show verbose output of the validation result.",
|
|
1957
|
+
"allowNo": false,
|
|
1958
|
+
"type": "boolean"
|
|
1959
|
+
},
|
|
1960
|
+
"wait": {
|
|
1961
|
+
"char": "w",
|
|
1962
|
+
"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 resume watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
|
|
1963
|
+
"name": "wait",
|
|
1964
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1965
|
+
"hasDynamicHelp": true,
|
|
1966
|
+
"helpValue": "<minutes>",
|
|
1967
|
+
"multiple": false,
|
|
1968
|
+
"type": "option"
|
|
1969
|
+
},
|
|
1970
|
+
"ignore-warnings": {
|
|
1971
|
+
"char": "g",
|
|
1972
|
+
"description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
|
|
1973
|
+
"name": "ignore-warnings",
|
|
1974
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1975
|
+
"allowNo": false,
|
|
1976
|
+
"type": "boolean"
|
|
1977
|
+
},
|
|
1978
|
+
"coverage-formatters": {
|
|
1979
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1980
|
+
"helpGroup": "Test",
|
|
1981
|
+
"name": "coverage-formatters",
|
|
1982
|
+
"summary": "Format of the code coverage results.",
|
|
1983
|
+
"hasDynamicHelp": false,
|
|
1984
|
+
"multiple": true,
|
|
1985
|
+
"options": [
|
|
1986
|
+
"clover",
|
|
1987
|
+
"cobertura",
|
|
1988
|
+
"html-spa",
|
|
1989
|
+
"html",
|
|
1990
|
+
"json",
|
|
1991
|
+
"json-summary",
|
|
1992
|
+
"lcovonly",
|
|
1993
|
+
"none",
|
|
1994
|
+
"teamcity",
|
|
1995
|
+
"text",
|
|
1996
|
+
"text-summary"
|
|
1997
|
+
],
|
|
1998
|
+
"type": "option"
|
|
1999
|
+
},
|
|
2000
|
+
"junit": {
|
|
2001
|
+
"helpGroup": "Test",
|
|
2002
|
+
"name": "junit",
|
|
2003
|
+
"summary": "Output JUnit test results.",
|
|
2004
|
+
"allowNo": false,
|
|
2005
|
+
"type": "boolean"
|
|
2006
|
+
},
|
|
2007
|
+
"results-dir": {
|
|
2008
|
+
"helpGroup": "Test",
|
|
2009
|
+
"name": "results-dir",
|
|
2010
|
+
"relationships": [
|
|
2011
|
+
{
|
|
2012
|
+
"type": "some",
|
|
2013
|
+
"flags": [
|
|
2014
|
+
"coverage-formatters",
|
|
2015
|
+
"junit"
|
|
2016
|
+
]
|
|
2017
|
+
}
|
|
2018
|
+
],
|
|
2019
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
2020
|
+
"hasDynamicHelp": false,
|
|
2021
|
+
"multiple": false,
|
|
2022
|
+
"type": "option"
|
|
2023
|
+
},
|
|
2024
|
+
"purge-on-delete": {
|
|
2025
|
+
"dependsOn": [
|
|
2026
|
+
"manifest"
|
|
2027
|
+
],
|
|
2028
|
+
"helpGroup": "Delete",
|
|
2029
|
+
"name": "purge-on-delete",
|
|
2030
|
+
"relationships": [
|
|
2031
|
+
{
|
|
2032
|
+
"type": "some",
|
|
2033
|
+
"flags": [
|
|
2034
|
+
"pre-destructive-changes",
|
|
2035
|
+
"post-destructive-changes"
|
|
2036
|
+
]
|
|
2037
|
+
}
|
|
2038
|
+
],
|
|
2039
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
2102
2040
|
"allowNo": false,
|
|
2103
2041
|
"type": "boolean"
|
|
2042
|
+
},
|
|
2043
|
+
"pre-destructive-changes": {
|
|
2044
|
+
"dependsOn": [
|
|
2045
|
+
"manifest"
|
|
2046
|
+
],
|
|
2047
|
+
"helpGroup": "Delete",
|
|
2048
|
+
"name": "pre-destructive-changes",
|
|
2049
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
2050
|
+
"hasDynamicHelp": false,
|
|
2051
|
+
"multiple": false,
|
|
2052
|
+
"type": "option"
|
|
2053
|
+
},
|
|
2054
|
+
"post-destructive-changes": {
|
|
2055
|
+
"dependsOn": [
|
|
2056
|
+
"manifest"
|
|
2057
|
+
],
|
|
2058
|
+
"helpGroup": "Delete",
|
|
2059
|
+
"name": "post-destructive-changes",
|
|
2060
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
2061
|
+
"hasDynamicHelp": false,
|
|
2062
|
+
"multiple": false,
|
|
2063
|
+
"type": "option"
|
|
2104
2064
|
}
|
|
2105
2065
|
},
|
|
2106
2066
|
"hasDynamicHelp": true,
|
|
2107
2067
|
"hiddenAliases": [],
|
|
2108
|
-
"id": "project:
|
|
2068
|
+
"id": "project:deploy:validate",
|
|
2109
2069
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2110
2070
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2111
2071
|
"pluginType": "core",
|
|
2112
2072
|
"strict": true,
|
|
2113
|
-
"summary": "
|
|
2073
|
+
"summary": "Validate a metadata deployment without actually executing it.",
|
|
2114
2074
|
"enableJsonFlag": true,
|
|
2115
|
-
"
|
|
2075
|
+
"configurationVariablesSection": {
|
|
2076
|
+
"header": "CONFIGURATION VARIABLES",
|
|
2077
|
+
"body": [
|
|
2078
|
+
{
|
|
2079
|
+
"name": "target-org",
|
|
2080
|
+
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
2081
|
+
},
|
|
2082
|
+
{
|
|
2083
|
+
"name": "org-api-version",
|
|
2084
|
+
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
2085
|
+
}
|
|
2086
|
+
]
|
|
2087
|
+
},
|
|
2088
|
+
"envVariablesSection": {
|
|
2089
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2090
|
+
"body": [
|
|
2091
|
+
{
|
|
2092
|
+
"name": "SF_TARGET_ORG",
|
|
2093
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2094
|
+
},
|
|
2095
|
+
{
|
|
2096
|
+
"name": "SF_USE_PROGRESS_BAR",
|
|
2097
|
+
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
2098
|
+
}
|
|
2099
|
+
]
|
|
2100
|
+
},
|
|
2101
|
+
"errorCodes": {
|
|
2102
|
+
"header": "ERROR CODES",
|
|
2103
|
+
"body": [
|
|
2104
|
+
{
|
|
2105
|
+
"name": "Succeeded (0)",
|
|
2106
|
+
"description": "The deploy succeeded."
|
|
2107
|
+
},
|
|
2108
|
+
{
|
|
2109
|
+
"name": "Canceled (1)",
|
|
2110
|
+
"description": "The deploy was canceled."
|
|
2111
|
+
},
|
|
2112
|
+
{
|
|
2113
|
+
"name": "Failed (1)",
|
|
2114
|
+
"description": "The deploy failed."
|
|
2115
|
+
},
|
|
2116
|
+
{
|
|
2117
|
+
"name": "SucceededPartial (68)",
|
|
2118
|
+
"description": "The deploy partially succeeded."
|
|
2119
|
+
},
|
|
2120
|
+
{
|
|
2121
|
+
"name": "InProgress (69)",
|
|
2122
|
+
"description": "The deploy is in progress."
|
|
2123
|
+
},
|
|
2124
|
+
{
|
|
2125
|
+
"name": "Pending (69)",
|
|
2126
|
+
"description": "The deploy is pending."
|
|
2127
|
+
},
|
|
2128
|
+
{
|
|
2129
|
+
"name": "Canceling (69)",
|
|
2130
|
+
"description": "The deploy is being canceled."
|
|
2131
|
+
}
|
|
2132
|
+
]
|
|
2133
|
+
},
|
|
2116
2134
|
"isESM": true,
|
|
2117
2135
|
"relativePath": [
|
|
2118
2136
|
"lib",
|
|
2119
2137
|
"commands",
|
|
2120
2138
|
"project",
|
|
2121
|
-
"
|
|
2122
|
-
"
|
|
2139
|
+
"deploy",
|
|
2140
|
+
"validate.js"
|
|
2123
2141
|
],
|
|
2124
2142
|
"aliasPermutations": [
|
|
2125
|
-
"
|
|
2126
|
-
"
|
|
2127
|
-
"
|
|
2128
|
-
"
|
|
2129
|
-
"
|
|
2130
|
-
"
|
|
2131
|
-
"tracking:source:force:clear",
|
|
2132
|
-
"tracking:source:clear:force",
|
|
2133
|
-
"force:tracking:clear:source",
|
|
2134
|
-
"tracking:force:clear:source",
|
|
2135
|
-
"tracking:clear:force:source",
|
|
2136
|
-
"tracking:clear:source:force",
|
|
2137
|
-
"force:source:clear:tracking",
|
|
2138
|
-
"source:force:clear:tracking",
|
|
2139
|
-
"source:clear:force:tracking",
|
|
2140
|
-
"source:clear:tracking:force",
|
|
2141
|
-
"force:clear:source:tracking",
|
|
2142
|
-
"clear:force:source:tracking",
|
|
2143
|
-
"clear:source:force:tracking",
|
|
2144
|
-
"clear:source:tracking:force",
|
|
2145
|
-
"force:clear:tracking:source",
|
|
2146
|
-
"clear:force:tracking:source",
|
|
2147
|
-
"clear:tracking:force:source",
|
|
2148
|
-
"clear:tracking:source:force"
|
|
2143
|
+
"deploy:metadata:validate",
|
|
2144
|
+
"metadata:deploy:validate",
|
|
2145
|
+
"metadata:validate:deploy",
|
|
2146
|
+
"deploy:validate:metadata",
|
|
2147
|
+
"validate:deploy:metadata",
|
|
2148
|
+
"validate:metadata:deploy"
|
|
2149
2149
|
],
|
|
2150
2150
|
"permutations": [
|
|
2151
|
-
"project:
|
|
2152
|
-
"
|
|
2153
|
-
"
|
|
2154
|
-
"project:
|
|
2155
|
-
"
|
|
2156
|
-
"
|
|
2151
|
+
"project:deploy:validate",
|
|
2152
|
+
"deploy:project:validate",
|
|
2153
|
+
"deploy:validate:project",
|
|
2154
|
+
"project:validate:deploy",
|
|
2155
|
+
"validate:project:deploy",
|
|
2156
|
+
"validate:deploy:project"
|
|
2157
2157
|
]
|
|
2158
2158
|
},
|
|
2159
2159
|
"project:generate:manifest": {
|
|
@@ -2936,5 +2936,5 @@
|
|
|
2936
2936
|
]
|
|
2937
2937
|
}
|
|
2938
2938
|
},
|
|
2939
|
-
"version": "3.6.
|
|
2939
|
+
"version": "3.6.16-dev.1"
|
|
2940
2940
|
}
|