@salesforce/plugin-deploy-retrieve 3.9.15 → 3.9.17
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/oclif.manifest.json
CHANGED
|
@@ -185,10 +185,7 @@
|
|
|
185
185
|
"decomposeCustomLabelsBeta",
|
|
186
186
|
"decomposePermissionSetBeta",
|
|
187
187
|
"decomposeSharingRulesBeta",
|
|
188
|
-
"decomposeWorkflowBeta"
|
|
189
|
-
"presetMap.d.ts",
|
|
190
|
-
"presetMap.js",
|
|
191
|
-
"presetMap.js.map"
|
|
188
|
+
"decomposeWorkflowBeta"
|
|
192
189
|
],
|
|
193
190
|
"type": "option"
|
|
194
191
|
},
|
|
@@ -312,7 +309,7 @@
|
|
|
312
309
|
"deprecateAliases": true,
|
|
313
310
|
"name": "output-dir",
|
|
314
311
|
"summary": "Output directory to store the Metadata API–formatted files in.",
|
|
315
|
-
"default": "
|
|
312
|
+
"default": "metadataPackage_1721161811198",
|
|
316
313
|
"hasDynamicHelp": false,
|
|
317
314
|
"multiple": false,
|
|
318
315
|
"type": "option"
|
|
@@ -405,16 +402,18 @@
|
|
|
405
402
|
"source:convert:project"
|
|
406
403
|
]
|
|
407
404
|
},
|
|
408
|
-
"project:
|
|
405
|
+
"project:delete:source": {
|
|
409
406
|
"aliases": [
|
|
410
|
-
"
|
|
407
|
+
"force:source:delete"
|
|
411
408
|
],
|
|
412
409
|
"args": {},
|
|
413
410
|
"deprecateAliases": true,
|
|
414
|
-
"description": "Use this command to
|
|
411
|
+
"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.",
|
|
415
412
|
"examples": [
|
|
416
|
-
"
|
|
417
|
-
"
|
|
413
|
+
"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",
|
|
414
|
+
"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",
|
|
415
|
+
"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",
|
|
416
|
+
"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"
|
|
418
417
|
],
|
|
419
418
|
"flags": {
|
|
420
419
|
"json": {
|
|
@@ -432,103 +431,206 @@
|
|
|
432
431
|
"multiple": false,
|
|
433
432
|
"type": "option"
|
|
434
433
|
},
|
|
434
|
+
"api-version": {
|
|
435
|
+
"aliases": [
|
|
436
|
+
"apiversion"
|
|
437
|
+
],
|
|
438
|
+
"deprecateAliases": true,
|
|
439
|
+
"description": "Override the api version used for api requests made by this command",
|
|
440
|
+
"name": "api-version",
|
|
441
|
+
"hasDynamicHelp": false,
|
|
442
|
+
"multiple": false,
|
|
443
|
+
"type": "option"
|
|
444
|
+
},
|
|
445
|
+
"loglevel": {
|
|
446
|
+
"deprecated": {
|
|
447
|
+
"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."
|
|
448
|
+
},
|
|
449
|
+
"hidden": true,
|
|
450
|
+
"name": "loglevel",
|
|
451
|
+
"hasDynamicHelp": false,
|
|
452
|
+
"multiple": false,
|
|
453
|
+
"type": "option"
|
|
454
|
+
},
|
|
435
455
|
"target-org": {
|
|
456
|
+
"aliases": [
|
|
457
|
+
"targetusername",
|
|
458
|
+
"u"
|
|
459
|
+
],
|
|
436
460
|
"char": "o",
|
|
461
|
+
"deprecateAliases": true,
|
|
437
462
|
"name": "target-org",
|
|
438
463
|
"noCacheDefault": true,
|
|
439
|
-
"
|
|
464
|
+
"required": true,
|
|
465
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
440
466
|
"hasDynamicHelp": true,
|
|
441
467
|
"multiple": false,
|
|
442
468
|
"type": "option"
|
|
443
469
|
},
|
|
444
|
-
"
|
|
445
|
-
"
|
|
446
|
-
|
|
447
|
-
"wait"
|
|
470
|
+
"check-only": {
|
|
471
|
+
"aliases": [
|
|
472
|
+
"checkonly"
|
|
448
473
|
],
|
|
449
|
-
"
|
|
450
|
-
"
|
|
474
|
+
"char": "c",
|
|
475
|
+
"deprecateAliases": true,
|
|
476
|
+
"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 --check-only 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.",
|
|
477
|
+
"name": "check-only",
|
|
478
|
+
"summary": "Validate delete command but don't delete anything from the org or the local project.",
|
|
451
479
|
"allowNo": false,
|
|
452
480
|
"type": "boolean"
|
|
453
481
|
},
|
|
454
|
-
"
|
|
455
|
-
"char": "
|
|
456
|
-
"description": "
|
|
457
|
-
"name": "
|
|
458
|
-
"summary": "
|
|
482
|
+
"wait": {
|
|
483
|
+
"char": "w",
|
|
484
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
|
|
485
|
+
"name": "wait",
|
|
486
|
+
"summary": "Number of minutes to wait for the command to finish.",
|
|
487
|
+
"hasDynamicHelp": true,
|
|
488
|
+
"multiple": false,
|
|
489
|
+
"type": "option"
|
|
490
|
+
},
|
|
491
|
+
"tests": {
|
|
492
|
+
"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\"",
|
|
493
|
+
"helpGroup": "Test",
|
|
494
|
+
"name": "tests",
|
|
495
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
496
|
+
"hasDynamicHelp": false,
|
|
497
|
+
"multiple": true,
|
|
498
|
+
"type": "option"
|
|
499
|
+
},
|
|
500
|
+
"test-level": {
|
|
501
|
+
"aliases": [
|
|
502
|
+
"testlevel"
|
|
503
|
+
],
|
|
504
|
+
"char": "l",
|
|
505
|
+
"deprecateAliases": true,
|
|
506
|
+
"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.",
|
|
507
|
+
"helpGroup": "Test",
|
|
508
|
+
"name": "test-level",
|
|
509
|
+
"summary": "Deployment Apex testing level.",
|
|
459
510
|
"hasDynamicHelp": false,
|
|
460
511
|
"multiple": false,
|
|
512
|
+
"options": [
|
|
513
|
+
"NoTestRun",
|
|
514
|
+
"RunSpecifiedTests",
|
|
515
|
+
"RunLocalTests",
|
|
516
|
+
"RunAllTestsInOrg"
|
|
517
|
+
],
|
|
461
518
|
"type": "option"
|
|
462
519
|
},
|
|
463
|
-
"
|
|
520
|
+
"no-prompt": {
|
|
521
|
+
"aliases": [
|
|
522
|
+
"noprompt"
|
|
523
|
+
],
|
|
464
524
|
"char": "r",
|
|
465
|
-
"
|
|
466
|
-
"name": "
|
|
467
|
-
"summary": "
|
|
525
|
+
"deprecateAliases": true,
|
|
526
|
+
"name": "no-prompt",
|
|
527
|
+
"summary": "Don't prompt for delete confirmation.",
|
|
468
528
|
"allowNo": false,
|
|
469
529
|
"type": "boolean"
|
|
470
530
|
},
|
|
471
|
-
"
|
|
472
|
-
"char": "
|
|
473
|
-
"description": "If
|
|
474
|
-
"
|
|
475
|
-
|
|
531
|
+
"metadata": {
|
|
532
|
+
"char": "m",
|
|
533
|
+
"description": "If you specify this parameter, don’t specify --source-dir.",
|
|
534
|
+
"name": "metadata",
|
|
535
|
+
"summary": "Metadata components to delete.",
|
|
536
|
+
"delimiter": ",",
|
|
537
|
+
"hasDynamicHelp": false,
|
|
538
|
+
"multiple": true,
|
|
539
|
+
"type": "option"
|
|
540
|
+
},
|
|
541
|
+
"source-dir": {
|
|
542
|
+
"aliases": [
|
|
543
|
+
"sourcepath"
|
|
476
544
|
],
|
|
477
|
-
"
|
|
478
|
-
"
|
|
479
|
-
"
|
|
480
|
-
"
|
|
481
|
-
"
|
|
545
|
+
"char": "p",
|
|
546
|
+
"deprecateAliases": true,
|
|
547
|
+
"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.",
|
|
548
|
+
"name": "source-dir",
|
|
549
|
+
"summary": "Source file paths to delete.",
|
|
550
|
+
"delimiter": ",",
|
|
551
|
+
"hasDynamicHelp": false,
|
|
552
|
+
"multiple": true,
|
|
482
553
|
"type": "option"
|
|
554
|
+
},
|
|
555
|
+
"track-source": {
|
|
556
|
+
"aliases": [
|
|
557
|
+
"tracksource"
|
|
558
|
+
],
|
|
559
|
+
"char": "t",
|
|
560
|
+
"deprecateAliases": true,
|
|
561
|
+
"exclusive": [
|
|
562
|
+
"check-only"
|
|
563
|
+
],
|
|
564
|
+
"name": "track-source",
|
|
565
|
+
"summary": "If the delete succeeds, update the source tracking information.",
|
|
566
|
+
"allowNo": false,
|
|
567
|
+
"type": "boolean"
|
|
568
|
+
},
|
|
569
|
+
"force-overwrite": {
|
|
570
|
+
"aliases": [
|
|
571
|
+
"forceoverwrite"
|
|
572
|
+
],
|
|
573
|
+
"char": "f",
|
|
574
|
+
"dependsOn": [
|
|
575
|
+
"track-source"
|
|
576
|
+
],
|
|
577
|
+
"deprecateAliases": true,
|
|
578
|
+
"name": "force-overwrite",
|
|
579
|
+
"summary": "Ignore conflict warnings and overwrite changes to the org.",
|
|
580
|
+
"allowNo": false,
|
|
581
|
+
"type": "boolean"
|
|
582
|
+
},
|
|
583
|
+
"verbose": {
|
|
584
|
+
"name": "verbose",
|
|
585
|
+
"summary": "Verbose output of the delete result.",
|
|
586
|
+
"allowNo": false,
|
|
587
|
+
"type": "boolean"
|
|
483
588
|
}
|
|
484
589
|
},
|
|
485
590
|
"hasDynamicHelp": true,
|
|
486
591
|
"hiddenAliases": [],
|
|
487
|
-
"id": "project:
|
|
592
|
+
"id": "project:delete:source",
|
|
488
593
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
489
594
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
490
595
|
"pluginType": "core",
|
|
491
596
|
"strict": true,
|
|
492
|
-
"summary": "
|
|
597
|
+
"summary": "Delete source from your project and from a non-source-tracked org.",
|
|
493
598
|
"enableJsonFlag": true,
|
|
599
|
+
"requiresProject": true,
|
|
494
600
|
"isESM": true,
|
|
495
601
|
"relativePath": [
|
|
496
602
|
"lib",
|
|
497
603
|
"commands",
|
|
498
604
|
"project",
|
|
499
|
-
"
|
|
500
|
-
"
|
|
605
|
+
"delete",
|
|
606
|
+
"source.js"
|
|
501
607
|
],
|
|
502
608
|
"aliasPermutations": [
|
|
503
|
-
"
|
|
504
|
-
"
|
|
505
|
-
"
|
|
506
|
-
"
|
|
507
|
-
"
|
|
508
|
-
"
|
|
609
|
+
"force:source:delete",
|
|
610
|
+
"source:force:delete",
|
|
611
|
+
"source:delete:force",
|
|
612
|
+
"force:delete:source",
|
|
613
|
+
"delete:force:source",
|
|
614
|
+
"delete:source:force"
|
|
509
615
|
],
|
|
510
616
|
"permutations": [
|
|
511
|
-
"project:
|
|
512
|
-
"
|
|
513
|
-
"
|
|
514
|
-
"project:
|
|
515
|
-
"
|
|
516
|
-
"
|
|
617
|
+
"project:delete:source",
|
|
618
|
+
"delete:project:source",
|
|
619
|
+
"delete:source:project",
|
|
620
|
+
"project:source:delete",
|
|
621
|
+
"source:project:delete",
|
|
622
|
+
"source:delete:project"
|
|
517
623
|
]
|
|
518
624
|
},
|
|
519
|
-
"project:
|
|
625
|
+
"project:delete:tracking": {
|
|
520
626
|
"aliases": [
|
|
521
|
-
"
|
|
627
|
+
"force:source:tracking:clear"
|
|
522
628
|
],
|
|
523
629
|
"args": {},
|
|
524
630
|
"deprecateAliases": true,
|
|
525
|
-
"description": "
|
|
631
|
+
"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.",
|
|
526
632
|
"examples": [
|
|
527
|
-
"
|
|
528
|
-
"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",
|
|
529
|
-
"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",
|
|
530
|
-
"Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
531
|
-
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
633
|
+
"Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
|
|
532
634
|
],
|
|
533
635
|
"flags": {
|
|
534
636
|
"json": {
|
|
@@ -546,54 +648,34 @@
|
|
|
546
648
|
"multiple": false,
|
|
547
649
|
"type": "option"
|
|
548
650
|
},
|
|
549
|
-
"
|
|
550
|
-
"
|
|
551
|
-
|
|
552
|
-
"name": "ignore-conflicts",
|
|
553
|
-
"summary": "Don't display conflicts in preview of the deployment.",
|
|
554
|
-
"allowNo": false,
|
|
555
|
-
"type": "boolean"
|
|
556
|
-
},
|
|
557
|
-
"manifest": {
|
|
558
|
-
"char": "x",
|
|
559
|
-
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
560
|
-
"exclusive": [
|
|
561
|
-
"source-dir",
|
|
562
|
-
"metadata"
|
|
651
|
+
"api-version": {
|
|
652
|
+
"aliases": [
|
|
653
|
+
"apiversion"
|
|
563
654
|
],
|
|
564
|
-
"
|
|
565
|
-
"
|
|
655
|
+
"deprecateAliases": true,
|
|
656
|
+
"description": "Override the api version used for api requests made by this command",
|
|
657
|
+
"name": "api-version",
|
|
566
658
|
"hasDynamicHelp": false,
|
|
567
659
|
"multiple": false,
|
|
568
660
|
"type": "option"
|
|
569
661
|
},
|
|
570
|
-
"
|
|
571
|
-
"
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
"name": "metadata",
|
|
577
|
-
"summary": "Metadata component names to preview.",
|
|
662
|
+
"loglevel": {
|
|
663
|
+
"deprecated": {
|
|
664
|
+
"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."
|
|
665
|
+
},
|
|
666
|
+
"hidden": true,
|
|
667
|
+
"name": "loglevel",
|
|
578
668
|
"hasDynamicHelp": false,
|
|
579
|
-
"multiple":
|
|
580
|
-
"type": "option"
|
|
581
|
-
},
|
|
582
|
-
"source-dir": {
|
|
583
|
-
"char": "d",
|
|
584
|
-
"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.",
|
|
585
|
-
"exclusive": [
|
|
586
|
-
"manifest",
|
|
587
|
-
"metadata"
|
|
588
|
-
],
|
|
589
|
-
"name": "source-dir",
|
|
590
|
-
"summary": "Path to the local source files to preview.",
|
|
591
|
-
"hasDynamicHelp": false,
|
|
592
|
-
"multiple": true,
|
|
669
|
+
"multiple": false,
|
|
593
670
|
"type": "option"
|
|
594
671
|
},
|
|
595
672
|
"target-org": {
|
|
673
|
+
"aliases": [
|
|
674
|
+
"targetusername",
|
|
675
|
+
"u"
|
|
676
|
+
],
|
|
596
677
|
"char": "o",
|
|
678
|
+
"deprecateAliases": true,
|
|
597
679
|
"name": "target-org",
|
|
598
680
|
"noCacheDefault": true,
|
|
599
681
|
"required": true,
|
|
@@ -602,21 +684,26 @@
|
|
|
602
684
|
"multiple": false,
|
|
603
685
|
"type": "option"
|
|
604
686
|
},
|
|
605
|
-
"
|
|
606
|
-
"
|
|
607
|
-
|
|
687
|
+
"no-prompt": {
|
|
688
|
+
"aliases": [
|
|
689
|
+
"noprompt"
|
|
690
|
+
],
|
|
691
|
+
"char": "p",
|
|
692
|
+
"deprecateAliases": true,
|
|
693
|
+
"name": "no-prompt",
|
|
694
|
+
"summary": "Don't prompt for source tracking override confirmation.",
|
|
608
695
|
"allowNo": false,
|
|
609
696
|
"type": "boolean"
|
|
610
697
|
}
|
|
611
698
|
},
|
|
612
699
|
"hasDynamicHelp": true,
|
|
613
700
|
"hiddenAliases": [],
|
|
614
|
-
"id": "project:
|
|
701
|
+
"id": "project:delete:tracking",
|
|
615
702
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
616
703
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
617
704
|
"pluginType": "core",
|
|
618
705
|
"strict": true,
|
|
619
|
-
"summary": "
|
|
706
|
+
"summary": "Delete all local source tracking information.",
|
|
620
707
|
"enableJsonFlag": true,
|
|
621
708
|
"requiresProject": true,
|
|
622
709
|
"isESM": true,
|
|
@@ -624,36 +711,54 @@
|
|
|
624
711
|
"lib",
|
|
625
712
|
"commands",
|
|
626
713
|
"project",
|
|
627
|
-
"
|
|
628
|
-
"
|
|
714
|
+
"delete",
|
|
715
|
+
"tracking.js"
|
|
629
716
|
],
|
|
630
717
|
"aliasPermutations": [
|
|
631
|
-
"
|
|
632
|
-
"
|
|
633
|
-
"
|
|
634
|
-
"
|
|
635
|
-
"
|
|
636
|
-
"
|
|
718
|
+
"force:source:tracking:clear",
|
|
719
|
+
"source:force:tracking:clear",
|
|
720
|
+
"source:tracking:force:clear",
|
|
721
|
+
"source:tracking:clear:force",
|
|
722
|
+
"force:tracking:source:clear",
|
|
723
|
+
"tracking:force:source:clear",
|
|
724
|
+
"tracking:source:force:clear",
|
|
725
|
+
"tracking:source:clear:force",
|
|
726
|
+
"force:tracking:clear:source",
|
|
727
|
+
"tracking:force:clear:source",
|
|
728
|
+
"tracking:clear:force:source",
|
|
729
|
+
"tracking:clear:source:force",
|
|
730
|
+
"force:source:clear:tracking",
|
|
731
|
+
"source:force:clear:tracking",
|
|
732
|
+
"source:clear:force:tracking",
|
|
733
|
+
"source:clear:tracking:force",
|
|
734
|
+
"force:clear:source:tracking",
|
|
735
|
+
"clear:force:source:tracking",
|
|
736
|
+
"clear:source:force:tracking",
|
|
737
|
+
"clear:source:tracking:force",
|
|
738
|
+
"force:clear:tracking:source",
|
|
739
|
+
"clear:force:tracking:source",
|
|
740
|
+
"clear:tracking:force:source",
|
|
741
|
+
"clear:tracking:source:force"
|
|
637
742
|
],
|
|
638
743
|
"permutations": [
|
|
639
|
-
"project:
|
|
640
|
-
"
|
|
641
|
-
"
|
|
642
|
-
"project:
|
|
643
|
-
"
|
|
644
|
-
"
|
|
744
|
+
"project:delete:tracking",
|
|
745
|
+
"delete:project:tracking",
|
|
746
|
+
"delete:tracking:project",
|
|
747
|
+
"project:tracking:delete",
|
|
748
|
+
"tracking:project:delete",
|
|
749
|
+
"tracking:delete:project"
|
|
645
750
|
]
|
|
646
751
|
},
|
|
647
|
-
"project:deploy:
|
|
752
|
+
"project:deploy:cancel": {
|
|
648
753
|
"aliases": [
|
|
649
|
-
"deploy:metadata:
|
|
754
|
+
"deploy:metadata:cancel"
|
|
650
755
|
],
|
|
651
756
|
"args": {},
|
|
652
757
|
"deprecateAliases": true,
|
|
653
|
-
"description": "
|
|
758
|
+
"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.",
|
|
654
759
|
"examples": [
|
|
655
|
-
"
|
|
656
|
-
"
|
|
760
|
+
"Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
761
|
+
"Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
657
762
|
],
|
|
658
763
|
"flags": {
|
|
659
764
|
"json": {
|
|
@@ -671,8 +776,17 @@
|
|
|
671
776
|
"multiple": false,
|
|
672
777
|
"type": "option"
|
|
673
778
|
},
|
|
779
|
+
"target-org": {
|
|
780
|
+
"char": "o",
|
|
781
|
+
"name": "target-org",
|
|
782
|
+
"noCacheDefault": true,
|
|
783
|
+
"summary": "Username or alias of the target org.",
|
|
784
|
+
"hasDynamicHelp": true,
|
|
785
|
+
"multiple": false,
|
|
786
|
+
"type": "option"
|
|
787
|
+
},
|
|
674
788
|
"async": {
|
|
675
|
-
"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
|
|
789
|
+
"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\".",
|
|
676
790
|
"exclusive": [
|
|
677
791
|
"wait"
|
|
678
792
|
],
|
|
@@ -681,152 +795,84 @@
|
|
|
681
795
|
"allowNo": false,
|
|
682
796
|
"type": "boolean"
|
|
683
797
|
},
|
|
684
|
-
"concise": {
|
|
685
|
-
"exclusive": [
|
|
686
|
-
"verbose"
|
|
687
|
-
],
|
|
688
|
-
"name": "concise",
|
|
689
|
-
"summary": "Show concise output of the deploy result.",
|
|
690
|
-
"allowNo": false,
|
|
691
|
-
"type": "boolean"
|
|
692
|
-
},
|
|
693
798
|
"job-id": {
|
|
694
799
|
"char": "i",
|
|
695
|
-
"description": "
|
|
800
|
+
"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.",
|
|
696
801
|
"name": "job-id",
|
|
697
|
-
"summary": "Job ID of the
|
|
802
|
+
"summary": "Job ID of the deploy operation you want to cancel.",
|
|
698
803
|
"hasDynamicHelp": false,
|
|
699
804
|
"multiple": false,
|
|
700
805
|
"type": "option"
|
|
701
806
|
},
|
|
702
|
-
"target-org": {
|
|
703
|
-
"char": "o",
|
|
704
|
-
"name": "target-org",
|
|
705
|
-
"noCacheDefault": true,
|
|
706
|
-
"summary": "Username or alias of the target org.",
|
|
707
|
-
"hasDynamicHelp": true,
|
|
708
|
-
"multiple": false,
|
|
709
|
-
"type": "option"
|
|
710
|
-
},
|
|
711
807
|
"use-most-recent": {
|
|
712
808
|
"char": "r",
|
|
713
|
-
"description": "For performance reasons, this flag uses
|
|
809
|
+
"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.",
|
|
714
810
|
"name": "use-most-recent",
|
|
715
|
-
"summary": "Use the job ID of the most
|
|
716
|
-
"allowNo": false,
|
|
717
|
-
"type": "boolean"
|
|
718
|
-
},
|
|
719
|
-
"verbose": {
|
|
720
|
-
"exclusive": [
|
|
721
|
-
"concise"
|
|
722
|
-
],
|
|
723
|
-
"name": "verbose",
|
|
724
|
-
"summary": "Show verbose output of the deploy result.",
|
|
811
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
725
812
|
"allowNo": false,
|
|
726
813
|
"type": "boolean"
|
|
727
814
|
},
|
|
728
815
|
"wait": {
|
|
729
816
|
"char": "w",
|
|
730
|
-
"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
|
|
817
|
+
"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\".",
|
|
731
818
|
"exclusive": [
|
|
732
819
|
"async"
|
|
733
820
|
],
|
|
734
821
|
"name": "wait",
|
|
735
822
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
736
|
-
"default": "33 minutes",
|
|
737
823
|
"hasDynamicHelp": true,
|
|
738
824
|
"helpValue": "<minutes>",
|
|
739
825
|
"multiple": false,
|
|
740
826
|
"type": "option"
|
|
741
|
-
},
|
|
742
|
-
"api-version": {
|
|
743
|
-
"char": "a",
|
|
744
|
-
"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.",
|
|
745
|
-
"name": "api-version",
|
|
746
|
-
"summary": "Target API version for the deploy.",
|
|
747
|
-
"hasDynamicHelp": false,
|
|
748
|
-
"multiple": false,
|
|
749
|
-
"type": "option"
|
|
750
827
|
}
|
|
751
828
|
},
|
|
752
829
|
"hasDynamicHelp": true,
|
|
753
830
|
"hiddenAliases": [],
|
|
754
|
-
"id": "project:deploy:
|
|
831
|
+
"id": "project:deploy:cancel",
|
|
755
832
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
756
833
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
757
834
|
"pluginType": "core",
|
|
758
835
|
"strict": true,
|
|
759
|
-
"summary": "
|
|
836
|
+
"summary": "Cancel a deploy operation.",
|
|
760
837
|
"enableJsonFlag": true,
|
|
761
|
-
"errorCodes": {
|
|
762
|
-
"header": "ERROR CODES",
|
|
763
|
-
"body": [
|
|
764
|
-
{
|
|
765
|
-
"name": "Succeeded (0)",
|
|
766
|
-
"description": "The deploy succeeded."
|
|
767
|
-
},
|
|
768
|
-
{
|
|
769
|
-
"name": "Canceled (1)",
|
|
770
|
-
"description": "The deploy was canceled."
|
|
771
|
-
},
|
|
772
|
-
{
|
|
773
|
-
"name": "Failed (1)",
|
|
774
|
-
"description": "The deploy failed."
|
|
775
|
-
},
|
|
776
|
-
{
|
|
777
|
-
"name": "SucceededPartial (68)",
|
|
778
|
-
"description": "The deploy partially succeeded."
|
|
779
|
-
},
|
|
780
|
-
{
|
|
781
|
-
"name": "InProgress (69)",
|
|
782
|
-
"description": "The deploy is in progress."
|
|
783
|
-
},
|
|
784
|
-
{
|
|
785
|
-
"name": "Pending (69)",
|
|
786
|
-
"description": "The deploy is pending."
|
|
787
|
-
},
|
|
788
|
-
{
|
|
789
|
-
"name": "Canceling (69)",
|
|
790
|
-
"description": "The deploy is being canceled."
|
|
791
|
-
}
|
|
792
|
-
]
|
|
793
|
-
},
|
|
794
838
|
"isESM": true,
|
|
795
839
|
"relativePath": [
|
|
796
840
|
"lib",
|
|
797
841
|
"commands",
|
|
798
842
|
"project",
|
|
799
843
|
"deploy",
|
|
800
|
-
"
|
|
844
|
+
"cancel.js"
|
|
801
845
|
],
|
|
802
846
|
"aliasPermutations": [
|
|
803
|
-
"deploy:metadata:
|
|
804
|
-
"metadata:deploy:
|
|
805
|
-
"metadata:
|
|
806
|
-
"deploy:
|
|
807
|
-
"
|
|
808
|
-
"
|
|
847
|
+
"deploy:metadata:cancel",
|
|
848
|
+
"metadata:deploy:cancel",
|
|
849
|
+
"metadata:cancel:deploy",
|
|
850
|
+
"deploy:cancel:metadata",
|
|
851
|
+
"cancel:deploy:metadata",
|
|
852
|
+
"cancel:metadata:deploy"
|
|
809
853
|
],
|
|
810
854
|
"permutations": [
|
|
811
|
-
"project:deploy:
|
|
812
|
-
"deploy:project:
|
|
813
|
-
"deploy:
|
|
814
|
-
"project:
|
|
815
|
-
"
|
|
816
|
-
"
|
|
855
|
+
"project:deploy:cancel",
|
|
856
|
+
"deploy:project:cancel",
|
|
857
|
+
"deploy:cancel:project",
|
|
858
|
+
"project:cancel:deploy",
|
|
859
|
+
"cancel:project:deploy",
|
|
860
|
+
"cancel:deploy:project"
|
|
817
861
|
]
|
|
818
862
|
},
|
|
819
|
-
"project:deploy:
|
|
863
|
+
"project:deploy:preview": {
|
|
820
864
|
"aliases": [
|
|
821
|
-
"deploy:metadata:
|
|
865
|
+
"deploy:metadata:preview"
|
|
822
866
|
],
|
|
823
867
|
"args": {},
|
|
824
868
|
"deprecateAliases": true,
|
|
825
|
-
"description": "
|
|
869
|
+
"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.",
|
|
826
870
|
"examples": [
|
|
827
|
-
"
|
|
828
|
-
"
|
|
829
|
-
"
|
|
871
|
+
"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.",
|
|
872
|
+
"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",
|
|
873
|
+
"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",
|
|
874
|
+
"Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
875
|
+
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
830
876
|
],
|
|
831
877
|
"flags": {
|
|
832
878
|
"json": {
|
|
@@ -844,133 +890,114 @@
|
|
|
844
890
|
"multiple": false,
|
|
845
891
|
"type": "option"
|
|
846
892
|
},
|
|
847
|
-
"
|
|
848
|
-
"char": "
|
|
849
|
-
"
|
|
850
|
-
"
|
|
851
|
-
"summary": "
|
|
852
|
-
"
|
|
853
|
-
"
|
|
854
|
-
"type": "option"
|
|
893
|
+
"ignore-conflicts": {
|
|
894
|
+
"char": "c",
|
|
895
|
+
"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.",
|
|
896
|
+
"name": "ignore-conflicts",
|
|
897
|
+
"summary": "Don't display conflicts in preview of the deployment.",
|
|
898
|
+
"allowNo": false,
|
|
899
|
+
"type": "boolean"
|
|
855
900
|
},
|
|
856
|
-
"
|
|
857
|
-
"char": "
|
|
858
|
-
"description": "
|
|
859
|
-
"
|
|
860
|
-
|
|
901
|
+
"manifest": {
|
|
902
|
+
"char": "x",
|
|
903
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
904
|
+
"exclusive": [
|
|
905
|
+
"source-dir",
|
|
906
|
+
"metadata"
|
|
907
|
+
],
|
|
908
|
+
"name": "manifest",
|
|
909
|
+
"summary": "Full file path for manifest (package.xml) of components to preview.",
|
|
861
910
|
"hasDynamicHelp": false,
|
|
862
911
|
"multiple": false,
|
|
863
912
|
"type": "option"
|
|
864
913
|
},
|
|
865
|
-
"
|
|
866
|
-
"char": "
|
|
867
|
-
"
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
"
|
|
872
|
-
|
|
873
|
-
"coverage-formatters": {
|
|
874
|
-
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
875
|
-
"helpGroup": "Test",
|
|
876
|
-
"name": "coverage-formatters",
|
|
877
|
-
"summary": "Format of the code coverage results.",
|
|
914
|
+
"metadata": {
|
|
915
|
+
"char": "m",
|
|
916
|
+
"exclusive": [
|
|
917
|
+
"manifest",
|
|
918
|
+
"source-dir"
|
|
919
|
+
],
|
|
920
|
+
"name": "metadata",
|
|
921
|
+
"summary": "Metadata component names to preview.",
|
|
878
922
|
"hasDynamicHelp": false,
|
|
879
923
|
"multiple": true,
|
|
880
|
-
"options": [
|
|
881
|
-
"clover",
|
|
882
|
-
"cobertura",
|
|
883
|
-
"html-spa",
|
|
884
|
-
"html",
|
|
885
|
-
"json",
|
|
886
|
-
"json-summary",
|
|
887
|
-
"lcovonly",
|
|
888
|
-
"none",
|
|
889
|
-
"teamcity",
|
|
890
|
-
"text",
|
|
891
|
-
"text-summary"
|
|
892
|
-
],
|
|
893
924
|
"type": "option"
|
|
894
925
|
},
|
|
895
|
-
"
|
|
896
|
-
"
|
|
897
|
-
"
|
|
898
|
-
"
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
},
|
|
902
|
-
"results-dir": {
|
|
903
|
-
"helpGroup": "Test",
|
|
904
|
-
"name": "results-dir",
|
|
905
|
-
"relationships": [
|
|
906
|
-
{
|
|
907
|
-
"type": "some",
|
|
908
|
-
"flags": [
|
|
909
|
-
"coverage-formatters",
|
|
910
|
-
"junit"
|
|
911
|
-
]
|
|
912
|
-
}
|
|
926
|
+
"source-dir": {
|
|
927
|
+
"char": "d",
|
|
928
|
+
"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.",
|
|
929
|
+
"exclusive": [
|
|
930
|
+
"manifest",
|
|
931
|
+
"metadata"
|
|
913
932
|
],
|
|
914
|
-
"
|
|
933
|
+
"name": "source-dir",
|
|
934
|
+
"summary": "Path to the local source files to preview.",
|
|
915
935
|
"hasDynamicHelp": false,
|
|
916
|
-
"multiple":
|
|
936
|
+
"multiple": true,
|
|
917
937
|
"type": "option"
|
|
918
938
|
},
|
|
919
|
-
"
|
|
920
|
-
"char": "
|
|
921
|
-
"
|
|
922
|
-
"
|
|
923
|
-
"
|
|
939
|
+
"target-org": {
|
|
940
|
+
"char": "o",
|
|
941
|
+
"name": "target-org",
|
|
942
|
+
"noCacheDefault": true,
|
|
943
|
+
"required": true,
|
|
944
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
924
945
|
"hasDynamicHelp": true,
|
|
925
|
-
"helpValue": "<minutes>",
|
|
926
946
|
"multiple": false,
|
|
927
947
|
"type": "option"
|
|
948
|
+
},
|
|
949
|
+
"concise": {
|
|
950
|
+
"name": "concise",
|
|
951
|
+
"summary": "Show only the changes that will be deployed; omits files that are forceignored.",
|
|
952
|
+
"allowNo": false,
|
|
953
|
+
"type": "boolean"
|
|
928
954
|
}
|
|
929
955
|
},
|
|
930
956
|
"hasDynamicHelp": true,
|
|
931
957
|
"hiddenAliases": [],
|
|
932
|
-
"id": "project:deploy:
|
|
958
|
+
"id": "project:deploy:preview",
|
|
933
959
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
934
960
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
935
961
|
"pluginType": "core",
|
|
936
962
|
"strict": true,
|
|
937
|
-
"summary": "
|
|
963
|
+
"summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
|
|
938
964
|
"enableJsonFlag": true,
|
|
965
|
+
"requiresProject": true,
|
|
939
966
|
"isESM": true,
|
|
940
967
|
"relativePath": [
|
|
941
968
|
"lib",
|
|
942
969
|
"commands",
|
|
943
970
|
"project",
|
|
944
971
|
"deploy",
|
|
945
|
-
"
|
|
972
|
+
"preview.js"
|
|
946
973
|
],
|
|
947
974
|
"aliasPermutations": [
|
|
948
|
-
"deploy:metadata:
|
|
949
|
-
"metadata:deploy:
|
|
950
|
-
"metadata:
|
|
951
|
-
"deploy:
|
|
952
|
-
"
|
|
953
|
-
"
|
|
975
|
+
"deploy:metadata:preview",
|
|
976
|
+
"metadata:deploy:preview",
|
|
977
|
+
"metadata:preview:deploy",
|
|
978
|
+
"deploy:preview:metadata",
|
|
979
|
+
"preview:deploy:metadata",
|
|
980
|
+
"preview:metadata:deploy"
|
|
954
981
|
],
|
|
955
982
|
"permutations": [
|
|
956
|
-
"project:deploy:
|
|
957
|
-
"deploy:project:
|
|
958
|
-
"deploy:
|
|
959
|
-
"project:
|
|
960
|
-
"
|
|
961
|
-
"
|
|
983
|
+
"project:deploy:preview",
|
|
984
|
+
"deploy:project:preview",
|
|
985
|
+
"deploy:preview:project",
|
|
986
|
+
"project:preview:deploy",
|
|
987
|
+
"preview:project:deploy",
|
|
988
|
+
"preview:deploy:project"
|
|
962
989
|
]
|
|
963
990
|
},
|
|
964
|
-
"project:deploy:
|
|
991
|
+
"project:deploy:quick": {
|
|
965
992
|
"aliases": [
|
|
966
|
-
"deploy:metadata:
|
|
993
|
+
"deploy:metadata:quick"
|
|
967
994
|
],
|
|
968
995
|
"args": {},
|
|
969
996
|
"deprecateAliases": true,
|
|
970
|
-
"description": "
|
|
997
|
+
"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 \"<%= config.bin %> project deploy start\" instead.",
|
|
971
998
|
"examples": [
|
|
972
|
-
"
|
|
973
|
-
"
|
|
999
|
+
"Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1000
|
+
"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"
|
|
974
1001
|
],
|
|
975
1002
|
"flags": {
|
|
976
1003
|
"json": {
|
|
@@ -988,29 +1015,48 @@
|
|
|
988
1015
|
"multiple": false,
|
|
989
1016
|
"type": "option"
|
|
990
1017
|
},
|
|
1018
|
+
"async": {
|
|
1019
|
+
"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\".",
|
|
1020
|
+
"exclusive": [
|
|
1021
|
+
"wait"
|
|
1022
|
+
],
|
|
1023
|
+
"name": "async",
|
|
1024
|
+
"summary": "Run the command asynchronously.",
|
|
1025
|
+
"allowNo": false,
|
|
1026
|
+
"type": "boolean"
|
|
1027
|
+
},
|
|
991
1028
|
"concise": {
|
|
992
1029
|
"exclusive": [
|
|
993
1030
|
"verbose"
|
|
994
1031
|
],
|
|
995
1032
|
"name": "concise",
|
|
996
|
-
"summary": "Show concise output of the deploy
|
|
1033
|
+
"summary": "Show concise output of the deploy result.",
|
|
997
1034
|
"allowNo": false,
|
|
998
1035
|
"type": "boolean"
|
|
999
1036
|
},
|
|
1000
1037
|
"job-id": {
|
|
1001
1038
|
"char": "i",
|
|
1002
|
-
"description": "
|
|
1039
|
+
"description": "The job ID is valid for 10 days from when you started the validation.",
|
|
1003
1040
|
"name": "job-id",
|
|
1004
|
-
"summary": "Job ID of the
|
|
1041
|
+
"summary": "Job ID of the deployment you want to quick deploy.",
|
|
1005
1042
|
"hasDynamicHelp": false,
|
|
1006
1043
|
"multiple": false,
|
|
1007
1044
|
"type": "option"
|
|
1008
1045
|
},
|
|
1046
|
+
"target-org": {
|
|
1047
|
+
"char": "o",
|
|
1048
|
+
"name": "target-org",
|
|
1049
|
+
"noCacheDefault": true,
|
|
1050
|
+
"summary": "Username or alias of the target org.",
|
|
1051
|
+
"hasDynamicHelp": true,
|
|
1052
|
+
"multiple": false,
|
|
1053
|
+
"type": "option"
|
|
1054
|
+
},
|
|
1009
1055
|
"use-most-recent": {
|
|
1010
1056
|
"char": "r",
|
|
1011
|
-
"description": "For performance reasons, this flag uses job IDs
|
|
1057
|
+
"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.",
|
|
1012
1058
|
"name": "use-most-recent",
|
|
1013
|
-
"summary": "Use the job ID of the most
|
|
1059
|
+
"summary": "Use the job ID of the most recently validated deployment.",
|
|
1014
1060
|
"allowNo": false,
|
|
1015
1061
|
"type": "boolean"
|
|
1016
1062
|
},
|
|
@@ -1019,62 +1065,29 @@
|
|
|
1019
1065
|
"concise"
|
|
1020
1066
|
],
|
|
1021
1067
|
"name": "verbose",
|
|
1022
|
-
"summary": "Show verbose output of the deploy
|
|
1068
|
+
"summary": "Show verbose output of the deploy result.",
|
|
1023
1069
|
"allowNo": false,
|
|
1024
1070
|
"type": "boolean"
|
|
1025
1071
|
},
|
|
1026
1072
|
"wait": {
|
|
1027
1073
|
"char": "w",
|
|
1028
|
-
"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
|
|
1074
|
+
"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\".",
|
|
1075
|
+
"exclusive": [
|
|
1076
|
+
"async"
|
|
1077
|
+
],
|
|
1029
1078
|
"name": "wait",
|
|
1030
1079
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1080
|
+
"default": "33 minutes",
|
|
1031
1081
|
"hasDynamicHelp": true,
|
|
1032
1082
|
"helpValue": "<minutes>",
|
|
1033
1083
|
"multiple": false,
|
|
1034
1084
|
"type": "option"
|
|
1035
1085
|
},
|
|
1036
|
-
"
|
|
1037
|
-
"
|
|
1038
|
-
"
|
|
1039
|
-
"name": "
|
|
1040
|
-
"summary": "
|
|
1041
|
-
"hasDynamicHelp": false,
|
|
1042
|
-
"multiple": true,
|
|
1043
|
-
"options": [
|
|
1044
|
-
"clover",
|
|
1045
|
-
"cobertura",
|
|
1046
|
-
"html-spa",
|
|
1047
|
-
"html",
|
|
1048
|
-
"json",
|
|
1049
|
-
"json-summary",
|
|
1050
|
-
"lcovonly",
|
|
1051
|
-
"none",
|
|
1052
|
-
"teamcity",
|
|
1053
|
-
"text",
|
|
1054
|
-
"text-summary"
|
|
1055
|
-
],
|
|
1056
|
-
"type": "option"
|
|
1057
|
-
},
|
|
1058
|
-
"junit": {
|
|
1059
|
-
"helpGroup": "Test",
|
|
1060
|
-
"name": "junit",
|
|
1061
|
-
"summary": "Output JUnit test results.",
|
|
1062
|
-
"allowNo": false,
|
|
1063
|
-
"type": "boolean"
|
|
1064
|
-
},
|
|
1065
|
-
"results-dir": {
|
|
1066
|
-
"helpGroup": "Test",
|
|
1067
|
-
"name": "results-dir",
|
|
1068
|
-
"relationships": [
|
|
1069
|
-
{
|
|
1070
|
-
"type": "some",
|
|
1071
|
-
"flags": [
|
|
1072
|
-
"coverage-formatters",
|
|
1073
|
-
"junit"
|
|
1074
|
-
]
|
|
1075
|
-
}
|
|
1076
|
-
],
|
|
1077
|
-
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
1086
|
+
"api-version": {
|
|
1087
|
+
"char": "a",
|
|
1088
|
+
"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.",
|
|
1089
|
+
"name": "api-version",
|
|
1090
|
+
"summary": "Target API version for the deploy.",
|
|
1078
1091
|
"hasDynamicHelp": false,
|
|
1079
1092
|
"multiple": false,
|
|
1080
1093
|
"type": "option"
|
|
@@ -1082,22 +1095,13 @@
|
|
|
1082
1095
|
},
|
|
1083
1096
|
"hasDynamicHelp": true,
|
|
1084
1097
|
"hiddenAliases": [],
|
|
1085
|
-
"id": "project:deploy:
|
|
1098
|
+
"id": "project:deploy:quick",
|
|
1086
1099
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1087
1100
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1088
1101
|
"pluginType": "core",
|
|
1089
1102
|
"strict": true,
|
|
1090
|
-
"summary": "
|
|
1103
|
+
"summary": "Quickly deploy a validated deployment to an org.",
|
|
1091
1104
|
"enableJsonFlag": true,
|
|
1092
|
-
"envVariablesSection": {
|
|
1093
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1094
|
-
"body": [
|
|
1095
|
-
{
|
|
1096
|
-
"name": "SF_USE_PROGRESS_BAR",
|
|
1097
|
-
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1098
|
-
}
|
|
1099
|
-
]
|
|
1100
|
-
},
|
|
1101
1105
|
"errorCodes": {
|
|
1102
1106
|
"header": "ERROR CODES",
|
|
1103
1107
|
"body": [
|
|
@@ -1137,47 +1141,36 @@
|
|
|
1137
1141
|
"commands",
|
|
1138
1142
|
"project",
|
|
1139
1143
|
"deploy",
|
|
1140
|
-
"
|
|
1144
|
+
"quick.js"
|
|
1141
1145
|
],
|
|
1142
1146
|
"aliasPermutations": [
|
|
1143
|
-
"deploy:metadata:
|
|
1144
|
-
"metadata:deploy:
|
|
1145
|
-
"metadata:
|
|
1146
|
-
"deploy:
|
|
1147
|
-
"
|
|
1148
|
-
"
|
|
1147
|
+
"deploy:metadata:quick",
|
|
1148
|
+
"metadata:deploy:quick",
|
|
1149
|
+
"metadata:quick:deploy",
|
|
1150
|
+
"deploy:quick:metadata",
|
|
1151
|
+
"quick:deploy:metadata",
|
|
1152
|
+
"quick:metadata:deploy"
|
|
1149
1153
|
],
|
|
1150
1154
|
"permutations": [
|
|
1151
|
-
"project:deploy:
|
|
1152
|
-
"deploy:project:
|
|
1153
|
-
"deploy:
|
|
1154
|
-
"project:
|
|
1155
|
-
"
|
|
1156
|
-
"
|
|
1155
|
+
"project:deploy:quick",
|
|
1156
|
+
"deploy:project:quick",
|
|
1157
|
+
"deploy:quick:project",
|
|
1158
|
+
"project:quick:deploy",
|
|
1159
|
+
"quick:project:deploy",
|
|
1160
|
+
"quick:deploy:project"
|
|
1157
1161
|
]
|
|
1158
1162
|
},
|
|
1159
|
-
"project:deploy:
|
|
1163
|
+
"project:deploy:report": {
|
|
1160
1164
|
"aliases": [
|
|
1161
|
-
"deploy:metadata"
|
|
1165
|
+
"deploy:metadata:report"
|
|
1162
1166
|
],
|
|
1163
1167
|
"args": {},
|
|
1164
1168
|
"deprecateAliases": true,
|
|
1165
|
-
"description": "
|
|
1169
|
+
"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.",
|
|
1166
1170
|
"examples": [
|
|
1167
|
-
"
|
|
1168
|
-
"
|
|
1169
|
-
"
|
|
1170
|
-
"Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
1171
|
-
"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",
|
|
1172
|
-
"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",
|
|
1173
|
-
"Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
|
|
1174
|
-
"Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
|
|
1175
|
-
"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",
|
|
1176
|
-
"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\"",
|
|
1177
|
-
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1178
|
-
"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",
|
|
1179
|
-
"Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
|
|
1180
|
-
"Deploy all metadata formatted files in the \"MDAPI\" directory; items listed in the MDAPI/destructiveChangesPre.xml and MDAPI/destructiveChangesPost.xml manifests are immediately eligible for deletion rather than stored in the Recycle Bin:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI --purge-on-delete"
|
|
1171
|
+
"Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1172
|
+
"Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
|
|
1173
|
+
"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"
|
|
1181
1174
|
],
|
|
1182
1175
|
"flags": {
|
|
1183
1176
|
"json": {
|
|
@@ -1195,229 +1188,32 @@
|
|
|
1195
1188
|
"multiple": false,
|
|
1196
1189
|
"type": "option"
|
|
1197
1190
|
},
|
|
1198
|
-
"api-version": {
|
|
1199
|
-
"char": "a",
|
|
1200
|
-
"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.",
|
|
1201
|
-
"name": "api-version",
|
|
1202
|
-
"summary": "Target API version for the deploy.",
|
|
1203
|
-
"hasDynamicHelp": false,
|
|
1204
|
-
"multiple": false,
|
|
1205
|
-
"type": "option"
|
|
1206
|
-
},
|
|
1207
|
-
"async": {
|
|
1208
|
-
"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\".",
|
|
1209
|
-
"exclusive": [
|
|
1210
|
-
"wait"
|
|
1211
|
-
],
|
|
1212
|
-
"name": "async",
|
|
1213
|
-
"summary": "Run the command asynchronously.",
|
|
1214
|
-
"allowNo": false,
|
|
1215
|
-
"type": "boolean"
|
|
1216
|
-
},
|
|
1217
|
-
"concise": {
|
|
1218
|
-
"exclusive": [
|
|
1219
|
-
"verbose"
|
|
1220
|
-
],
|
|
1221
|
-
"name": "concise",
|
|
1222
|
-
"summary": "Show concise output of the deploy result.",
|
|
1223
|
-
"allowNo": false,
|
|
1224
|
-
"type": "boolean"
|
|
1225
|
-
},
|
|
1226
|
-
"dry-run": {
|
|
1227
|
-
"name": "dry-run",
|
|
1228
|
-
"summary": "Validate deploy and run Apex tests but don’t save to the org.",
|
|
1229
|
-
"allowNo": false,
|
|
1230
|
-
"type": "boolean"
|
|
1231
|
-
},
|
|
1232
|
-
"ignore-conflicts": {
|
|
1233
|
-
"char": "c",
|
|
1234
|
-
"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.",
|
|
1235
|
-
"name": "ignore-conflicts",
|
|
1236
|
-
"summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
|
|
1237
|
-
"allowNo": false,
|
|
1238
|
-
"type": "boolean"
|
|
1239
|
-
},
|
|
1240
|
-
"ignore-errors": {
|
|
1241
|
-
"char": "r",
|
|
1242
|
-
"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.",
|
|
1243
|
-
"name": "ignore-errors",
|
|
1244
|
-
"summary": "Ignore any errors and don’t roll back deployment.",
|
|
1245
|
-
"allowNo": false,
|
|
1246
|
-
"type": "boolean"
|
|
1247
|
-
},
|
|
1248
|
-
"ignore-warnings": {
|
|
1249
|
-
"char": "g",
|
|
1250
|
-
"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.",
|
|
1251
|
-
"name": "ignore-warnings",
|
|
1252
|
-
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1253
|
-
"allowNo": false,
|
|
1254
|
-
"type": "boolean"
|
|
1255
|
-
},
|
|
1256
|
-
"manifest": {
|
|
1257
|
-
"char": "x",
|
|
1258
|
-
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1259
|
-
"exclusive": [
|
|
1260
|
-
"source-dir",
|
|
1261
|
-
"metadata",
|
|
1262
|
-
"metadata-dir"
|
|
1263
|
-
],
|
|
1264
|
-
"helpGroup": "Source Format",
|
|
1265
|
-
"name": "manifest",
|
|
1266
|
-
"summary": "Full file path for manifest (package.xml) of components to deploy.",
|
|
1267
|
-
"hasDynamicHelp": false,
|
|
1268
|
-
"multiple": false,
|
|
1269
|
-
"type": "option"
|
|
1270
|
-
},
|
|
1271
|
-
"metadata": {
|
|
1272
|
-
"char": "m",
|
|
1273
|
-
"exclusive": [
|
|
1274
|
-
"manifest",
|
|
1275
|
-
"source-dir",
|
|
1276
|
-
"metadata-dir"
|
|
1277
|
-
],
|
|
1278
|
-
"helpGroup": "Source Format",
|
|
1279
|
-
"name": "metadata",
|
|
1280
|
-
"summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
|
|
1281
|
-
"hasDynamicHelp": false,
|
|
1282
|
-
"multiple": true,
|
|
1283
|
-
"type": "option"
|
|
1284
|
-
},
|
|
1285
|
-
"metadata-dir": {
|
|
1286
|
-
"exclusive": [
|
|
1287
|
-
"manifest",
|
|
1288
|
-
"source-dir",
|
|
1289
|
-
"metadata"
|
|
1290
|
-
],
|
|
1291
|
-
"helpGroup": "Metadata API Format",
|
|
1292
|
-
"name": "metadata-dir",
|
|
1293
|
-
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1294
|
-
"hasDynamicHelp": false,
|
|
1295
|
-
"multiple": false,
|
|
1296
|
-
"type": "option"
|
|
1297
|
-
},
|
|
1298
|
-
"single-package": {
|
|
1299
|
-
"dependsOn": [
|
|
1300
|
-
"metadata-dir"
|
|
1301
|
-
],
|
|
1302
|
-
"helpGroup": "Metadata API Format",
|
|
1303
|
-
"name": "single-package",
|
|
1304
|
-
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1305
|
-
"allowNo": false,
|
|
1306
|
-
"type": "boolean"
|
|
1307
|
-
},
|
|
1308
|
-
"source-dir": {
|
|
1309
|
-
"char": "d",
|
|
1310
|
-
"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.",
|
|
1311
|
-
"exclusive": [
|
|
1312
|
-
"manifest",
|
|
1313
|
-
"metadata",
|
|
1314
|
-
"metadata-dir"
|
|
1315
|
-
],
|
|
1316
|
-
"helpGroup": "Source Format",
|
|
1317
|
-
"name": "source-dir",
|
|
1318
|
-
"summary": "Path to the local source files to deploy.",
|
|
1319
|
-
"hasDynamicHelp": false,
|
|
1320
|
-
"multiple": true,
|
|
1321
|
-
"type": "option"
|
|
1322
|
-
},
|
|
1323
1191
|
"target-org": {
|
|
1324
1192
|
"char": "o",
|
|
1325
1193
|
"name": "target-org",
|
|
1326
1194
|
"noCacheDefault": true,
|
|
1327
|
-
"
|
|
1328
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1195
|
+
"summary": "Username or alias of the target org.",
|
|
1329
1196
|
"hasDynamicHelp": true,
|
|
1330
1197
|
"multiple": false,
|
|
1331
1198
|
"type": "option"
|
|
1332
1199
|
},
|
|
1333
|
-
"
|
|
1334
|
-
"char": "
|
|
1335
|
-
"description": "
|
|
1336
|
-
"
|
|
1337
|
-
"
|
|
1338
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1339
|
-
"hasDynamicHelp": false,
|
|
1340
|
-
"multiple": true,
|
|
1341
|
-
"type": "option"
|
|
1342
|
-
},
|
|
1343
|
-
"test-level": {
|
|
1344
|
-
"char": "l",
|
|
1345
|
-
"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\".",
|
|
1346
|
-
"helpGroup": "Test",
|
|
1347
|
-
"name": "test-level",
|
|
1348
|
-
"summary": "Deployment Apex testing level.",
|
|
1200
|
+
"job-id": {
|
|
1201
|
+
"char": "i",
|
|
1202
|
+
"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.",
|
|
1203
|
+
"name": "job-id",
|
|
1204
|
+
"summary": "Job ID of the deploy operation you want to check the status of.",
|
|
1349
1205
|
"hasDynamicHelp": false,
|
|
1350
1206
|
"multiple": false,
|
|
1351
|
-
"options": [
|
|
1352
|
-
"NoTestRun",
|
|
1353
|
-
"RunSpecifiedTests",
|
|
1354
|
-
"RunLocalTests",
|
|
1355
|
-
"RunAllTestsInOrg"
|
|
1356
|
-
],
|
|
1357
|
-
"type": "option"
|
|
1358
|
-
},
|
|
1359
|
-
"verbose": {
|
|
1360
|
-
"exclusive": [
|
|
1361
|
-
"concise"
|
|
1362
|
-
],
|
|
1363
|
-
"name": "verbose",
|
|
1364
|
-
"summary": "Show verbose output of the deploy result.",
|
|
1365
|
-
"allowNo": false,
|
|
1366
|
-
"type": "boolean"
|
|
1367
|
-
},
|
|
1368
|
-
"wait": {
|
|
1369
|
-
"char": "w",
|
|
1370
|
-
"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\".",
|
|
1371
|
-
"exclusive": [
|
|
1372
|
-
"async"
|
|
1373
|
-
],
|
|
1374
|
-
"name": "wait",
|
|
1375
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1376
|
-
"hasDynamicHelp": true,
|
|
1377
|
-
"helpValue": "<minutes>",
|
|
1378
|
-
"multiple": false,
|
|
1379
1207
|
"type": "option"
|
|
1380
1208
|
},
|
|
1381
|
-
"
|
|
1382
|
-
"
|
|
1383
|
-
"
|
|
1384
|
-
"
|
|
1385
|
-
|
|
1386
|
-
"type": "some",
|
|
1387
|
-
"flags": [
|
|
1388
|
-
"pre-destructive-changes",
|
|
1389
|
-
"manifest",
|
|
1390
|
-
"metadata-dir",
|
|
1391
|
-
"post-destructive-changes"
|
|
1392
|
-
]
|
|
1393
|
-
}
|
|
1394
|
-
],
|
|
1395
|
-
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1209
|
+
"use-most-recent": {
|
|
1210
|
+
"char": "r",
|
|
1211
|
+
"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.",
|
|
1212
|
+
"name": "use-most-recent",
|
|
1213
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1396
1214
|
"allowNo": false,
|
|
1397
1215
|
"type": "boolean"
|
|
1398
1216
|
},
|
|
1399
|
-
"pre-destructive-changes": {
|
|
1400
|
-
"dependsOn": [
|
|
1401
|
-
"manifest"
|
|
1402
|
-
],
|
|
1403
|
-
"helpGroup": "Delete",
|
|
1404
|
-
"name": "pre-destructive-changes",
|
|
1405
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
|
|
1406
|
-
"hasDynamicHelp": false,
|
|
1407
|
-
"multiple": false,
|
|
1408
|
-
"type": "option"
|
|
1409
|
-
},
|
|
1410
|
-
"post-destructive-changes": {
|
|
1411
|
-
"dependsOn": [
|
|
1412
|
-
"manifest"
|
|
1413
|
-
],
|
|
1414
|
-
"helpGroup": "Delete",
|
|
1415
|
-
"name": "post-destructive-changes",
|
|
1416
|
-
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1417
|
-
"hasDynamicHelp": false,
|
|
1418
|
-
"multiple": false,
|
|
1419
|
-
"type": "option"
|
|
1420
|
-
},
|
|
1421
1217
|
"coverage-formatters": {
|
|
1422
1218
|
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1423
1219
|
"helpGroup": "Test",
|
|
@@ -1463,110 +1259,62 @@
|
|
|
1463
1259
|
"hasDynamicHelp": false,
|
|
1464
1260
|
"multiple": false,
|
|
1465
1261
|
"type": "option"
|
|
1262
|
+
},
|
|
1263
|
+
"wait": {
|
|
1264
|
+
"char": "w",
|
|
1265
|
+
"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\".",
|
|
1266
|
+
"name": "wait",
|
|
1267
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1268
|
+
"hasDynamicHelp": true,
|
|
1269
|
+
"helpValue": "<minutes>",
|
|
1270
|
+
"multiple": false,
|
|
1271
|
+
"type": "option"
|
|
1466
1272
|
}
|
|
1467
1273
|
},
|
|
1468
1274
|
"hasDynamicHelp": true,
|
|
1469
1275
|
"hiddenAliases": [],
|
|
1470
|
-
"id": "project:deploy:
|
|
1276
|
+
"id": "project:deploy:report",
|
|
1471
1277
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1472
1278
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1473
1279
|
"pluginType": "core",
|
|
1474
1280
|
"strict": true,
|
|
1475
|
-
"summary": "
|
|
1281
|
+
"summary": "Check or poll for the status of a deploy operation.",
|
|
1476
1282
|
"enableJsonFlag": true,
|
|
1477
|
-
"configurationVariablesSection": {
|
|
1478
|
-
"header": "CONFIGURATION VARIABLES",
|
|
1479
|
-
"body": [
|
|
1480
|
-
{
|
|
1481
|
-
"name": "target-org",
|
|
1482
|
-
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1483
|
-
},
|
|
1484
|
-
{
|
|
1485
|
-
"name": "org-api-version",
|
|
1486
|
-
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1487
|
-
}
|
|
1488
|
-
]
|
|
1489
|
-
},
|
|
1490
|
-
"envVariablesSection": {
|
|
1491
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1492
|
-
"body": [
|
|
1493
|
-
{
|
|
1494
|
-
"name": "SF_TARGET_ORG",
|
|
1495
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1496
|
-
},
|
|
1497
|
-
{
|
|
1498
|
-
"name": "SF_USE_PROGRESS_BAR",
|
|
1499
|
-
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1500
|
-
}
|
|
1501
|
-
]
|
|
1502
|
-
},
|
|
1503
|
-
"errorCodes": {
|
|
1504
|
-
"header": "ERROR CODES",
|
|
1505
|
-
"body": [
|
|
1506
|
-
{
|
|
1507
|
-
"name": "Succeeded (0)",
|
|
1508
|
-
"description": "The deploy succeeded."
|
|
1509
|
-
},
|
|
1510
|
-
{
|
|
1511
|
-
"name": "Canceled (1)",
|
|
1512
|
-
"description": "The deploy was canceled."
|
|
1513
|
-
},
|
|
1514
|
-
{
|
|
1515
|
-
"name": "Failed (1)",
|
|
1516
|
-
"description": "The deploy failed."
|
|
1517
|
-
},
|
|
1518
|
-
{
|
|
1519
|
-
"name": "SucceededPartial (68)",
|
|
1520
|
-
"description": "The deploy partially succeeded."
|
|
1521
|
-
},
|
|
1522
|
-
{
|
|
1523
|
-
"name": "InProgress (69)",
|
|
1524
|
-
"description": "The deploy is in progress."
|
|
1525
|
-
},
|
|
1526
|
-
{
|
|
1527
|
-
"name": "Pending (69)",
|
|
1528
|
-
"description": "The deploy is pending."
|
|
1529
|
-
},
|
|
1530
|
-
{
|
|
1531
|
-
"name": "Canceling (69)",
|
|
1532
|
-
"description": "The deploy is being canceled."
|
|
1533
|
-
}
|
|
1534
|
-
]
|
|
1535
|
-
},
|
|
1536
1283
|
"isESM": true,
|
|
1537
1284
|
"relativePath": [
|
|
1538
1285
|
"lib",
|
|
1539
1286
|
"commands",
|
|
1540
1287
|
"project",
|
|
1541
1288
|
"deploy",
|
|
1542
|
-
"
|
|
1289
|
+
"report.js"
|
|
1543
1290
|
],
|
|
1544
1291
|
"aliasPermutations": [
|
|
1545
|
-
"deploy:metadata",
|
|
1546
|
-
"metadata:deploy"
|
|
1292
|
+
"deploy:metadata:report",
|
|
1293
|
+
"metadata:deploy:report",
|
|
1294
|
+
"metadata:report:deploy",
|
|
1295
|
+
"deploy:report:metadata",
|
|
1296
|
+
"report:deploy:metadata",
|
|
1297
|
+
"report:metadata:deploy"
|
|
1547
1298
|
],
|
|
1548
1299
|
"permutations": [
|
|
1549
|
-
"project:deploy:
|
|
1550
|
-
"deploy:project:
|
|
1551
|
-
"deploy:
|
|
1552
|
-
"project:
|
|
1553
|
-
"
|
|
1554
|
-
"
|
|
1300
|
+
"project:deploy:report",
|
|
1301
|
+
"deploy:project:report",
|
|
1302
|
+
"deploy:report:project",
|
|
1303
|
+
"project:report:deploy",
|
|
1304
|
+
"report:project:deploy",
|
|
1305
|
+
"report:deploy:project"
|
|
1555
1306
|
]
|
|
1556
1307
|
},
|
|
1557
|
-
"project:deploy:
|
|
1308
|
+
"project:deploy:resume": {
|
|
1558
1309
|
"aliases": [
|
|
1559
|
-
"deploy:metadata:
|
|
1310
|
+
"deploy:metadata:resume"
|
|
1560
1311
|
],
|
|
1561
1312
|
"args": {},
|
|
1562
1313
|
"deprecateAliases": true,
|
|
1563
|
-
"description": "Use this command to
|
|
1314
|
+
"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.",
|
|
1564
1315
|
"examples": [
|
|
1565
|
-
"
|
|
1566
|
-
"
|
|
1567
|
-
"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",
|
|
1568
|
-
"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",
|
|
1569
|
-
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
1316
|
+
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1317
|
+
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1570
1318
|
],
|
|
1571
1319
|
"flags": {
|
|
1572
1320
|
"json": {
|
|
@@ -1584,126 +1332,44 @@
|
|
|
1584
1332
|
"multiple": false,
|
|
1585
1333
|
"type": "option"
|
|
1586
1334
|
},
|
|
1587
|
-
"api-version": {
|
|
1588
|
-
"char": "a",
|
|
1589
|
-
"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.",
|
|
1590
|
-
"name": "api-version",
|
|
1591
|
-
"summary": "Target API version for the validation.",
|
|
1592
|
-
"hasDynamicHelp": false,
|
|
1593
|
-
"multiple": false,
|
|
1594
|
-
"type": "option"
|
|
1595
|
-
},
|
|
1596
|
-
"async": {
|
|
1597
|
-
"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\".",
|
|
1598
|
-
"name": "async",
|
|
1599
|
-
"summary": "Run the command asynchronously.",
|
|
1600
|
-
"allowNo": false,
|
|
1601
|
-
"type": "boolean"
|
|
1602
|
-
},
|
|
1603
1335
|
"concise": {
|
|
1604
1336
|
"exclusive": [
|
|
1605
1337
|
"verbose"
|
|
1606
1338
|
],
|
|
1607
1339
|
"name": "concise",
|
|
1608
|
-
"summary": "Show concise output of the
|
|
1340
|
+
"summary": "Show concise output of the deploy operation result.",
|
|
1609
1341
|
"allowNo": false,
|
|
1610
1342
|
"type": "boolean"
|
|
1611
1343
|
},
|
|
1612
|
-
"
|
|
1613
|
-
"char": "
|
|
1614
|
-
"description": "
|
|
1615
|
-
"
|
|
1616
|
-
"
|
|
1617
|
-
"summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
|
|
1618
|
-
"hasDynamicHelp": false,
|
|
1619
|
-
"multiple": false,
|
|
1620
|
-
"type": "option"
|
|
1621
|
-
},
|
|
1622
|
-
"metadata": {
|
|
1623
|
-
"char": "m",
|
|
1624
|
-
"helpGroup": "Source Format",
|
|
1625
|
-
"name": "metadata",
|
|
1626
|
-
"summary": "Metadata component names to validate for deployment.",
|
|
1627
|
-
"hasDynamicHelp": false,
|
|
1628
|
-
"multiple": true,
|
|
1629
|
-
"type": "option"
|
|
1630
|
-
},
|
|
1631
|
-
"source-dir": {
|
|
1632
|
-
"char": "d",
|
|
1633
|
-
"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.",
|
|
1634
|
-
"helpGroup": "Source Format",
|
|
1635
|
-
"name": "source-dir",
|
|
1636
|
-
"summary": "Path to the local source files to validate for deployment.",
|
|
1637
|
-
"hasDynamicHelp": false,
|
|
1638
|
-
"multiple": true,
|
|
1639
|
-
"type": "option"
|
|
1640
|
-
},
|
|
1641
|
-
"metadata-dir": {
|
|
1642
|
-
"helpGroup": "Metadata API Format",
|
|
1643
|
-
"name": "metadata-dir",
|
|
1644
|
-
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1344
|
+
"job-id": {
|
|
1345
|
+
"char": "i",
|
|
1346
|
+
"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.",
|
|
1347
|
+
"name": "job-id",
|
|
1348
|
+
"summary": "Job ID of the deploy operation you want to resume.",
|
|
1645
1349
|
"hasDynamicHelp": false,
|
|
1646
1350
|
"multiple": false,
|
|
1647
1351
|
"type": "option"
|
|
1648
1352
|
},
|
|
1649
|
-
"
|
|
1650
|
-
"
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
"
|
|
1654
|
-
"name": "single-package",
|
|
1655
|
-
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1353
|
+
"use-most-recent": {
|
|
1354
|
+
"char": "r",
|
|
1355
|
+
"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.",
|
|
1356
|
+
"name": "use-most-recent",
|
|
1357
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1656
1358
|
"allowNo": false,
|
|
1657
1359
|
"type": "boolean"
|
|
1658
1360
|
},
|
|
1659
|
-
"target-org": {
|
|
1660
|
-
"char": "o",
|
|
1661
|
-
"name": "target-org",
|
|
1662
|
-
"noCacheDefault": true,
|
|
1663
|
-
"required": true,
|
|
1664
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1665
|
-
"hasDynamicHelp": true,
|
|
1666
|
-
"multiple": false,
|
|
1667
|
-
"type": "option"
|
|
1668
|
-
},
|
|
1669
|
-
"tests": {
|
|
1670
|
-
"char": "t",
|
|
1671
|
-
"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\"",
|
|
1672
|
-
"helpGroup": "Test",
|
|
1673
|
-
"name": "tests",
|
|
1674
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1675
|
-
"hasDynamicHelp": false,
|
|
1676
|
-
"multiple": true,
|
|
1677
|
-
"type": "option"
|
|
1678
|
-
},
|
|
1679
|
-
"test-level": {
|
|
1680
|
-
"char": "l",
|
|
1681
|
-
"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.",
|
|
1682
|
-
"helpGroup": "Test",
|
|
1683
|
-
"name": "test-level",
|
|
1684
|
-
"summary": "Deployment Apex testing level.",
|
|
1685
|
-
"default": "RunLocalTests",
|
|
1686
|
-
"hasDynamicHelp": false,
|
|
1687
|
-
"multiple": false,
|
|
1688
|
-
"options": [
|
|
1689
|
-
"RunAllTestsInOrg",
|
|
1690
|
-
"RunLocalTests",
|
|
1691
|
-
"RunSpecifiedTests"
|
|
1692
|
-
],
|
|
1693
|
-
"type": "option"
|
|
1694
|
-
},
|
|
1695
1361
|
"verbose": {
|
|
1696
1362
|
"exclusive": [
|
|
1697
1363
|
"concise"
|
|
1698
1364
|
],
|
|
1699
1365
|
"name": "verbose",
|
|
1700
|
-
"summary": "Show verbose output of the
|
|
1366
|
+
"summary": "Show verbose output of the deploy operation result.",
|
|
1701
1367
|
"allowNo": false,
|
|
1702
1368
|
"type": "boolean"
|
|
1703
1369
|
},
|
|
1704
1370
|
"wait": {
|
|
1705
1371
|
"char": "w",
|
|
1706
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you
|
|
1372
|
+
"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\".",
|
|
1707
1373
|
"name": "wait",
|
|
1708
1374
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1709
1375
|
"hasDynamicHelp": true,
|
|
@@ -1711,14 +1377,6 @@
|
|
|
1711
1377
|
"multiple": false,
|
|
1712
1378
|
"type": "option"
|
|
1713
1379
|
},
|
|
1714
|
-
"ignore-warnings": {
|
|
1715
|
-
"char": "g",
|
|
1716
|
-
"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.",
|
|
1717
|
-
"name": "ignore-warnings",
|
|
1718
|
-
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1719
|
-
"allowNo": false,
|
|
1720
|
-
"type": "boolean"
|
|
1721
|
-
},
|
|
1722
1380
|
"coverage-formatters": {
|
|
1723
1381
|
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1724
1382
|
"helpGroup": "Test",
|
|
@@ -1764,78 +1422,20 @@
|
|
|
1764
1422
|
"hasDynamicHelp": false,
|
|
1765
1423
|
"multiple": false,
|
|
1766
1424
|
"type": "option"
|
|
1767
|
-
},
|
|
1768
|
-
"purge-on-delete": {
|
|
1769
|
-
"dependsOn": [
|
|
1770
|
-
"manifest"
|
|
1771
|
-
],
|
|
1772
|
-
"helpGroup": "Delete",
|
|
1773
|
-
"name": "purge-on-delete",
|
|
1774
|
-
"relationships": [
|
|
1775
|
-
{
|
|
1776
|
-
"type": "some",
|
|
1777
|
-
"flags": [
|
|
1778
|
-
"pre-destructive-changes",
|
|
1779
|
-
"post-destructive-changes"
|
|
1780
|
-
]
|
|
1781
|
-
}
|
|
1782
|
-
],
|
|
1783
|
-
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1784
|
-
"allowNo": false,
|
|
1785
|
-
"type": "boolean"
|
|
1786
|
-
},
|
|
1787
|
-
"pre-destructive-changes": {
|
|
1788
|
-
"dependsOn": [
|
|
1789
|
-
"manifest"
|
|
1790
|
-
],
|
|
1791
|
-
"helpGroup": "Delete",
|
|
1792
|
-
"name": "pre-destructive-changes",
|
|
1793
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
1794
|
-
"hasDynamicHelp": false,
|
|
1795
|
-
"multiple": false,
|
|
1796
|
-
"type": "option"
|
|
1797
|
-
},
|
|
1798
|
-
"post-destructive-changes": {
|
|
1799
|
-
"dependsOn": [
|
|
1800
|
-
"manifest"
|
|
1801
|
-
],
|
|
1802
|
-
"helpGroup": "Delete",
|
|
1803
|
-
"name": "post-destructive-changes",
|
|
1804
|
-
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1805
|
-
"hasDynamicHelp": false,
|
|
1806
|
-
"multiple": false,
|
|
1807
|
-
"type": "option"
|
|
1808
1425
|
}
|
|
1809
1426
|
},
|
|
1810
1427
|
"hasDynamicHelp": true,
|
|
1811
1428
|
"hiddenAliases": [],
|
|
1812
|
-
"id": "project:deploy:
|
|
1429
|
+
"id": "project:deploy:resume",
|
|
1813
1430
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1814
1431
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1815
1432
|
"pluginType": "core",
|
|
1816
1433
|
"strict": true,
|
|
1817
|
-
"summary": "
|
|
1434
|
+
"summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
|
|
1818
1435
|
"enableJsonFlag": true,
|
|
1819
|
-
"configurationVariablesSection": {
|
|
1820
|
-
"header": "CONFIGURATION VARIABLES",
|
|
1821
|
-
"body": [
|
|
1822
|
-
{
|
|
1823
|
-
"name": "target-org",
|
|
1824
|
-
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1825
|
-
},
|
|
1826
|
-
{
|
|
1827
|
-
"name": "org-api-version",
|
|
1828
|
-
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1829
|
-
}
|
|
1830
|
-
]
|
|
1831
|
-
},
|
|
1832
1436
|
"envVariablesSection": {
|
|
1833
1437
|
"header": "ENVIRONMENT VARIABLES",
|
|
1834
1438
|
"body": [
|
|
1835
|
-
{
|
|
1836
|
-
"name": "SF_TARGET_ORG",
|
|
1837
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1838
|
-
},
|
|
1839
1439
|
{
|
|
1840
1440
|
"name": "SF_USE_PROGRESS_BAR",
|
|
1841
1441
|
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
@@ -1881,37 +1481,47 @@
|
|
|
1881
1481
|
"commands",
|
|
1882
1482
|
"project",
|
|
1883
1483
|
"deploy",
|
|
1884
|
-
"
|
|
1484
|
+
"resume.js"
|
|
1885
1485
|
],
|
|
1886
1486
|
"aliasPermutations": [
|
|
1887
|
-
"deploy:metadata:
|
|
1888
|
-
"metadata:deploy:
|
|
1889
|
-
"metadata:
|
|
1890
|
-
"deploy:
|
|
1891
|
-
"
|
|
1892
|
-
"
|
|
1487
|
+
"deploy:metadata:resume",
|
|
1488
|
+
"metadata:deploy:resume",
|
|
1489
|
+
"metadata:resume:deploy",
|
|
1490
|
+
"deploy:resume:metadata",
|
|
1491
|
+
"resume:deploy:metadata",
|
|
1492
|
+
"resume:metadata:deploy"
|
|
1893
1493
|
],
|
|
1894
1494
|
"permutations": [
|
|
1895
|
-
"project:deploy:
|
|
1896
|
-
"deploy:project:
|
|
1897
|
-
"deploy:
|
|
1898
|
-
"project:
|
|
1899
|
-
"
|
|
1900
|
-
"
|
|
1495
|
+
"project:deploy:resume",
|
|
1496
|
+
"deploy:project:resume",
|
|
1497
|
+
"deploy:resume:project",
|
|
1498
|
+
"project:resume:deploy",
|
|
1499
|
+
"resume:project:deploy",
|
|
1500
|
+
"resume:deploy:project"
|
|
1901
1501
|
]
|
|
1902
1502
|
},
|
|
1903
|
-
"project:
|
|
1503
|
+
"project:deploy:start": {
|
|
1904
1504
|
"aliases": [
|
|
1905
|
-
"
|
|
1505
|
+
"deploy:metadata"
|
|
1906
1506
|
],
|
|
1907
1507
|
"args": {},
|
|
1908
1508
|
"deprecateAliases": true,
|
|
1909
|
-
"description": "
|
|
1509
|
+
"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.",
|
|
1910
1510
|
"examples": [
|
|
1911
|
-
"
|
|
1912
|
-
"
|
|
1913
|
-
"
|
|
1914
|
-
"
|
|
1511
|
+
"Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1512
|
+
"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",
|
|
1513
|
+
"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",
|
|
1514
|
+
"Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
1515
|
+
"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",
|
|
1516
|
+
"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",
|
|
1517
|
+
"Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
|
|
1518
|
+
"Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
|
|
1519
|
+
"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",
|
|
1520
|
+
"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\"",
|
|
1521
|
+
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1522
|
+
"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",
|
|
1523
|
+
"Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
|
|
1524
|
+
"Deploy all metadata formatted files in the \"MDAPI\" directory; items listed in the MDAPI/destructiveChangesPre.xml and MDAPI/destructiveChangesPost.xml manifests are immediately eligible for deletion rather than stored in the Recycle Bin:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI --purge-on-delete"
|
|
1915
1525
|
],
|
|
1916
1526
|
"flags": {
|
|
1917
1527
|
"json": {
|
|
@@ -1930,63 +1540,142 @@
|
|
|
1930
1540
|
"type": "option"
|
|
1931
1541
|
},
|
|
1932
1542
|
"api-version": {
|
|
1933
|
-
"
|
|
1934
|
-
|
|
1935
|
-
],
|
|
1936
|
-
"deprecateAliases": true,
|
|
1937
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1543
|
+
"char": "a",
|
|
1544
|
+
"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.",
|
|
1938
1545
|
"name": "api-version",
|
|
1546
|
+
"summary": "Target API version for the deploy.",
|
|
1939
1547
|
"hasDynamicHelp": false,
|
|
1940
1548
|
"multiple": false,
|
|
1941
1549
|
"type": "option"
|
|
1942
1550
|
},
|
|
1943
|
-
"
|
|
1944
|
-
"
|
|
1945
|
-
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
"name": "
|
|
1551
|
+
"async": {
|
|
1552
|
+
"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\".",
|
|
1553
|
+
"exclusive": [
|
|
1554
|
+
"wait"
|
|
1555
|
+
],
|
|
1556
|
+
"name": "async",
|
|
1557
|
+
"summary": "Run the command asynchronously.",
|
|
1558
|
+
"allowNo": false,
|
|
1559
|
+
"type": "boolean"
|
|
1560
|
+
},
|
|
1561
|
+
"concise": {
|
|
1562
|
+
"exclusive": [
|
|
1563
|
+
"verbose"
|
|
1564
|
+
],
|
|
1565
|
+
"name": "concise",
|
|
1566
|
+
"summary": "Show concise output of the deploy result.",
|
|
1567
|
+
"allowNo": false,
|
|
1568
|
+
"type": "boolean"
|
|
1569
|
+
},
|
|
1570
|
+
"dry-run": {
|
|
1571
|
+
"name": "dry-run",
|
|
1572
|
+
"summary": "Validate deploy and run Apex tests but don’t save to the org.",
|
|
1573
|
+
"allowNo": false,
|
|
1574
|
+
"type": "boolean"
|
|
1575
|
+
},
|
|
1576
|
+
"ignore-conflicts": {
|
|
1577
|
+
"char": "c",
|
|
1578
|
+
"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.",
|
|
1579
|
+
"name": "ignore-conflicts",
|
|
1580
|
+
"summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
|
|
1581
|
+
"allowNo": false,
|
|
1582
|
+
"type": "boolean"
|
|
1583
|
+
},
|
|
1584
|
+
"ignore-errors": {
|
|
1585
|
+
"char": "r",
|
|
1586
|
+
"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.",
|
|
1587
|
+
"name": "ignore-errors",
|
|
1588
|
+
"summary": "Ignore any errors and don’t roll back deployment.",
|
|
1589
|
+
"allowNo": false,
|
|
1590
|
+
"type": "boolean"
|
|
1591
|
+
},
|
|
1592
|
+
"ignore-warnings": {
|
|
1593
|
+
"char": "g",
|
|
1594
|
+
"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.",
|
|
1595
|
+
"name": "ignore-warnings",
|
|
1596
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1597
|
+
"allowNo": false,
|
|
1598
|
+
"type": "boolean"
|
|
1599
|
+
},
|
|
1600
|
+
"manifest": {
|
|
1601
|
+
"char": "x",
|
|
1602
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1603
|
+
"exclusive": [
|
|
1604
|
+
"source-dir",
|
|
1605
|
+
"metadata",
|
|
1606
|
+
"metadata-dir"
|
|
1607
|
+
],
|
|
1608
|
+
"helpGroup": "Source Format",
|
|
1609
|
+
"name": "manifest",
|
|
1610
|
+
"summary": "Full file path for manifest (package.xml) of components to deploy.",
|
|
1949
1611
|
"hasDynamicHelp": false,
|
|
1950
1612
|
"multiple": false,
|
|
1951
1613
|
"type": "option"
|
|
1952
1614
|
},
|
|
1953
|
-
"
|
|
1954
|
-
"
|
|
1955
|
-
|
|
1956
|
-
"
|
|
1615
|
+
"metadata": {
|
|
1616
|
+
"char": "m",
|
|
1617
|
+
"exclusive": [
|
|
1618
|
+
"manifest",
|
|
1619
|
+
"source-dir",
|
|
1620
|
+
"metadata-dir"
|
|
1957
1621
|
],
|
|
1958
|
-
"
|
|
1959
|
-
"
|
|
1960
|
-
"
|
|
1961
|
-
"
|
|
1962
|
-
"
|
|
1963
|
-
"
|
|
1964
|
-
|
|
1622
|
+
"helpGroup": "Source Format",
|
|
1623
|
+
"name": "metadata",
|
|
1624
|
+
"summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
|
|
1625
|
+
"hasDynamicHelp": false,
|
|
1626
|
+
"multiple": true,
|
|
1627
|
+
"type": "option"
|
|
1628
|
+
},
|
|
1629
|
+
"metadata-dir": {
|
|
1630
|
+
"exclusive": [
|
|
1631
|
+
"manifest",
|
|
1632
|
+
"source-dir",
|
|
1633
|
+
"metadata"
|
|
1634
|
+
],
|
|
1635
|
+
"helpGroup": "Metadata API Format",
|
|
1636
|
+
"name": "metadata-dir",
|
|
1637
|
+
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1638
|
+
"hasDynamicHelp": false,
|
|
1965
1639
|
"multiple": false,
|
|
1966
1640
|
"type": "option"
|
|
1967
1641
|
},
|
|
1968
|
-
"
|
|
1969
|
-
"
|
|
1970
|
-
"
|
|
1642
|
+
"single-package": {
|
|
1643
|
+
"dependsOn": [
|
|
1644
|
+
"metadata-dir"
|
|
1971
1645
|
],
|
|
1972
|
-
"
|
|
1973
|
-
"
|
|
1974
|
-
"
|
|
1975
|
-
"name": "check-only",
|
|
1976
|
-
"summary": "Validate delete command but don't delete anything from the org or the local project.",
|
|
1646
|
+
"helpGroup": "Metadata API Format",
|
|
1647
|
+
"name": "single-package",
|
|
1648
|
+
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1977
1649
|
"allowNo": false,
|
|
1978
1650
|
"type": "boolean"
|
|
1979
1651
|
},
|
|
1980
|
-
"
|
|
1981
|
-
"char": "
|
|
1982
|
-
"description": "
|
|
1983
|
-
"
|
|
1984
|
-
|
|
1652
|
+
"source-dir": {
|
|
1653
|
+
"char": "d",
|
|
1654
|
+
"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.",
|
|
1655
|
+
"exclusive": [
|
|
1656
|
+
"manifest",
|
|
1657
|
+
"metadata",
|
|
1658
|
+
"metadata-dir"
|
|
1659
|
+
],
|
|
1660
|
+
"helpGroup": "Source Format",
|
|
1661
|
+
"name": "source-dir",
|
|
1662
|
+
"summary": "Path to the local source files to deploy.",
|
|
1663
|
+
"hasDynamicHelp": false,
|
|
1664
|
+
"multiple": true,
|
|
1665
|
+
"type": "option"
|
|
1666
|
+
},
|
|
1667
|
+
"target-org": {
|
|
1668
|
+
"char": "o",
|
|
1669
|
+
"name": "target-org",
|
|
1670
|
+
"noCacheDefault": true,
|
|
1671
|
+
"required": true,
|
|
1672
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1985
1673
|
"hasDynamicHelp": true,
|
|
1986
1674
|
"multiple": false,
|
|
1987
1675
|
"type": "option"
|
|
1988
1676
|
},
|
|
1989
1677
|
"tests": {
|
|
1678
|
+
"char": "t",
|
|
1990
1679
|
"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\"",
|
|
1991
1680
|
"helpGroup": "Test",
|
|
1992
1681
|
"name": "tests",
|
|
@@ -1996,12 +1685,8 @@
|
|
|
1996
1685
|
"type": "option"
|
|
1997
1686
|
},
|
|
1998
1687
|
"test-level": {
|
|
1999
|
-
"aliases": [
|
|
2000
|
-
"testlevel"
|
|
2001
|
-
],
|
|
2002
1688
|
"char": "l",
|
|
2003
|
-
"
|
|
2004
|
-
"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.",
|
|
1689
|
+
"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\".",
|
|
2005
1690
|
"helpGroup": "Test",
|
|
2006
1691
|
"name": "test-level",
|
|
2007
1692
|
"summary": "Deployment Apex testing level.",
|
|
@@ -2015,120 +1700,217 @@
|
|
|
2015
1700
|
],
|
|
2016
1701
|
"type": "option"
|
|
2017
1702
|
},
|
|
2018
|
-
"
|
|
2019
|
-
"
|
|
2020
|
-
"
|
|
1703
|
+
"verbose": {
|
|
1704
|
+
"exclusive": [
|
|
1705
|
+
"concise"
|
|
2021
1706
|
],
|
|
2022
|
-
"
|
|
2023
|
-
"
|
|
2024
|
-
"name": "no-prompt",
|
|
2025
|
-
"summary": "Don't prompt for delete confirmation.",
|
|
1707
|
+
"name": "verbose",
|
|
1708
|
+
"summary": "Show verbose output of the deploy result.",
|
|
2026
1709
|
"allowNo": false,
|
|
2027
1710
|
"type": "boolean"
|
|
2028
1711
|
},
|
|
2029
|
-
"
|
|
2030
|
-
"char": "
|
|
2031
|
-
"description": "If you
|
|
2032
|
-
"
|
|
2033
|
-
|
|
2034
|
-
"delimiter": ",",
|
|
2035
|
-
"hasDynamicHelp": false,
|
|
2036
|
-
"multiple": true,
|
|
2037
|
-
"type": "option"
|
|
2038
|
-
},
|
|
2039
|
-
"source-dir": {
|
|
2040
|
-
"aliases": [
|
|
2041
|
-
"sourcepath"
|
|
1712
|
+
"wait": {
|
|
1713
|
+
"char": "w",
|
|
1714
|
+
"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\".",
|
|
1715
|
+
"exclusive": [
|
|
1716
|
+
"async"
|
|
2042
1717
|
],
|
|
2043
|
-
"
|
|
2044
|
-
"
|
|
2045
|
-
"
|
|
2046
|
-
"
|
|
2047
|
-
"
|
|
2048
|
-
"delimiter": ",",
|
|
2049
|
-
"hasDynamicHelp": false,
|
|
2050
|
-
"multiple": true,
|
|
1718
|
+
"name": "wait",
|
|
1719
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1720
|
+
"hasDynamicHelp": true,
|
|
1721
|
+
"helpValue": "<minutes>",
|
|
1722
|
+
"multiple": false,
|
|
2051
1723
|
"type": "option"
|
|
2052
1724
|
},
|
|
2053
|
-
"
|
|
2054
|
-
"
|
|
2055
|
-
|
|
2056
|
-
|
|
2057
|
-
|
|
2058
|
-
|
|
2059
|
-
|
|
2060
|
-
|
|
2061
|
-
|
|
2062
|
-
|
|
2063
|
-
|
|
1725
|
+
"purge-on-delete": {
|
|
1726
|
+
"helpGroup": "Delete",
|
|
1727
|
+
"name": "purge-on-delete",
|
|
1728
|
+
"relationships": [
|
|
1729
|
+
{
|
|
1730
|
+
"type": "some",
|
|
1731
|
+
"flags": [
|
|
1732
|
+
"pre-destructive-changes",
|
|
1733
|
+
"manifest",
|
|
1734
|
+
"metadata-dir",
|
|
1735
|
+
"post-destructive-changes"
|
|
1736
|
+
]
|
|
1737
|
+
}
|
|
1738
|
+
],
|
|
1739
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
2064
1740
|
"allowNo": false,
|
|
2065
1741
|
"type": "boolean"
|
|
2066
1742
|
},
|
|
2067
|
-
"
|
|
2068
|
-
"
|
|
2069
|
-
"
|
|
1743
|
+
"pre-destructive-changes": {
|
|
1744
|
+
"dependsOn": [
|
|
1745
|
+
"manifest"
|
|
2070
1746
|
],
|
|
2071
|
-
"
|
|
1747
|
+
"helpGroup": "Delete",
|
|
1748
|
+
"name": "pre-destructive-changes",
|
|
1749
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
|
|
1750
|
+
"hasDynamicHelp": false,
|
|
1751
|
+
"multiple": false,
|
|
1752
|
+
"type": "option"
|
|
1753
|
+
},
|
|
1754
|
+
"post-destructive-changes": {
|
|
2072
1755
|
"dependsOn": [
|
|
2073
|
-
"
|
|
1756
|
+
"manifest"
|
|
2074
1757
|
],
|
|
2075
|
-
"
|
|
2076
|
-
"name": "
|
|
2077
|
-
"summary": "
|
|
2078
|
-
"
|
|
2079
|
-
"
|
|
1758
|
+
"helpGroup": "Delete",
|
|
1759
|
+
"name": "post-destructive-changes",
|
|
1760
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1761
|
+
"hasDynamicHelp": false,
|
|
1762
|
+
"multiple": false,
|
|
1763
|
+
"type": "option"
|
|
2080
1764
|
},
|
|
2081
|
-
"
|
|
2082
|
-
"
|
|
2083
|
-
"
|
|
1765
|
+
"coverage-formatters": {
|
|
1766
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1767
|
+
"helpGroup": "Test",
|
|
1768
|
+
"name": "coverage-formatters",
|
|
1769
|
+
"summary": "Format of the code coverage results.",
|
|
1770
|
+
"hasDynamicHelp": false,
|
|
1771
|
+
"multiple": true,
|
|
1772
|
+
"options": [
|
|
1773
|
+
"clover",
|
|
1774
|
+
"cobertura",
|
|
1775
|
+
"html-spa",
|
|
1776
|
+
"html",
|
|
1777
|
+
"json",
|
|
1778
|
+
"json-summary",
|
|
1779
|
+
"lcovonly",
|
|
1780
|
+
"none",
|
|
1781
|
+
"teamcity",
|
|
1782
|
+
"text",
|
|
1783
|
+
"text-summary"
|
|
1784
|
+
],
|
|
1785
|
+
"type": "option"
|
|
1786
|
+
},
|
|
1787
|
+
"junit": {
|
|
1788
|
+
"helpGroup": "Test",
|
|
1789
|
+
"name": "junit",
|
|
1790
|
+
"summary": "Output JUnit test results.",
|
|
2084
1791
|
"allowNo": false,
|
|
2085
1792
|
"type": "boolean"
|
|
1793
|
+
},
|
|
1794
|
+
"results-dir": {
|
|
1795
|
+
"helpGroup": "Test",
|
|
1796
|
+
"name": "results-dir",
|
|
1797
|
+
"relationships": [
|
|
1798
|
+
{
|
|
1799
|
+
"type": "some",
|
|
1800
|
+
"flags": [
|
|
1801
|
+
"coverage-formatters",
|
|
1802
|
+
"junit"
|
|
1803
|
+
]
|
|
1804
|
+
}
|
|
1805
|
+
],
|
|
1806
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
1807
|
+
"hasDynamicHelp": false,
|
|
1808
|
+
"multiple": false,
|
|
1809
|
+
"type": "option"
|
|
2086
1810
|
}
|
|
2087
1811
|
},
|
|
2088
1812
|
"hasDynamicHelp": true,
|
|
2089
1813
|
"hiddenAliases": [],
|
|
2090
|
-
"id": "project:
|
|
1814
|
+
"id": "project:deploy:start",
|
|
2091
1815
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2092
1816
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2093
1817
|
"pluginType": "core",
|
|
2094
1818
|
"strict": true,
|
|
2095
|
-
"summary": "
|
|
1819
|
+
"summary": "Deploy metadata to an org from your local project.",
|
|
2096
1820
|
"enableJsonFlag": true,
|
|
2097
|
-
"
|
|
1821
|
+
"configurationVariablesSection": {
|
|
1822
|
+
"header": "CONFIGURATION VARIABLES",
|
|
1823
|
+
"body": [
|
|
1824
|
+
{
|
|
1825
|
+
"name": "target-org",
|
|
1826
|
+
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1827
|
+
},
|
|
1828
|
+
{
|
|
1829
|
+
"name": "org-api-version",
|
|
1830
|
+
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1831
|
+
}
|
|
1832
|
+
]
|
|
1833
|
+
},
|
|
1834
|
+
"envVariablesSection": {
|
|
1835
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1836
|
+
"body": [
|
|
1837
|
+
{
|
|
1838
|
+
"name": "SF_TARGET_ORG",
|
|
1839
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1840
|
+
},
|
|
1841
|
+
{
|
|
1842
|
+
"name": "SF_USE_PROGRESS_BAR",
|
|
1843
|
+
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1844
|
+
}
|
|
1845
|
+
]
|
|
1846
|
+
},
|
|
1847
|
+
"errorCodes": {
|
|
1848
|
+
"header": "ERROR CODES",
|
|
1849
|
+
"body": [
|
|
1850
|
+
{
|
|
1851
|
+
"name": "Succeeded (0)",
|
|
1852
|
+
"description": "The deploy succeeded."
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"name": "Canceled (1)",
|
|
1856
|
+
"description": "The deploy was canceled."
|
|
1857
|
+
},
|
|
1858
|
+
{
|
|
1859
|
+
"name": "Failed (1)",
|
|
1860
|
+
"description": "The deploy failed."
|
|
1861
|
+
},
|
|
1862
|
+
{
|
|
1863
|
+
"name": "SucceededPartial (68)",
|
|
1864
|
+
"description": "The deploy partially succeeded."
|
|
1865
|
+
},
|
|
1866
|
+
{
|
|
1867
|
+
"name": "InProgress (69)",
|
|
1868
|
+
"description": "The deploy is in progress."
|
|
1869
|
+
},
|
|
1870
|
+
{
|
|
1871
|
+
"name": "Pending (69)",
|
|
1872
|
+
"description": "The deploy is pending."
|
|
1873
|
+
},
|
|
1874
|
+
{
|
|
1875
|
+
"name": "Canceling (69)",
|
|
1876
|
+
"description": "The deploy is being canceled."
|
|
1877
|
+
}
|
|
1878
|
+
]
|
|
1879
|
+
},
|
|
2098
1880
|
"isESM": true,
|
|
2099
1881
|
"relativePath": [
|
|
2100
1882
|
"lib",
|
|
2101
1883
|
"commands",
|
|
2102
1884
|
"project",
|
|
2103
|
-
"
|
|
2104
|
-
"
|
|
1885
|
+
"deploy",
|
|
1886
|
+
"start.js"
|
|
2105
1887
|
],
|
|
2106
1888
|
"aliasPermutations": [
|
|
2107
|
-
"
|
|
2108
|
-
"
|
|
2109
|
-
"source:delete:force",
|
|
2110
|
-
"force:delete:source",
|
|
2111
|
-
"delete:force:source",
|
|
2112
|
-
"delete:source:force"
|
|
1889
|
+
"deploy:metadata",
|
|
1890
|
+
"metadata:deploy"
|
|
2113
1891
|
],
|
|
2114
1892
|
"permutations": [
|
|
2115
|
-
"project:
|
|
2116
|
-
"
|
|
2117
|
-
"
|
|
2118
|
-
"project:
|
|
2119
|
-
"
|
|
2120
|
-
"
|
|
1893
|
+
"project:deploy:start",
|
|
1894
|
+
"deploy:project:start",
|
|
1895
|
+
"deploy:start:project",
|
|
1896
|
+
"project:start:deploy",
|
|
1897
|
+
"start:project:deploy",
|
|
1898
|
+
"start:deploy:project"
|
|
2121
1899
|
]
|
|
2122
1900
|
},
|
|
2123
|
-
"project:
|
|
1901
|
+
"project:deploy:validate": {
|
|
2124
1902
|
"aliases": [
|
|
2125
|
-
"
|
|
1903
|
+
"deploy:metadata:validate"
|
|
2126
1904
|
],
|
|
2127
1905
|
"args": {},
|
|
2128
1906
|
"deprecateAliases": true,
|
|
2129
|
-
"description": "
|
|
1907
|
+
"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 \"<%= config.bin %> project deploy start --dry-run --test-level RunLocalTests\" instead.",
|
|
2130
1908
|
"examples": [
|
|
2131
|
-
"
|
|
1909
|
+
"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.",
|
|
1910
|
+
"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",
|
|
1911
|
+
"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",
|
|
1912
|
+
"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",
|
|
1913
|
+
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
2132
1914
|
],
|
|
2133
1915
|
"flags": {
|
|
2134
1916
|
"json": {
|
|
@@ -2147,104 +1929,319 @@
|
|
|
2147
1929
|
"type": "option"
|
|
2148
1930
|
},
|
|
2149
1931
|
"api-version": {
|
|
2150
|
-
"
|
|
2151
|
-
|
|
2152
|
-
],
|
|
2153
|
-
"deprecateAliases": true,
|
|
2154
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1932
|
+
"char": "a",
|
|
1933
|
+
"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.",
|
|
2155
1934
|
"name": "api-version",
|
|
1935
|
+
"summary": "Target API version for the validation.",
|
|
2156
1936
|
"hasDynamicHelp": false,
|
|
2157
1937
|
"multiple": false,
|
|
2158
1938
|
"type": "option"
|
|
2159
1939
|
},
|
|
2160
|
-
"
|
|
2161
|
-
"
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
"
|
|
2165
|
-
"
|
|
1940
|
+
"async": {
|
|
1941
|
+
"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\".",
|
|
1942
|
+
"name": "async",
|
|
1943
|
+
"summary": "Run the command asynchronously.",
|
|
1944
|
+
"allowNo": false,
|
|
1945
|
+
"type": "boolean"
|
|
1946
|
+
},
|
|
1947
|
+
"concise": {
|
|
1948
|
+
"exclusive": [
|
|
1949
|
+
"verbose"
|
|
1950
|
+
],
|
|
1951
|
+
"name": "concise",
|
|
1952
|
+
"summary": "Show concise output of the validation result.",
|
|
1953
|
+
"allowNo": false,
|
|
1954
|
+
"type": "boolean"
|
|
1955
|
+
},
|
|
1956
|
+
"manifest": {
|
|
1957
|
+
"char": "x",
|
|
1958
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1959
|
+
"helpGroup": "Source Format",
|
|
1960
|
+
"name": "manifest",
|
|
1961
|
+
"summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
|
|
2166
1962
|
"hasDynamicHelp": false,
|
|
2167
1963
|
"multiple": false,
|
|
2168
1964
|
"type": "option"
|
|
2169
1965
|
},
|
|
2170
|
-
"
|
|
2171
|
-
"
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
|
-
"
|
|
2176
|
-
"
|
|
2177
|
-
"name": "target-org",
|
|
2178
|
-
"noCacheDefault": true,
|
|
2179
|
-
"required": true,
|
|
2180
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2181
|
-
"hasDynamicHelp": true,
|
|
2182
|
-
"multiple": false,
|
|
1966
|
+
"metadata": {
|
|
1967
|
+
"char": "m",
|
|
1968
|
+
"helpGroup": "Source Format",
|
|
1969
|
+
"name": "metadata",
|
|
1970
|
+
"summary": "Metadata component names to validate for deployment.",
|
|
1971
|
+
"hasDynamicHelp": false,
|
|
1972
|
+
"multiple": true,
|
|
2183
1973
|
"type": "option"
|
|
2184
1974
|
},
|
|
2185
|
-
"
|
|
2186
|
-
"
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
"
|
|
2190
|
-
"
|
|
2191
|
-
"
|
|
2192
|
-
"
|
|
2193
|
-
"
|
|
1975
|
+
"source-dir": {
|
|
1976
|
+
"char": "d",
|
|
1977
|
+
"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.",
|
|
1978
|
+
"helpGroup": "Source Format",
|
|
1979
|
+
"name": "source-dir",
|
|
1980
|
+
"summary": "Path to the local source files to validate for deployment.",
|
|
1981
|
+
"hasDynamicHelp": false,
|
|
1982
|
+
"multiple": true,
|
|
1983
|
+
"type": "option"
|
|
1984
|
+
},
|
|
1985
|
+
"metadata-dir": {
|
|
1986
|
+
"helpGroup": "Metadata API Format",
|
|
1987
|
+
"name": "metadata-dir",
|
|
1988
|
+
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1989
|
+
"hasDynamicHelp": false,
|
|
1990
|
+
"multiple": false,
|
|
1991
|
+
"type": "option"
|
|
1992
|
+
},
|
|
1993
|
+
"single-package": {
|
|
1994
|
+
"dependsOn": [
|
|
1995
|
+
"metadata-dir"
|
|
1996
|
+
],
|
|
1997
|
+
"helpGroup": "Metadata API Format",
|
|
1998
|
+
"name": "single-package",
|
|
1999
|
+
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
2000
|
+
"allowNo": false,
|
|
2001
|
+
"type": "boolean"
|
|
2002
|
+
},
|
|
2003
|
+
"target-org": {
|
|
2004
|
+
"char": "o",
|
|
2005
|
+
"name": "target-org",
|
|
2006
|
+
"noCacheDefault": true,
|
|
2007
|
+
"required": true,
|
|
2008
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2009
|
+
"hasDynamicHelp": true,
|
|
2010
|
+
"multiple": false,
|
|
2011
|
+
"type": "option"
|
|
2012
|
+
},
|
|
2013
|
+
"tests": {
|
|
2014
|
+
"char": "t",
|
|
2015
|
+
"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\"",
|
|
2016
|
+
"helpGroup": "Test",
|
|
2017
|
+
"name": "tests",
|
|
2018
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2019
|
+
"hasDynamicHelp": false,
|
|
2020
|
+
"multiple": true,
|
|
2021
|
+
"type": "option"
|
|
2022
|
+
},
|
|
2023
|
+
"test-level": {
|
|
2024
|
+
"char": "l",
|
|
2025
|
+
"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.",
|
|
2026
|
+
"helpGroup": "Test",
|
|
2027
|
+
"name": "test-level",
|
|
2028
|
+
"summary": "Deployment Apex testing level.",
|
|
2029
|
+
"default": "RunLocalTests",
|
|
2030
|
+
"hasDynamicHelp": false,
|
|
2031
|
+
"multiple": false,
|
|
2032
|
+
"options": [
|
|
2033
|
+
"RunAllTestsInOrg",
|
|
2034
|
+
"RunLocalTests",
|
|
2035
|
+
"RunSpecifiedTests"
|
|
2036
|
+
],
|
|
2037
|
+
"type": "option"
|
|
2038
|
+
},
|
|
2039
|
+
"verbose": {
|
|
2040
|
+
"exclusive": [
|
|
2041
|
+
"concise"
|
|
2042
|
+
],
|
|
2043
|
+
"name": "verbose",
|
|
2044
|
+
"summary": "Show verbose output of the validation result.",
|
|
2045
|
+
"allowNo": false,
|
|
2046
|
+
"type": "boolean"
|
|
2047
|
+
},
|
|
2048
|
+
"wait": {
|
|
2049
|
+
"char": "w",
|
|
2050
|
+
"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\".",
|
|
2051
|
+
"name": "wait",
|
|
2052
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
2053
|
+
"hasDynamicHelp": true,
|
|
2054
|
+
"helpValue": "<minutes>",
|
|
2055
|
+
"multiple": false,
|
|
2056
|
+
"type": "option"
|
|
2057
|
+
},
|
|
2058
|
+
"ignore-warnings": {
|
|
2059
|
+
"char": "g",
|
|
2060
|
+
"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.",
|
|
2061
|
+
"name": "ignore-warnings",
|
|
2062
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
2063
|
+
"allowNo": false,
|
|
2064
|
+
"type": "boolean"
|
|
2065
|
+
},
|
|
2066
|
+
"coverage-formatters": {
|
|
2067
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
2068
|
+
"helpGroup": "Test",
|
|
2069
|
+
"name": "coverage-formatters",
|
|
2070
|
+
"summary": "Format of the code coverage results.",
|
|
2071
|
+
"hasDynamicHelp": false,
|
|
2072
|
+
"multiple": true,
|
|
2073
|
+
"options": [
|
|
2074
|
+
"clover",
|
|
2075
|
+
"cobertura",
|
|
2076
|
+
"html-spa",
|
|
2077
|
+
"html",
|
|
2078
|
+
"json",
|
|
2079
|
+
"json-summary",
|
|
2080
|
+
"lcovonly",
|
|
2081
|
+
"none",
|
|
2082
|
+
"teamcity",
|
|
2083
|
+
"text",
|
|
2084
|
+
"text-summary"
|
|
2085
|
+
],
|
|
2086
|
+
"type": "option"
|
|
2087
|
+
},
|
|
2088
|
+
"junit": {
|
|
2089
|
+
"helpGroup": "Test",
|
|
2090
|
+
"name": "junit",
|
|
2091
|
+
"summary": "Output JUnit test results.",
|
|
2092
|
+
"allowNo": false,
|
|
2093
|
+
"type": "boolean"
|
|
2094
|
+
},
|
|
2095
|
+
"results-dir": {
|
|
2096
|
+
"helpGroup": "Test",
|
|
2097
|
+
"name": "results-dir",
|
|
2098
|
+
"relationships": [
|
|
2099
|
+
{
|
|
2100
|
+
"type": "some",
|
|
2101
|
+
"flags": [
|
|
2102
|
+
"coverage-formatters",
|
|
2103
|
+
"junit"
|
|
2104
|
+
]
|
|
2105
|
+
}
|
|
2106
|
+
],
|
|
2107
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
2108
|
+
"hasDynamicHelp": false,
|
|
2109
|
+
"multiple": false,
|
|
2110
|
+
"type": "option"
|
|
2111
|
+
},
|
|
2112
|
+
"purge-on-delete": {
|
|
2113
|
+
"dependsOn": [
|
|
2114
|
+
"manifest"
|
|
2115
|
+
],
|
|
2116
|
+
"helpGroup": "Delete",
|
|
2117
|
+
"name": "purge-on-delete",
|
|
2118
|
+
"relationships": [
|
|
2119
|
+
{
|
|
2120
|
+
"type": "some",
|
|
2121
|
+
"flags": [
|
|
2122
|
+
"pre-destructive-changes",
|
|
2123
|
+
"post-destructive-changes"
|
|
2124
|
+
]
|
|
2125
|
+
}
|
|
2126
|
+
],
|
|
2127
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
2128
|
+
"allowNo": false,
|
|
2194
2129
|
"type": "boolean"
|
|
2130
|
+
},
|
|
2131
|
+
"pre-destructive-changes": {
|
|
2132
|
+
"dependsOn": [
|
|
2133
|
+
"manifest"
|
|
2134
|
+
],
|
|
2135
|
+
"helpGroup": "Delete",
|
|
2136
|
+
"name": "pre-destructive-changes",
|
|
2137
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
2138
|
+
"hasDynamicHelp": false,
|
|
2139
|
+
"multiple": false,
|
|
2140
|
+
"type": "option"
|
|
2141
|
+
},
|
|
2142
|
+
"post-destructive-changes": {
|
|
2143
|
+
"dependsOn": [
|
|
2144
|
+
"manifest"
|
|
2145
|
+
],
|
|
2146
|
+
"helpGroup": "Delete",
|
|
2147
|
+
"name": "post-destructive-changes",
|
|
2148
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
2149
|
+
"hasDynamicHelp": false,
|
|
2150
|
+
"multiple": false,
|
|
2151
|
+
"type": "option"
|
|
2195
2152
|
}
|
|
2196
2153
|
},
|
|
2197
2154
|
"hasDynamicHelp": true,
|
|
2198
2155
|
"hiddenAliases": [],
|
|
2199
|
-
"id": "project:
|
|
2156
|
+
"id": "project:deploy:validate",
|
|
2200
2157
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2201
2158
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2202
2159
|
"pluginType": "core",
|
|
2203
2160
|
"strict": true,
|
|
2204
|
-
"summary": "
|
|
2161
|
+
"summary": "Validate a metadata deployment without actually executing it.",
|
|
2205
2162
|
"enableJsonFlag": true,
|
|
2206
|
-
"
|
|
2163
|
+
"configurationVariablesSection": {
|
|
2164
|
+
"header": "CONFIGURATION VARIABLES",
|
|
2165
|
+
"body": [
|
|
2166
|
+
{
|
|
2167
|
+
"name": "target-org",
|
|
2168
|
+
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
2169
|
+
},
|
|
2170
|
+
{
|
|
2171
|
+
"name": "org-api-version",
|
|
2172
|
+
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
2173
|
+
}
|
|
2174
|
+
]
|
|
2175
|
+
},
|
|
2176
|
+
"envVariablesSection": {
|
|
2177
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2178
|
+
"body": [
|
|
2179
|
+
{
|
|
2180
|
+
"name": "SF_TARGET_ORG",
|
|
2181
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2182
|
+
},
|
|
2183
|
+
{
|
|
2184
|
+
"name": "SF_USE_PROGRESS_BAR",
|
|
2185
|
+
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
2186
|
+
}
|
|
2187
|
+
]
|
|
2188
|
+
},
|
|
2189
|
+
"errorCodes": {
|
|
2190
|
+
"header": "ERROR CODES",
|
|
2191
|
+
"body": [
|
|
2192
|
+
{
|
|
2193
|
+
"name": "Succeeded (0)",
|
|
2194
|
+
"description": "The deploy succeeded."
|
|
2195
|
+
},
|
|
2196
|
+
{
|
|
2197
|
+
"name": "Canceled (1)",
|
|
2198
|
+
"description": "The deploy was canceled."
|
|
2199
|
+
},
|
|
2200
|
+
{
|
|
2201
|
+
"name": "Failed (1)",
|
|
2202
|
+
"description": "The deploy failed."
|
|
2203
|
+
},
|
|
2204
|
+
{
|
|
2205
|
+
"name": "SucceededPartial (68)",
|
|
2206
|
+
"description": "The deploy partially succeeded."
|
|
2207
|
+
},
|
|
2208
|
+
{
|
|
2209
|
+
"name": "InProgress (69)",
|
|
2210
|
+
"description": "The deploy is in progress."
|
|
2211
|
+
},
|
|
2212
|
+
{
|
|
2213
|
+
"name": "Pending (69)",
|
|
2214
|
+
"description": "The deploy is pending."
|
|
2215
|
+
},
|
|
2216
|
+
{
|
|
2217
|
+
"name": "Canceling (69)",
|
|
2218
|
+
"description": "The deploy is being canceled."
|
|
2219
|
+
}
|
|
2220
|
+
]
|
|
2221
|
+
},
|
|
2207
2222
|
"isESM": true,
|
|
2208
2223
|
"relativePath": [
|
|
2209
2224
|
"lib",
|
|
2210
2225
|
"commands",
|
|
2211
2226
|
"project",
|
|
2212
|
-
"
|
|
2213
|
-
"
|
|
2227
|
+
"deploy",
|
|
2228
|
+
"validate.js"
|
|
2214
2229
|
],
|
|
2215
2230
|
"aliasPermutations": [
|
|
2216
|
-
"
|
|
2217
|
-
"
|
|
2218
|
-
"
|
|
2219
|
-
"
|
|
2220
|
-
"
|
|
2221
|
-
"
|
|
2222
|
-
"tracking:source:force:clear",
|
|
2223
|
-
"tracking:source:clear:force",
|
|
2224
|
-
"force:tracking:clear:source",
|
|
2225
|
-
"tracking:force:clear:source",
|
|
2226
|
-
"tracking:clear:force:source",
|
|
2227
|
-
"tracking:clear:source:force",
|
|
2228
|
-
"force:source:clear:tracking",
|
|
2229
|
-
"source:force:clear:tracking",
|
|
2230
|
-
"source:clear:force:tracking",
|
|
2231
|
-
"source:clear:tracking:force",
|
|
2232
|
-
"force:clear:source:tracking",
|
|
2233
|
-
"clear:force:source:tracking",
|
|
2234
|
-
"clear:source:force:tracking",
|
|
2235
|
-
"clear:source:tracking:force",
|
|
2236
|
-
"force:clear:tracking:source",
|
|
2237
|
-
"clear:force:tracking:source",
|
|
2238
|
-
"clear:tracking:force:source",
|
|
2239
|
-
"clear:tracking:source:force"
|
|
2231
|
+
"deploy:metadata:validate",
|
|
2232
|
+
"metadata:deploy:validate",
|
|
2233
|
+
"metadata:validate:deploy",
|
|
2234
|
+
"deploy:validate:metadata",
|
|
2235
|
+
"validate:deploy:metadata",
|
|
2236
|
+
"validate:metadata:deploy"
|
|
2240
2237
|
],
|
|
2241
2238
|
"permutations": [
|
|
2242
|
-
"project:
|
|
2243
|
-
"
|
|
2244
|
-
"
|
|
2245
|
-
"project:
|
|
2246
|
-
"
|
|
2247
|
-
"
|
|
2239
|
+
"project:deploy:validate",
|
|
2240
|
+
"deploy:project:validate",
|
|
2241
|
+
"deploy:validate:project",
|
|
2242
|
+
"project:validate:deploy",
|
|
2243
|
+
"validate:project:deploy",
|
|
2244
|
+
"validate:deploy:project"
|
|
2248
2245
|
]
|
|
2249
2246
|
},
|
|
2250
2247
|
"project:generate:manifest": {
|
|
@@ -3027,5 +3024,5 @@
|
|
|
3027
3024
|
]
|
|
3028
3025
|
}
|
|
3029
3026
|
},
|
|
3030
|
-
"version": "3.9.
|
|
3027
|
+
"version": "3.9.17"
|
|
3031
3028
|
}
|