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