@salesforce/plugin-deploy-retrieve 3.22.14 → 3.22.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -17
- package/oclif.manifest.json +1288 -1288
- package/package.json +8 -8
package/oclif.manifest.json
CHANGED
|
@@ -347,16 +347,20 @@
|
|
|
347
347
|
"tracking:delete:project"
|
|
348
348
|
]
|
|
349
349
|
},
|
|
350
|
-
"project:
|
|
350
|
+
"project:generate:manifest": {
|
|
351
351
|
"aliases": [
|
|
352
|
-
"
|
|
352
|
+
"force:source:manifest:create"
|
|
353
353
|
],
|
|
354
354
|
"args": {},
|
|
355
355
|
"deprecateAliases": true,
|
|
356
|
-
"description": "
|
|
356
|
+
"description": "Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these flags, not both.\n\nUse --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this flag, and their respective file names, are:\n\n * package : package.xml (default)\n * pre : destructiveChangesPre.xml\n * post : destructiveChangesPost.xml\n * destroy : destructiveChanges.xml\n\nSee https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for information about these destructive manifest files.\n\nUse --name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --type or --name, but not both.\n\nTo include 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 --include-packages and --source-dir.\n\nTo build a manifest from the metadata in an org, use the --from-org flag. You can combine --from-org with the --metadata flag to include only certain metadata types, or with the --excluded-metadata flag to exclude certain metadata types. When building a manifest from an org, the command makes many concurrent API calls to discover the metadata that exists in the org. To limit the number of concurrent requests, use the SF_LIST_METADATA_BATCH_SIZE environment variable and set it to a size that works best for your org and environment. If you experience timeouts or inconsistent manifest contents, then setting this environment variable can improve accuracy. However, the command takes longer to run because it sends fewer requests at a time.",
|
|
357
357
|
"examples": [
|
|
358
|
-
"
|
|
359
|
-
"
|
|
358
|
+
"Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject",
|
|
359
|
+
"Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
|
|
360
|
+
"Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:\n$ <%= config.bin %> <%= command.id %> --source-dir force-app --name myNewManifest",
|
|
361
|
+
"Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --include-packages unlocked",
|
|
362
|
+
"Create a manifest from specific metadata types in an org:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --metadata ApexClass,CustomObject,CustomLabels",
|
|
363
|
+
"Create a manifest from all metadata components in an org excluding specific metadata types:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --excluded-metadata StandardValueSet"
|
|
360
364
|
],
|
|
361
365
|
"flags": {
|
|
362
366
|
"json": {
|
|
@@ -374,103 +378,213 @@
|
|
|
374
378
|
"multiple": false,
|
|
375
379
|
"type": "option"
|
|
376
380
|
},
|
|
377
|
-
"
|
|
378
|
-
"
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
"
|
|
382
|
-
"
|
|
381
|
+
"api-version": {
|
|
382
|
+
"aliases": [
|
|
383
|
+
"apiversion"
|
|
384
|
+
],
|
|
385
|
+
"deprecateAliases": true,
|
|
386
|
+
"description": "Override the api version used for api requests made by this command",
|
|
387
|
+
"name": "api-version",
|
|
388
|
+
"hasDynamicHelp": false,
|
|
383
389
|
"multiple": false,
|
|
384
390
|
"type": "option"
|
|
385
391
|
},
|
|
386
|
-
"
|
|
387
|
-
"
|
|
392
|
+
"loglevel": {
|
|
393
|
+
"deprecated": {
|
|
394
|
+
"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."
|
|
395
|
+
},
|
|
396
|
+
"hidden": true,
|
|
397
|
+
"name": "loglevel",
|
|
398
|
+
"hasDynamicHelp": false,
|
|
399
|
+
"multiple": false,
|
|
400
|
+
"type": "option"
|
|
401
|
+
},
|
|
402
|
+
"metadata": {
|
|
403
|
+
"char": "m",
|
|
404
|
+
"name": "metadata",
|
|
405
|
+
"summary": "Names of metadata components to include in the manifest.",
|
|
406
|
+
"delimiter": ",",
|
|
407
|
+
"hasDynamicHelp": false,
|
|
408
|
+
"multiple": true,
|
|
409
|
+
"type": "option"
|
|
410
|
+
},
|
|
411
|
+
"source-dir": {
|
|
412
|
+
"aliases": [
|
|
413
|
+
"sourcepath"
|
|
414
|
+
],
|
|
415
|
+
"char": "p",
|
|
416
|
+
"deprecateAliases": true,
|
|
417
|
+
"name": "source-dir",
|
|
418
|
+
"summary": "Paths to the local source files to include in the manifest.",
|
|
419
|
+
"delimiter": ",",
|
|
420
|
+
"hasDynamicHelp": false,
|
|
421
|
+
"multiple": true,
|
|
422
|
+
"type": "option"
|
|
423
|
+
},
|
|
424
|
+
"name": {
|
|
425
|
+
"aliases": [
|
|
426
|
+
"manifestname"
|
|
427
|
+
],
|
|
428
|
+
"char": "n",
|
|
429
|
+
"deprecateAliases": true,
|
|
388
430
|
"exclusive": [
|
|
389
|
-
"
|
|
431
|
+
"type"
|
|
390
432
|
],
|
|
391
|
-
"name": "
|
|
392
|
-
"summary": "
|
|
393
|
-
"
|
|
394
|
-
"
|
|
433
|
+
"name": "name",
|
|
434
|
+
"summary": "Name of a custom manifest file to create.",
|
|
435
|
+
"hasDynamicHelp": false,
|
|
436
|
+
"multiple": false,
|
|
437
|
+
"type": "option"
|
|
395
438
|
},
|
|
396
|
-
"
|
|
397
|
-
"
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
"
|
|
439
|
+
"type": {
|
|
440
|
+
"aliases": [
|
|
441
|
+
"manifesttype"
|
|
442
|
+
],
|
|
443
|
+
"char": "t",
|
|
444
|
+
"deprecateAliases": true,
|
|
445
|
+
"exclusive": [
|
|
446
|
+
"name"
|
|
447
|
+
],
|
|
448
|
+
"name": "type",
|
|
449
|
+
"summary": "Type of manifest to create; the type determines the name of the created file.",
|
|
401
450
|
"hasDynamicHelp": false,
|
|
402
451
|
"multiple": false,
|
|
452
|
+
"options": [
|
|
453
|
+
"pre",
|
|
454
|
+
"post",
|
|
455
|
+
"destroy",
|
|
456
|
+
"package"
|
|
457
|
+
],
|
|
403
458
|
"type": "option"
|
|
404
459
|
},
|
|
405
|
-
"
|
|
406
|
-
"
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
"
|
|
410
|
-
"
|
|
411
|
-
|
|
460
|
+
"include-packages": {
|
|
461
|
+
"aliases": [
|
|
462
|
+
"includepackages"
|
|
463
|
+
],
|
|
464
|
+
"char": "c",
|
|
465
|
+
"dependsOn": [
|
|
466
|
+
"from-org"
|
|
467
|
+
],
|
|
468
|
+
"deprecateAliases": true,
|
|
469
|
+
"name": "include-packages",
|
|
470
|
+
"summary": "Package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in managed and unlocked packages is excluded. Metadata in unmanaged packages is always included.",
|
|
471
|
+
"delimiter": ",",
|
|
472
|
+
"hasDynamicHelp": false,
|
|
473
|
+
"multiple": true,
|
|
474
|
+
"options": [
|
|
475
|
+
"managed",
|
|
476
|
+
"unlocked"
|
|
477
|
+
],
|
|
478
|
+
"type": "option"
|
|
412
479
|
},
|
|
413
|
-
"
|
|
414
|
-
"
|
|
415
|
-
"
|
|
480
|
+
"excluded-metadata": {
|
|
481
|
+
"name": "excluded-metadata",
|
|
482
|
+
"relationships": [
|
|
483
|
+
{
|
|
484
|
+
"type": "some",
|
|
485
|
+
"flags": [
|
|
486
|
+
"from-org",
|
|
487
|
+
"source-dir"
|
|
488
|
+
]
|
|
489
|
+
}
|
|
490
|
+
],
|
|
491
|
+
"summary": "Metadata types to exclude when building a manifest from an org. Specify the name of the type, not the name of a specific component.",
|
|
492
|
+
"delimiter": ",",
|
|
493
|
+
"hasDynamicHelp": false,
|
|
494
|
+
"multiple": true,
|
|
495
|
+
"type": "option"
|
|
496
|
+
},
|
|
497
|
+
"from-org": {
|
|
498
|
+
"aliases": [
|
|
499
|
+
"fromorg"
|
|
500
|
+
],
|
|
501
|
+
"deprecateAliases": true,
|
|
416
502
|
"exclusive": [
|
|
417
|
-
"
|
|
503
|
+
"source-dir"
|
|
418
504
|
],
|
|
419
|
-
"name": "
|
|
420
|
-
"summary": "
|
|
421
|
-
"hasDynamicHelp":
|
|
422
|
-
"
|
|
505
|
+
"name": "from-org",
|
|
506
|
+
"summary": "Username or alias of the org that contains the metadata components from which to build a manifest.",
|
|
507
|
+
"hasDynamicHelp": false,
|
|
508
|
+
"multiple": false,
|
|
509
|
+
"type": "option"
|
|
510
|
+
},
|
|
511
|
+
"output-dir": {
|
|
512
|
+
"aliases": [
|
|
513
|
+
"outputdir",
|
|
514
|
+
"o"
|
|
515
|
+
],
|
|
516
|
+
"char": "d",
|
|
517
|
+
"deprecateAliases": true,
|
|
518
|
+
"name": "output-dir",
|
|
519
|
+
"summary": "Directory to save the created manifest.",
|
|
520
|
+
"hasDynamicHelp": false,
|
|
423
521
|
"multiple": false,
|
|
424
522
|
"type": "option"
|
|
425
523
|
}
|
|
426
524
|
},
|
|
427
|
-
"hasDynamicHelp":
|
|
525
|
+
"hasDynamicHelp": false,
|
|
428
526
|
"hiddenAliases": [],
|
|
429
|
-
"id": "project:
|
|
527
|
+
"id": "project:generate:manifest",
|
|
430
528
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
431
529
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
432
530
|
"pluginType": "core",
|
|
433
531
|
"strict": true,
|
|
434
|
-
"summary": "
|
|
532
|
+
"summary": "Create a project manifest that lists the metadata components you want to deploy or retrieve.",
|
|
435
533
|
"enableJsonFlag": true,
|
|
534
|
+
"requiresProject": true,
|
|
436
535
|
"isESM": true,
|
|
437
536
|
"relativePath": [
|
|
438
537
|
"lib",
|
|
439
538
|
"commands",
|
|
440
539
|
"project",
|
|
441
|
-
"
|
|
442
|
-
"
|
|
540
|
+
"generate",
|
|
541
|
+
"manifest.js"
|
|
443
542
|
],
|
|
444
543
|
"aliasPermutations": [
|
|
445
|
-
"
|
|
446
|
-
"
|
|
447
|
-
"
|
|
448
|
-
"
|
|
449
|
-
"
|
|
450
|
-
"
|
|
544
|
+
"force:source:manifest:create",
|
|
545
|
+
"source:force:manifest:create",
|
|
546
|
+
"source:manifest:force:create",
|
|
547
|
+
"source:manifest:create:force",
|
|
548
|
+
"force:manifest:source:create",
|
|
549
|
+
"manifest:force:source:create",
|
|
550
|
+
"manifest:source:force:create",
|
|
551
|
+
"manifest:source:create:force",
|
|
552
|
+
"force:manifest:create:source",
|
|
553
|
+
"manifest:force:create:source",
|
|
554
|
+
"manifest:create:force:source",
|
|
555
|
+
"manifest:create:source:force",
|
|
556
|
+
"force:source:create:manifest",
|
|
557
|
+
"source:force:create:manifest",
|
|
558
|
+
"source:create:force:manifest",
|
|
559
|
+
"source:create:manifest:force",
|
|
560
|
+
"force:create:source:manifest",
|
|
561
|
+
"create:force:source:manifest",
|
|
562
|
+
"create:source:force:manifest",
|
|
563
|
+
"create:source:manifest:force",
|
|
564
|
+
"force:create:manifest:source",
|
|
565
|
+
"create:force:manifest:source",
|
|
566
|
+
"create:manifest:force:source",
|
|
567
|
+
"create:manifest:source:force"
|
|
451
568
|
],
|
|
452
569
|
"permutations": [
|
|
453
|
-
"project:
|
|
454
|
-
"
|
|
455
|
-
"
|
|
456
|
-
"project:
|
|
457
|
-
"
|
|
458
|
-
"
|
|
570
|
+
"project:generate:manifest",
|
|
571
|
+
"generate:project:manifest",
|
|
572
|
+
"generate:manifest:project",
|
|
573
|
+
"project:manifest:generate",
|
|
574
|
+
"manifest:project:generate",
|
|
575
|
+
"manifest:generate:project"
|
|
459
576
|
]
|
|
460
577
|
},
|
|
461
|
-
"project:
|
|
578
|
+
"project:convert:mdapi": {
|
|
462
579
|
"aliases": [
|
|
463
|
-
"
|
|
580
|
+
"force:mdapi:convert"
|
|
464
581
|
],
|
|
465
582
|
"args": {},
|
|
466
583
|
"deprecateAliases": true,
|
|
467
|
-
"description": "
|
|
584
|
+
"description": "To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the metadata format to the source format using this command.\n\nTo convert files from the source format back to the metadata format, run \"sf project convert source\".\n\nTo convert 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.",
|
|
468
585
|
"examples": [
|
|
469
|
-
"
|
|
470
|
-
"
|
|
471
|
-
"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",
|
|
472
|
-
"Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
473
|
-
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
586
|
+
"Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata",
|
|
587
|
+
"Similar to previous example, but writes converted files to the specified output directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir"
|
|
474
588
|
],
|
|
475
589
|
"flags": {
|
|
476
590
|
"json": {
|
|
@@ -488,77 +602,101 @@
|
|
|
488
602
|
"multiple": false,
|
|
489
603
|
"type": "option"
|
|
490
604
|
},
|
|
491
|
-
"
|
|
492
|
-
"
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
"
|
|
496
|
-
"
|
|
497
|
-
"
|
|
498
|
-
},
|
|
499
|
-
"manifest": {
|
|
500
|
-
"char": "x",
|
|
501
|
-
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
502
|
-
"exclusive": [
|
|
503
|
-
"source-dir",
|
|
504
|
-
"metadata"
|
|
505
|
-
],
|
|
506
|
-
"name": "manifest",
|
|
507
|
-
"summary": "Full file path for manifest (package.xml) of components to preview.",
|
|
605
|
+
"api-version": {
|
|
606
|
+
"aliases": [
|
|
607
|
+
"apiversion"
|
|
608
|
+
],
|
|
609
|
+
"deprecateAliases": true,
|
|
610
|
+
"description": "Override the api version used for api requests made by this command",
|
|
611
|
+
"name": "api-version",
|
|
508
612
|
"hasDynamicHelp": false,
|
|
509
613
|
"multiple": false,
|
|
510
614
|
"type": "option"
|
|
511
615
|
},
|
|
512
|
-
"
|
|
513
|
-
"
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
616
|
+
"loglevel": {
|
|
617
|
+
"deprecated": {
|
|
618
|
+
"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."
|
|
619
|
+
},
|
|
620
|
+
"hidden": true,
|
|
621
|
+
"name": "loglevel",
|
|
622
|
+
"hasDynamicHelp": false,
|
|
623
|
+
"multiple": false,
|
|
624
|
+
"type": "option"
|
|
625
|
+
},
|
|
626
|
+
"root-dir": {
|
|
627
|
+
"aliases": [
|
|
628
|
+
"rootdir"
|
|
517
629
|
],
|
|
518
|
-
"
|
|
519
|
-
"
|
|
630
|
+
"char": "r",
|
|
631
|
+
"deprecateAliases": true,
|
|
632
|
+
"name": "root-dir",
|
|
633
|
+
"required": true,
|
|
634
|
+
"summary": "Root directory that contains the Metadata API–formatted metadata.",
|
|
520
635
|
"hasDynamicHelp": false,
|
|
521
|
-
"multiple":
|
|
636
|
+
"multiple": false,
|
|
522
637
|
"type": "option"
|
|
523
638
|
},
|
|
524
|
-
"
|
|
639
|
+
"output-dir": {
|
|
640
|
+
"aliases": [
|
|
641
|
+
"outputdir"
|
|
642
|
+
],
|
|
525
643
|
"char": "d",
|
|
526
|
-
"
|
|
644
|
+
"deprecateAliases": true,
|
|
645
|
+
"name": "output-dir",
|
|
646
|
+
"summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
|
|
647
|
+
"hasDynamicHelp": false,
|
|
648
|
+
"multiple": false,
|
|
649
|
+
"type": "option"
|
|
650
|
+
},
|
|
651
|
+
"manifest": {
|
|
652
|
+
"char": "x",
|
|
653
|
+
"description": "If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
654
|
+
"name": "manifest",
|
|
655
|
+
"summary": "File path to manifest (package.xml) of metadata types to convert.",
|
|
656
|
+
"hasDynamicHelp": false,
|
|
657
|
+
"multiple": false,
|
|
658
|
+
"type": "option"
|
|
659
|
+
},
|
|
660
|
+
"metadata-dir": {
|
|
661
|
+
"aliases": [
|
|
662
|
+
"metadatapath"
|
|
663
|
+
],
|
|
664
|
+
"char": "p",
|
|
665
|
+
"deprecateAliases": true,
|
|
666
|
+
"description": "The supplied paths 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 sub-directories).\n\nIf you specify this flag, don’t specify --manifest or --metadata. If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes.",
|
|
527
667
|
"exclusive": [
|
|
528
668
|
"manifest",
|
|
529
669
|
"metadata"
|
|
530
670
|
],
|
|
531
|
-
"name": "
|
|
532
|
-
"summary": "
|
|
671
|
+
"name": "metadata-dir",
|
|
672
|
+
"summary": "Root of directory or zip file of metadata formatted files to convert.",
|
|
673
|
+
"delimiter": ",",
|
|
533
674
|
"hasDynamicHelp": false,
|
|
534
675
|
"multiple": true,
|
|
535
676
|
"type": "option"
|
|
536
677
|
},
|
|
537
|
-
"
|
|
538
|
-
"char": "
|
|
539
|
-
"
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
"
|
|
544
|
-
"
|
|
678
|
+
"metadata": {
|
|
679
|
+
"char": "m",
|
|
680
|
+
"exclusive": [
|
|
681
|
+
"manifest",
|
|
682
|
+
"metadatapath"
|
|
683
|
+
],
|
|
684
|
+
"name": "metadata",
|
|
685
|
+
"summary": "Metadata component names to convert.",
|
|
686
|
+
"delimiter": ",",
|
|
687
|
+
"hasDynamicHelp": false,
|
|
688
|
+
"multiple": true,
|
|
545
689
|
"type": "option"
|
|
546
|
-
},
|
|
547
|
-
"concise": {
|
|
548
|
-
"name": "concise",
|
|
549
|
-
"summary": "Show only the changes that will be deployed; omits files that are forceignored.",
|
|
550
|
-
"allowNo": false,
|
|
551
|
-
"type": "boolean"
|
|
552
690
|
}
|
|
553
691
|
},
|
|
554
|
-
"hasDynamicHelp":
|
|
692
|
+
"hasDynamicHelp": false,
|
|
555
693
|
"hiddenAliases": [],
|
|
556
|
-
"id": "project:
|
|
694
|
+
"id": "project:convert:mdapi",
|
|
557
695
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
558
696
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
559
697
|
"pluginType": "core",
|
|
560
698
|
"strict": true,
|
|
561
|
-
"summary": "
|
|
699
|
+
"summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
|
|
562
700
|
"enableJsonFlag": true,
|
|
563
701
|
"requiresProject": true,
|
|
564
702
|
"isESM": true,
|
|
@@ -566,36 +704,34 @@
|
|
|
566
704
|
"lib",
|
|
567
705
|
"commands",
|
|
568
706
|
"project",
|
|
569
|
-
"
|
|
570
|
-
"
|
|
707
|
+
"convert",
|
|
708
|
+
"mdapi.js"
|
|
571
709
|
],
|
|
572
710
|
"aliasPermutations": [
|
|
573
|
-
"
|
|
574
|
-
"
|
|
575
|
-
"
|
|
576
|
-
"
|
|
577
|
-
"
|
|
578
|
-
"
|
|
711
|
+
"force:mdapi:convert",
|
|
712
|
+
"mdapi:force:convert",
|
|
713
|
+
"mdapi:convert:force",
|
|
714
|
+
"force:convert:mdapi",
|
|
715
|
+
"convert:force:mdapi",
|
|
716
|
+
"convert:mdapi:force"
|
|
579
717
|
],
|
|
580
718
|
"permutations": [
|
|
581
|
-
"project:
|
|
582
|
-
"
|
|
583
|
-
"
|
|
584
|
-
"project:
|
|
585
|
-
"
|
|
586
|
-
"
|
|
719
|
+
"project:convert:mdapi",
|
|
720
|
+
"convert:project:mdapi",
|
|
721
|
+
"convert:mdapi:project",
|
|
722
|
+
"project:mdapi:convert",
|
|
723
|
+
"mdapi:project:convert",
|
|
724
|
+
"mdapi:convert:project"
|
|
587
725
|
]
|
|
588
726
|
},
|
|
589
|
-
"project:
|
|
590
|
-
"aliases": [
|
|
591
|
-
"deploy:metadata:quick"
|
|
592
|
-
],
|
|
727
|
+
"project:convert:source-behavior": {
|
|
728
|
+
"aliases": [],
|
|
593
729
|
"args": {},
|
|
594
|
-
"
|
|
595
|
-
"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.",
|
|
730
|
+
"description": "Specifically, this command updates the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file and then converts the associated local source files in your project as needed.\n\nFor example, run this command with the \"--behavior decomposePermissionSetBeta\" flag to start decomposing permission sets when you deploy or retrieve them. Decomposing means breaking up the monolithic metadata API format XML file that corresponds to a metadata component into smaller XML files and directories based on its subtypes. Permission sets are not decomposed by default; you must opt-in to start decomposing them by using this command. When the command finishes, your \"sfdx-project.json\" file is updated to always decompose permission sets, and the existing permission set files in your local package directories are converted into the new decomposed format. You run this command only once for a given behavior change.\n\nFor more information about the possible values for the --behavior flag, see the \"sourceBehaviorOptions\" section in the https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.",
|
|
596
731
|
"examples": [
|
|
597
|
-
"
|
|
598
|
-
"
|
|
732
|
+
"Update your Salesforce DX project to decompose custom permission sets:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta",
|
|
733
|
+
"Display what the command would do, but don't change any existing files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run",
|
|
734
|
+
"Keep the temporary directory that contains the interim metadata API formatted files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir"
|
|
599
735
|
],
|
|
600
736
|
"flags": {
|
|
601
737
|
"json": {
|
|
@@ -613,34 +749,36 @@
|
|
|
613
749
|
"multiple": false,
|
|
614
750
|
"type": "option"
|
|
615
751
|
},
|
|
616
|
-
"
|
|
617
|
-
"
|
|
618
|
-
"
|
|
619
|
-
|
|
752
|
+
"behavior": {
|
|
753
|
+
"char": "b",
|
|
754
|
+
"name": "behavior",
|
|
755
|
+
"required": true,
|
|
756
|
+
"summary": "Behavior to enable; the values correspond to the possible values of the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file.",
|
|
757
|
+
"hasDynamicHelp": false,
|
|
758
|
+
"multiple": false,
|
|
759
|
+
"options": [
|
|
760
|
+
"decomposeCustomLabelsBeta2",
|
|
761
|
+
"decomposeCustomLabelsBeta",
|
|
762
|
+
"decomposePermissionSetBeta",
|
|
763
|
+
"decomposePermissionSetBeta2",
|
|
764
|
+
"decomposeSharingRulesBeta",
|
|
765
|
+
"decomposeWorkflowBeta",
|
|
766
|
+
"decomposeExternalServiceRegistrationBeta"
|
|
620
767
|
],
|
|
621
|
-
"
|
|
622
|
-
|
|
768
|
+
"type": "option"
|
|
769
|
+
},
|
|
770
|
+
"dry-run": {
|
|
771
|
+
"name": "dry-run",
|
|
772
|
+
"summary": "Display what the command would do, but don't make any actual changes.",
|
|
623
773
|
"allowNo": false,
|
|
624
774
|
"type": "boolean"
|
|
625
775
|
},
|
|
626
|
-
"
|
|
627
|
-
"
|
|
628
|
-
|
|
629
|
-
],
|
|
630
|
-
"name": "concise",
|
|
631
|
-
"summary": "Show concise output of the deploy result.",
|
|
776
|
+
"preserve-temp-dir": {
|
|
777
|
+
"name": "preserve-temp-dir",
|
|
778
|
+
"summary": "Don't delete the metadata API format temporary directory that this command creates. Useful for debugging.",
|
|
632
779
|
"allowNo": false,
|
|
633
780
|
"type": "boolean"
|
|
634
781
|
},
|
|
635
|
-
"job-id": {
|
|
636
|
-
"char": "i",
|
|
637
|
-
"description": "The job ID is valid for 10 days from when you started the validation.",
|
|
638
|
-
"name": "job-id",
|
|
639
|
-
"summary": "Job ID of the deployment you want to quick deploy.",
|
|
640
|
-
"hasDynamicHelp": false,
|
|
641
|
-
"multiple": false,
|
|
642
|
-
"type": "option"
|
|
643
|
-
},
|
|
644
782
|
"target-org": {
|
|
645
783
|
"char": "o",
|
|
646
784
|
"name": "target-org",
|
|
@@ -649,126 +787,47 @@
|
|
|
649
787
|
"hasDynamicHelp": true,
|
|
650
788
|
"multiple": false,
|
|
651
789
|
"type": "option"
|
|
652
|
-
},
|
|
653
|
-
"use-most-recent": {
|
|
654
|
-
"char": "r",
|
|
655
|
-
"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.",
|
|
656
|
-
"name": "use-most-recent",
|
|
657
|
-
"summary": "Use the job ID of the most recently validated deployment.",
|
|
658
|
-
"allowNo": false,
|
|
659
|
-
"type": "boolean"
|
|
660
|
-
},
|
|
661
|
-
"verbose": {
|
|
662
|
-
"exclusive": [
|
|
663
|
-
"concise"
|
|
664
|
-
],
|
|
665
|
-
"name": "verbose",
|
|
666
|
-
"summary": "Show verbose output of the deploy result.",
|
|
667
|
-
"allowNo": false,
|
|
668
|
-
"type": "boolean"
|
|
669
|
-
},
|
|
670
|
-
"wait": {
|
|
671
|
-
"char": "w",
|
|
672
|
-
"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\".",
|
|
673
|
-
"exclusive": [
|
|
674
|
-
"async"
|
|
675
|
-
],
|
|
676
|
-
"name": "wait",
|
|
677
|
-
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
678
|
-
"default": "33 minutes",
|
|
679
|
-
"hasDynamicHelp": true,
|
|
680
|
-
"helpValue": "<minutes>",
|
|
681
|
-
"multiple": false,
|
|
682
|
-
"type": "option"
|
|
683
|
-
},
|
|
684
|
-
"api-version": {
|
|
685
|
-
"char": "a",
|
|
686
|
-
"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.",
|
|
687
|
-
"name": "api-version",
|
|
688
|
-
"summary": "Target API version for the deploy.",
|
|
689
|
-
"hasDynamicHelp": false,
|
|
690
|
-
"multiple": false,
|
|
691
|
-
"type": "option"
|
|
692
790
|
}
|
|
693
791
|
},
|
|
694
792
|
"hasDynamicHelp": true,
|
|
695
793
|
"hiddenAliases": [],
|
|
696
|
-
"id": "project:
|
|
794
|
+
"id": "project:convert:source-behavior",
|
|
697
795
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
698
796
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
699
797
|
"pluginType": "core",
|
|
798
|
+
"state": "beta",
|
|
700
799
|
"strict": true,
|
|
701
|
-
"summary": "
|
|
800
|
+
"summary": "Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.",
|
|
702
801
|
"enableJsonFlag": true,
|
|
703
|
-
"
|
|
704
|
-
"header": "ERROR CODES",
|
|
705
|
-
"body": [
|
|
706
|
-
{
|
|
707
|
-
"name": "Succeeded (0)",
|
|
708
|
-
"description": "The deploy succeeded."
|
|
709
|
-
},
|
|
710
|
-
{
|
|
711
|
-
"name": "Canceled (1)",
|
|
712
|
-
"description": "The deploy was canceled."
|
|
713
|
-
},
|
|
714
|
-
{
|
|
715
|
-
"name": "Failed (1)",
|
|
716
|
-
"description": "The deploy failed."
|
|
717
|
-
},
|
|
718
|
-
{
|
|
719
|
-
"name": "SucceededPartial (68)",
|
|
720
|
-
"description": "The deploy partially succeeded."
|
|
721
|
-
},
|
|
722
|
-
{
|
|
723
|
-
"name": "InProgress (69)",
|
|
724
|
-
"description": "The deploy is in progress."
|
|
725
|
-
},
|
|
726
|
-
{
|
|
727
|
-
"name": "Pending (69)",
|
|
728
|
-
"description": "The deploy is pending."
|
|
729
|
-
},
|
|
730
|
-
{
|
|
731
|
-
"name": "Canceling (69)",
|
|
732
|
-
"description": "The deploy is being canceled."
|
|
733
|
-
}
|
|
734
|
-
]
|
|
735
|
-
},
|
|
802
|
+
"requiresProject": true,
|
|
736
803
|
"isESM": true,
|
|
737
804
|
"relativePath": [
|
|
738
805
|
"lib",
|
|
739
806
|
"commands",
|
|
740
807
|
"project",
|
|
741
|
-
"
|
|
742
|
-
"
|
|
743
|
-
],
|
|
744
|
-
"aliasPermutations": [
|
|
745
|
-
"deploy:metadata:quick",
|
|
746
|
-
"metadata:deploy:quick",
|
|
747
|
-
"metadata:quick:deploy",
|
|
748
|
-
"deploy:quick:metadata",
|
|
749
|
-
"quick:deploy:metadata",
|
|
750
|
-
"quick:metadata:deploy"
|
|
808
|
+
"convert",
|
|
809
|
+
"source-behavior.js"
|
|
751
810
|
],
|
|
811
|
+
"aliasPermutations": [],
|
|
752
812
|
"permutations": [
|
|
753
|
-
"project:
|
|
754
|
-
"
|
|
755
|
-
"
|
|
756
|
-
"project:
|
|
757
|
-
"
|
|
758
|
-
"
|
|
813
|
+
"project:convert:source-behavior",
|
|
814
|
+
"convert:project:source-behavior",
|
|
815
|
+
"convert:source-behavior:project",
|
|
816
|
+
"project:source-behavior:convert",
|
|
817
|
+
"source-behavior:project:convert",
|
|
818
|
+
"source-behavior:convert:project"
|
|
759
819
|
]
|
|
760
820
|
},
|
|
761
|
-
"project:
|
|
821
|
+
"project:convert:source": {
|
|
762
822
|
"aliases": [
|
|
763
|
-
"
|
|
823
|
+
"force:source:convert"
|
|
764
824
|
],
|
|
765
825
|
"args": {},
|
|
766
826
|
"deprecateAliases": true,
|
|
767
|
-
"description": "
|
|
827
|
+
"description": "To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using \"<%= config.bin %> project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"<%= config.bin %> project convert mdapi\".\n\nTo specify a package name that includes spaces, enclose the name in single quotes.\n\nTo convert multiple 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.",
|
|
768
828
|
"examples": [
|
|
769
|
-
"
|
|
770
|
-
"
|
|
771
|
-
"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"
|
|
829
|
+
"Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source",
|
|
830
|
+
"Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'"
|
|
772
831
|
],
|
|
773
832
|
"flags": {
|
|
774
833
|
"json": {
|
|
@@ -786,133 +845,151 @@
|
|
|
786
845
|
"multiple": false,
|
|
787
846
|
"type": "option"
|
|
788
847
|
},
|
|
789
|
-
"
|
|
790
|
-
"
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
"
|
|
794
|
-
"
|
|
848
|
+
"api-version": {
|
|
849
|
+
"aliases": [
|
|
850
|
+
"apiversion"
|
|
851
|
+
],
|
|
852
|
+
"deprecateAliases": true,
|
|
853
|
+
"description": "Override the api version used for api requests made by this command",
|
|
854
|
+
"name": "api-version",
|
|
855
|
+
"summary": "API Version to use in the generated project's manifest. By default, will use the version from sfdx-project.json",
|
|
856
|
+
"hasDynamicHelp": false,
|
|
795
857
|
"multiple": false,
|
|
796
858
|
"type": "option"
|
|
797
859
|
},
|
|
798
|
-
"
|
|
799
|
-
"
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
"
|
|
860
|
+
"loglevel": {
|
|
861
|
+
"deprecated": {
|
|
862
|
+
"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."
|
|
863
|
+
},
|
|
864
|
+
"hidden": true,
|
|
865
|
+
"name": "loglevel",
|
|
803
866
|
"hasDynamicHelp": false,
|
|
804
867
|
"multiple": false,
|
|
805
868
|
"type": "option"
|
|
806
869
|
},
|
|
807
|
-
"
|
|
870
|
+
"root-dir": {
|
|
871
|
+
"aliases": [
|
|
872
|
+
"rootdir"
|
|
873
|
+
],
|
|
808
874
|
"char": "r",
|
|
809
|
-
"
|
|
810
|
-
"name": "
|
|
811
|
-
"summary": "
|
|
812
|
-
"allowNo": false,
|
|
813
|
-
"type": "boolean"
|
|
814
|
-
},
|
|
815
|
-
"coverage-formatters": {
|
|
816
|
-
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
817
|
-
"helpGroup": "Test",
|
|
818
|
-
"name": "coverage-formatters",
|
|
819
|
-
"summary": "Format of the code coverage results.",
|
|
875
|
+
"deprecateAliases": true,
|
|
876
|
+
"name": "root-dir",
|
|
877
|
+
"summary": "Source directory other than the default package to convert.",
|
|
820
878
|
"hasDynamicHelp": false,
|
|
821
|
-
"multiple":
|
|
822
|
-
"options": [
|
|
823
|
-
"clover",
|
|
824
|
-
"cobertura",
|
|
825
|
-
"html-spa",
|
|
826
|
-
"html",
|
|
827
|
-
"json",
|
|
828
|
-
"json-summary",
|
|
829
|
-
"lcovonly",
|
|
830
|
-
"none",
|
|
831
|
-
"teamcity",
|
|
832
|
-
"text",
|
|
833
|
-
"text-summary"
|
|
834
|
-
],
|
|
879
|
+
"multiple": false,
|
|
835
880
|
"type": "option"
|
|
836
881
|
},
|
|
837
|
-
"
|
|
838
|
-
"
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
"
|
|
842
|
-
"
|
|
882
|
+
"output-dir": {
|
|
883
|
+
"aliases": [
|
|
884
|
+
"outputdir"
|
|
885
|
+
],
|
|
886
|
+
"char": "d",
|
|
887
|
+
"deprecateAliases": true,
|
|
888
|
+
"name": "output-dir",
|
|
889
|
+
"summary": "Output directory to store the Metadata API–formatted files in.",
|
|
890
|
+
"default": "metadataPackage_>timestamp<",
|
|
891
|
+
"hasDynamicHelp": true,
|
|
892
|
+
"multiple": false,
|
|
893
|
+
"type": "option"
|
|
843
894
|
},
|
|
844
|
-
"
|
|
845
|
-
"
|
|
846
|
-
|
|
847
|
-
"relationships": [
|
|
848
|
-
{
|
|
849
|
-
"type": "some",
|
|
850
|
-
"flags": [
|
|
851
|
-
"coverage-formatters",
|
|
852
|
-
"junit"
|
|
853
|
-
]
|
|
854
|
-
}
|
|
895
|
+
"package-name": {
|
|
896
|
+
"aliases": [
|
|
897
|
+
"packagename"
|
|
855
898
|
],
|
|
856
|
-
"
|
|
899
|
+
"char": "n",
|
|
900
|
+
"deprecateAliases": true,
|
|
901
|
+
"name": "package-name",
|
|
902
|
+
"summary": "Name of the package to associate with the metadata-formatted files.",
|
|
857
903
|
"hasDynamicHelp": false,
|
|
858
904
|
"multiple": false,
|
|
859
905
|
"type": "option"
|
|
860
906
|
},
|
|
861
|
-
"
|
|
862
|
-
"char": "
|
|
863
|
-
"description": "If
|
|
864
|
-
"name": "
|
|
865
|
-
"summary": "
|
|
866
|
-
"hasDynamicHelp":
|
|
867
|
-
"helpValue": "<minutes>",
|
|
907
|
+
"manifest": {
|
|
908
|
+
"char": "x",
|
|
909
|
+
"description": "If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
910
|
+
"name": "manifest",
|
|
911
|
+
"summary": "Path to the manifest (package.xml) file that specifies the metadata types to convert.",
|
|
912
|
+
"hasDynamicHelp": false,
|
|
868
913
|
"multiple": false,
|
|
869
914
|
"type": "option"
|
|
915
|
+
},
|
|
916
|
+
"source-dir": {
|
|
917
|
+
"aliases": [
|
|
918
|
+
"sourcepath"
|
|
919
|
+
],
|
|
920
|
+
"char": "p",
|
|
921
|
+
"deprecateAliases": true,
|
|
922
|
+
"description": "The supplied paths 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 sub-directories).\n\nIf you specify this flag, don’t specify --manifest or --metadata.",
|
|
923
|
+
"exclusive": [
|
|
924
|
+
"manifest",
|
|
925
|
+
"metadata"
|
|
926
|
+
],
|
|
927
|
+
"name": "source-dir",
|
|
928
|
+
"summary": "Paths to the local source files to convert.",
|
|
929
|
+
"delimiter": ",",
|
|
930
|
+
"hasDynamicHelp": false,
|
|
931
|
+
"multiple": true,
|
|
932
|
+
"type": "option"
|
|
933
|
+
},
|
|
934
|
+
"metadata": {
|
|
935
|
+
"char": "m",
|
|
936
|
+
"exclusive": [
|
|
937
|
+
"manifest",
|
|
938
|
+
"sourcepath"
|
|
939
|
+
],
|
|
940
|
+
"name": "metadata",
|
|
941
|
+
"summary": "Metadata component names to convert.",
|
|
942
|
+
"delimiter": ",",
|
|
943
|
+
"hasDynamicHelp": false,
|
|
944
|
+
"multiple": true,
|
|
945
|
+
"type": "option"
|
|
870
946
|
}
|
|
871
947
|
},
|
|
872
948
|
"hasDynamicHelp": true,
|
|
873
949
|
"hiddenAliases": [],
|
|
874
|
-
"id": "project:
|
|
950
|
+
"id": "project:convert:source",
|
|
875
951
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
876
952
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
877
953
|
"pluginType": "core",
|
|
878
954
|
"strict": true,
|
|
879
|
-
"summary": "
|
|
955
|
+
"summary": "Convert source-formatted files into metadata that you can deploy using Metadata API.",
|
|
880
956
|
"enableJsonFlag": true,
|
|
957
|
+
"requiresProject": true,
|
|
881
958
|
"isESM": true,
|
|
882
959
|
"relativePath": [
|
|
883
960
|
"lib",
|
|
884
961
|
"commands",
|
|
885
962
|
"project",
|
|
886
|
-
"
|
|
887
|
-
"
|
|
963
|
+
"convert",
|
|
964
|
+
"source.js"
|
|
888
965
|
],
|
|
889
966
|
"aliasPermutations": [
|
|
890
|
-
"
|
|
891
|
-
"
|
|
892
|
-
"
|
|
893
|
-
"
|
|
894
|
-
"
|
|
895
|
-
"
|
|
967
|
+
"force:source:convert",
|
|
968
|
+
"source:force:convert",
|
|
969
|
+
"source:convert:force",
|
|
970
|
+
"force:convert:source",
|
|
971
|
+
"convert:force:source",
|
|
972
|
+
"convert:source:force"
|
|
896
973
|
],
|
|
897
974
|
"permutations": [
|
|
898
|
-
"project:
|
|
899
|
-
"
|
|
900
|
-
"
|
|
901
|
-
"project:
|
|
902
|
-
"
|
|
903
|
-
"
|
|
975
|
+
"project:convert:source",
|
|
976
|
+
"convert:project:source",
|
|
977
|
+
"convert:source:project",
|
|
978
|
+
"project:source:convert",
|
|
979
|
+
"source:project:convert",
|
|
980
|
+
"source:convert:project"
|
|
904
981
|
]
|
|
905
982
|
},
|
|
906
|
-
"project:deploy:
|
|
983
|
+
"project:deploy:cancel": {
|
|
907
984
|
"aliases": [
|
|
908
|
-
"deploy:metadata:
|
|
985
|
+
"deploy:metadata:cancel"
|
|
909
986
|
],
|
|
910
987
|
"args": {},
|
|
911
988
|
"deprecateAliases": true,
|
|
912
|
-
"description": "Use this command to
|
|
989
|
+
"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.",
|
|
913
990
|
"examples": [
|
|
914
|
-
"
|
|
915
|
-
"
|
|
991
|
+
"Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
992
|
+
"Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
916
993
|
],
|
|
917
994
|
"flags": {
|
|
918
995
|
"json": {
|
|
@@ -930,12 +1007,22 @@
|
|
|
930
1007
|
"multiple": false,
|
|
931
1008
|
"type": "option"
|
|
932
1009
|
},
|
|
933
|
-
"
|
|
1010
|
+
"target-org": {
|
|
1011
|
+
"char": "o",
|
|
1012
|
+
"name": "target-org",
|
|
1013
|
+
"noCacheDefault": true,
|
|
1014
|
+
"summary": "Username or alias of the target org.",
|
|
1015
|
+
"hasDynamicHelp": true,
|
|
1016
|
+
"multiple": false,
|
|
1017
|
+
"type": "option"
|
|
1018
|
+
},
|
|
1019
|
+
"async": {
|
|
1020
|
+
"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\".",
|
|
934
1021
|
"exclusive": [
|
|
935
|
-
"
|
|
1022
|
+
"wait"
|
|
936
1023
|
],
|
|
937
|
-
"name": "
|
|
938
|
-
"summary": "
|
|
1024
|
+
"name": "async",
|
|
1025
|
+
"summary": "Run the command asynchronously.",
|
|
939
1026
|
"allowNo": false,
|
|
940
1027
|
"type": "boolean"
|
|
941
1028
|
},
|
|
@@ -943,183 +1030,80 @@
|
|
|
943
1030
|
"char": "i",
|
|
944
1031
|
"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.",
|
|
945
1032
|
"name": "job-id",
|
|
946
|
-
"summary": "Job ID of the deploy operation you want to
|
|
1033
|
+
"summary": "Job ID of the deploy operation you want to cancel.",
|
|
947
1034
|
"hasDynamicHelp": false,
|
|
948
1035
|
"multiple": false,
|
|
949
1036
|
"type": "option"
|
|
950
1037
|
},
|
|
951
1038
|
"use-most-recent": {
|
|
952
1039
|
"char": "r",
|
|
953
|
-
"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
|
|
1040
|
+
"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.",
|
|
954
1041
|
"name": "use-most-recent",
|
|
955
1042
|
"summary": "Use the job ID of the most recent deploy operation.",
|
|
956
1043
|
"allowNo": false,
|
|
957
1044
|
"type": "boolean"
|
|
958
1045
|
},
|
|
959
|
-
"
|
|
1046
|
+
"wait": {
|
|
1047
|
+
"char": "w",
|
|
1048
|
+
"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\".",
|
|
960
1049
|
"exclusive": [
|
|
961
|
-
"
|
|
1050
|
+
"async"
|
|
962
1051
|
],
|
|
963
|
-
"name": "verbose",
|
|
964
|
-
"summary": "Show verbose output of the deploy operation result.",
|
|
965
|
-
"allowNo": false,
|
|
966
|
-
"type": "boolean"
|
|
967
|
-
},
|
|
968
|
-
"wait": {
|
|
969
|
-
"char": "w",
|
|
970
|
-
"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\".",
|
|
971
1052
|
"name": "wait",
|
|
972
1053
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
973
1054
|
"hasDynamicHelp": true,
|
|
974
1055
|
"helpValue": "<minutes>",
|
|
975
1056
|
"multiple": false,
|
|
976
1057
|
"type": "option"
|
|
977
|
-
},
|
|
978
|
-
"coverage-formatters": {
|
|
979
|
-
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
980
|
-
"helpGroup": "Test",
|
|
981
|
-
"name": "coverage-formatters",
|
|
982
|
-
"summary": "Format of the code coverage results.",
|
|
983
|
-
"hasDynamicHelp": false,
|
|
984
|
-
"multiple": true,
|
|
985
|
-
"options": [
|
|
986
|
-
"clover",
|
|
987
|
-
"cobertura",
|
|
988
|
-
"html-spa",
|
|
989
|
-
"html",
|
|
990
|
-
"json",
|
|
991
|
-
"json-summary",
|
|
992
|
-
"lcovonly",
|
|
993
|
-
"none",
|
|
994
|
-
"teamcity",
|
|
995
|
-
"text",
|
|
996
|
-
"text-summary"
|
|
997
|
-
],
|
|
998
|
-
"type": "option"
|
|
999
|
-
},
|
|
1000
|
-
"junit": {
|
|
1001
|
-
"helpGroup": "Test",
|
|
1002
|
-
"name": "junit",
|
|
1003
|
-
"summary": "Output JUnit test results.",
|
|
1004
|
-
"allowNo": false,
|
|
1005
|
-
"type": "boolean"
|
|
1006
|
-
},
|
|
1007
|
-
"results-dir": {
|
|
1008
|
-
"helpGroup": "Test",
|
|
1009
|
-
"name": "results-dir",
|
|
1010
|
-
"relationships": [
|
|
1011
|
-
{
|
|
1012
|
-
"type": "some",
|
|
1013
|
-
"flags": [
|
|
1014
|
-
"coverage-formatters",
|
|
1015
|
-
"junit"
|
|
1016
|
-
]
|
|
1017
|
-
}
|
|
1018
|
-
],
|
|
1019
|
-
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
1020
|
-
"hasDynamicHelp": false,
|
|
1021
|
-
"multiple": false,
|
|
1022
|
-
"type": "option"
|
|
1023
1058
|
}
|
|
1024
1059
|
},
|
|
1025
1060
|
"hasDynamicHelp": true,
|
|
1026
1061
|
"hiddenAliases": [],
|
|
1027
|
-
"id": "project:deploy:
|
|
1062
|
+
"id": "project:deploy:cancel",
|
|
1028
1063
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1029
1064
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1030
1065
|
"pluginType": "core",
|
|
1031
1066
|
"strict": true,
|
|
1032
|
-
"summary": "
|
|
1067
|
+
"summary": "Cancel a deploy operation.",
|
|
1033
1068
|
"enableJsonFlag": true,
|
|
1034
|
-
"envVariablesSection": {
|
|
1035
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1036
|
-
"body": [
|
|
1037
|
-
{
|
|
1038
|
-
"name": "SF_USE_PROGRESS_BAR",
|
|
1039
|
-
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1040
|
-
}
|
|
1041
|
-
]
|
|
1042
|
-
},
|
|
1043
|
-
"errorCodes": {
|
|
1044
|
-
"header": "ERROR CODES",
|
|
1045
|
-
"body": [
|
|
1046
|
-
{
|
|
1047
|
-
"name": "Succeeded (0)",
|
|
1048
|
-
"description": "The deploy succeeded."
|
|
1049
|
-
},
|
|
1050
|
-
{
|
|
1051
|
-
"name": "Canceled (1)",
|
|
1052
|
-
"description": "The deploy was canceled."
|
|
1053
|
-
},
|
|
1054
|
-
{
|
|
1055
|
-
"name": "Failed (1)",
|
|
1056
|
-
"description": "The deploy failed."
|
|
1057
|
-
},
|
|
1058
|
-
{
|
|
1059
|
-
"name": "SucceededPartial (68)",
|
|
1060
|
-
"description": "The deploy partially succeeded."
|
|
1061
|
-
},
|
|
1062
|
-
{
|
|
1063
|
-
"name": "InProgress (69)",
|
|
1064
|
-
"description": "The deploy is in progress."
|
|
1065
|
-
},
|
|
1066
|
-
{
|
|
1067
|
-
"name": "Pending (69)",
|
|
1068
|
-
"description": "The deploy is pending."
|
|
1069
|
-
},
|
|
1070
|
-
{
|
|
1071
|
-
"name": "Canceling (69)",
|
|
1072
|
-
"description": "The deploy is being canceled."
|
|
1073
|
-
}
|
|
1074
|
-
]
|
|
1075
|
-
},
|
|
1076
1069
|
"isESM": true,
|
|
1077
1070
|
"relativePath": [
|
|
1078
1071
|
"lib",
|
|
1079
1072
|
"commands",
|
|
1080
1073
|
"project",
|
|
1081
1074
|
"deploy",
|
|
1082
|
-
"
|
|
1075
|
+
"cancel.js"
|
|
1083
1076
|
],
|
|
1084
1077
|
"aliasPermutations": [
|
|
1085
|
-
"deploy:metadata:
|
|
1086
|
-
"metadata:deploy:
|
|
1087
|
-
"metadata:
|
|
1088
|
-
"deploy:
|
|
1089
|
-
"
|
|
1090
|
-
"
|
|
1078
|
+
"deploy:metadata:cancel",
|
|
1079
|
+
"metadata:deploy:cancel",
|
|
1080
|
+
"metadata:cancel:deploy",
|
|
1081
|
+
"deploy:cancel:metadata",
|
|
1082
|
+
"cancel:deploy:metadata",
|
|
1083
|
+
"cancel:metadata:deploy"
|
|
1091
1084
|
],
|
|
1092
1085
|
"permutations": [
|
|
1093
|
-
"project:deploy:
|
|
1094
|
-
"deploy:project:
|
|
1095
|
-
"deploy:
|
|
1096
|
-
"project:
|
|
1097
|
-
"
|
|
1098
|
-
"
|
|
1086
|
+
"project:deploy:cancel",
|
|
1087
|
+
"deploy:project:cancel",
|
|
1088
|
+
"deploy:cancel:project",
|
|
1089
|
+
"project:cancel:deploy",
|
|
1090
|
+
"cancel:project:deploy",
|
|
1091
|
+
"cancel:deploy:project"
|
|
1099
1092
|
]
|
|
1100
1093
|
},
|
|
1101
|
-
"project:deploy:
|
|
1094
|
+
"project:deploy:preview": {
|
|
1102
1095
|
"aliases": [
|
|
1103
|
-
"deploy:metadata"
|
|
1096
|
+
"deploy:metadata:preview"
|
|
1104
1097
|
],
|
|
1105
1098
|
"args": {},
|
|
1106
1099
|
"deprecateAliases": true,
|
|
1107
|
-
"description": "You must run this command from within a project.\n\
|
|
1100
|
+
"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.",
|
|
1108
1101
|
"examples": [
|
|
1109
|
-
"
|
|
1110
|
-
"
|
|
1111
|
-
"
|
|
1112
|
-
"
|
|
1113
|
-
"
|
|
1114
|
-
"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",
|
|
1115
|
-
"Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
|
|
1116
|
-
"Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
|
|
1117
|
-
"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",
|
|
1118
|
-
"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\"",
|
|
1119
|
-
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1120
|
-
"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",
|
|
1121
|
-
"Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
|
|
1122
|
-
"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"
|
|
1102
|
+
"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.",
|
|
1103
|
+
"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",
|
|
1104
|
+
"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",
|
|
1105
|
+
"Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
1106
|
+
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
1123
1107
|
],
|
|
1124
1108
|
"flags": {
|
|
1125
1109
|
"json": {
|
|
@@ -1137,61 +1121,11 @@
|
|
|
1137
1121
|
"multiple": false,
|
|
1138
1122
|
"type": "option"
|
|
1139
1123
|
},
|
|
1140
|
-
"api-version": {
|
|
1141
|
-
"char": "a",
|
|
1142
|
-
"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.",
|
|
1143
|
-
"name": "api-version",
|
|
1144
|
-
"summary": "Target API version for the deploy.",
|
|
1145
|
-
"hasDynamicHelp": false,
|
|
1146
|
-
"multiple": false,
|
|
1147
|
-
"type": "option"
|
|
1148
|
-
},
|
|
1149
|
-
"async": {
|
|
1150
|
-
"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\".",
|
|
1151
|
-
"exclusive": [
|
|
1152
|
-
"wait"
|
|
1153
|
-
],
|
|
1154
|
-
"name": "async",
|
|
1155
|
-
"summary": "Run the command asynchronously.",
|
|
1156
|
-
"allowNo": false,
|
|
1157
|
-
"type": "boolean"
|
|
1158
|
-
},
|
|
1159
|
-
"concise": {
|
|
1160
|
-
"exclusive": [
|
|
1161
|
-
"verbose"
|
|
1162
|
-
],
|
|
1163
|
-
"name": "concise",
|
|
1164
|
-
"summary": "Show concise output of the deploy result.",
|
|
1165
|
-
"allowNo": false,
|
|
1166
|
-
"type": "boolean"
|
|
1167
|
-
},
|
|
1168
|
-
"dry-run": {
|
|
1169
|
-
"name": "dry-run",
|
|
1170
|
-
"summary": "Validate deploy and run Apex tests but don’t save to the org.",
|
|
1171
|
-
"allowNo": false,
|
|
1172
|
-
"type": "boolean"
|
|
1173
|
-
},
|
|
1174
1124
|
"ignore-conflicts": {
|
|
1175
1125
|
"char": "c",
|
|
1176
1126
|
"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.",
|
|
1177
1127
|
"name": "ignore-conflicts",
|
|
1178
|
-
"summary": "
|
|
1179
|
-
"allowNo": false,
|
|
1180
|
-
"type": "boolean"
|
|
1181
|
-
},
|
|
1182
|
-
"ignore-errors": {
|
|
1183
|
-
"char": "r",
|
|
1184
|
-
"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.",
|
|
1185
|
-
"name": "ignore-errors",
|
|
1186
|
-
"summary": "Ignore any errors and don’t roll back deployment.",
|
|
1187
|
-
"allowNo": false,
|
|
1188
|
-
"type": "boolean"
|
|
1189
|
-
},
|
|
1190
|
-
"ignore-warnings": {
|
|
1191
|
-
"char": "g",
|
|
1192
|
-
"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.",
|
|
1193
|
-
"name": "ignore-warnings",
|
|
1194
|
-
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1128
|
+
"summary": "Don't display conflicts in preview of the deployment.",
|
|
1195
1129
|
"allowNo": false,
|
|
1196
1130
|
"type": "boolean"
|
|
1197
1131
|
},
|
|
@@ -1200,12 +1134,10 @@
|
|
|
1200
1134
|
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1201
1135
|
"exclusive": [
|
|
1202
1136
|
"source-dir",
|
|
1203
|
-
"metadata"
|
|
1204
|
-
"metadata-dir"
|
|
1137
|
+
"metadata"
|
|
1205
1138
|
],
|
|
1206
|
-
"helpGroup": "Source Format",
|
|
1207
1139
|
"name": "manifest",
|
|
1208
|
-
"summary": "Full file path for manifest (package.xml) of components to
|
|
1140
|
+
"summary": "Full file path for manifest (package.xml) of components to preview.",
|
|
1209
1141
|
"hasDynamicHelp": false,
|
|
1210
1142
|
"multiple": false,
|
|
1211
1143
|
"type": "option"
|
|
@@ -1214,50 +1146,23 @@
|
|
|
1214
1146
|
"char": "m",
|
|
1215
1147
|
"exclusive": [
|
|
1216
1148
|
"manifest",
|
|
1217
|
-
"source-dir"
|
|
1218
|
-
"metadata-dir"
|
|
1149
|
+
"source-dir"
|
|
1219
1150
|
],
|
|
1220
|
-
"helpGroup": "Source Format",
|
|
1221
1151
|
"name": "metadata",
|
|
1222
|
-
"summary": "Metadata component names to
|
|
1152
|
+
"summary": "Metadata component names to preview.",
|
|
1223
1153
|
"hasDynamicHelp": false,
|
|
1224
1154
|
"multiple": true,
|
|
1225
1155
|
"type": "option"
|
|
1226
1156
|
},
|
|
1227
|
-
"metadata-dir": {
|
|
1228
|
-
"exclusive": [
|
|
1229
|
-
"manifest",
|
|
1230
|
-
"source-dir",
|
|
1231
|
-
"metadata"
|
|
1232
|
-
],
|
|
1233
|
-
"helpGroup": "Metadata API Format",
|
|
1234
|
-
"name": "metadata-dir",
|
|
1235
|
-
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1236
|
-
"hasDynamicHelp": false,
|
|
1237
|
-
"multiple": false,
|
|
1238
|
-
"type": "option"
|
|
1239
|
-
},
|
|
1240
|
-
"single-package": {
|
|
1241
|
-
"dependsOn": [
|
|
1242
|
-
"metadata-dir"
|
|
1243
|
-
],
|
|
1244
|
-
"helpGroup": "Metadata API Format",
|
|
1245
|
-
"name": "single-package",
|
|
1246
|
-
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1247
|
-
"allowNo": false,
|
|
1248
|
-
"type": "boolean"
|
|
1249
|
-
},
|
|
1250
1157
|
"source-dir": {
|
|
1251
1158
|
"char": "d",
|
|
1252
1159
|
"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.",
|
|
1253
1160
|
"exclusive": [
|
|
1254
1161
|
"manifest",
|
|
1255
|
-
"metadata"
|
|
1256
|
-
"metadata-dir"
|
|
1162
|
+
"metadata"
|
|
1257
1163
|
],
|
|
1258
|
-
"helpGroup": "Source Format",
|
|
1259
1164
|
"name": "source-dir",
|
|
1260
|
-
"summary": "Path to the local source files to
|
|
1165
|
+
"summary": "Path to the local source files to preview.",
|
|
1261
1166
|
"hasDynamicHelp": false,
|
|
1262
1167
|
"multiple": true,
|
|
1263
1168
|
"type": "option"
|
|
@@ -1272,136 +1177,148 @@
|
|
|
1272
1177
|
"multiple": false,
|
|
1273
1178
|
"type": "option"
|
|
1274
1179
|
},
|
|
1275
|
-
"
|
|
1276
|
-
"
|
|
1277
|
-
"
|
|
1278
|
-
"
|
|
1279
|
-
"
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1180
|
+
"concise": {
|
|
1181
|
+
"name": "concise",
|
|
1182
|
+
"summary": "Show only the changes that will be deployed; omits files that are forceignored.",
|
|
1183
|
+
"allowNo": false,
|
|
1184
|
+
"type": "boolean"
|
|
1185
|
+
}
|
|
1186
|
+
},
|
|
1187
|
+
"hasDynamicHelp": true,
|
|
1188
|
+
"hiddenAliases": [],
|
|
1189
|
+
"id": "project:deploy:preview",
|
|
1190
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1191
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1192
|
+
"pluginType": "core",
|
|
1193
|
+
"strict": true,
|
|
1194
|
+
"summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
|
|
1195
|
+
"enableJsonFlag": true,
|
|
1196
|
+
"requiresProject": true,
|
|
1197
|
+
"isESM": true,
|
|
1198
|
+
"relativePath": [
|
|
1199
|
+
"lib",
|
|
1200
|
+
"commands",
|
|
1201
|
+
"project",
|
|
1202
|
+
"deploy",
|
|
1203
|
+
"preview.js"
|
|
1204
|
+
],
|
|
1205
|
+
"aliasPermutations": [
|
|
1206
|
+
"deploy:metadata:preview",
|
|
1207
|
+
"metadata:deploy:preview",
|
|
1208
|
+
"metadata:preview:deploy",
|
|
1209
|
+
"deploy:preview:metadata",
|
|
1210
|
+
"preview:deploy:metadata",
|
|
1211
|
+
"preview:metadata:deploy"
|
|
1212
|
+
],
|
|
1213
|
+
"permutations": [
|
|
1214
|
+
"project:deploy:preview",
|
|
1215
|
+
"deploy:project:preview",
|
|
1216
|
+
"deploy:preview:project",
|
|
1217
|
+
"project:preview:deploy",
|
|
1218
|
+
"preview:project:deploy",
|
|
1219
|
+
"preview:deploy:project"
|
|
1220
|
+
]
|
|
1221
|
+
},
|
|
1222
|
+
"project:deploy:quick": {
|
|
1223
|
+
"aliases": [
|
|
1224
|
+
"deploy:metadata:quick"
|
|
1225
|
+
],
|
|
1226
|
+
"args": {},
|
|
1227
|
+
"deprecateAliases": true,
|
|
1228
|
+
"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.",
|
|
1229
|
+
"examples": [
|
|
1230
|
+
"Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1231
|
+
"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"
|
|
1232
|
+
],
|
|
1233
|
+
"flags": {
|
|
1234
|
+
"json": {
|
|
1235
|
+
"description": "Format output as json.",
|
|
1236
|
+
"helpGroup": "GLOBAL",
|
|
1237
|
+
"name": "json",
|
|
1238
|
+
"allowNo": false,
|
|
1239
|
+
"type": "boolean"
|
|
1240
|
+
},
|
|
1241
|
+
"flags-dir": {
|
|
1242
|
+
"helpGroup": "GLOBAL",
|
|
1243
|
+
"name": "flags-dir",
|
|
1244
|
+
"summary": "Import flag values from a directory.",
|
|
1291
1245
|
"hasDynamicHelp": false,
|
|
1292
1246
|
"multiple": false,
|
|
1293
|
-
"options": [
|
|
1294
|
-
"NoTestRun",
|
|
1295
|
-
"RunSpecifiedTests",
|
|
1296
|
-
"RunLocalTests",
|
|
1297
|
-
"RunAllTestsInOrg"
|
|
1298
|
-
],
|
|
1299
1247
|
"type": "option"
|
|
1300
1248
|
},
|
|
1301
|
-
"
|
|
1249
|
+
"async": {
|
|
1250
|
+
"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\".",
|
|
1302
1251
|
"exclusive": [
|
|
1303
|
-
"
|
|
1252
|
+
"wait"
|
|
1304
1253
|
],
|
|
1305
|
-
"name": "
|
|
1306
|
-
"summary": "
|
|
1254
|
+
"name": "async",
|
|
1255
|
+
"summary": "Run the command asynchronously.",
|
|
1307
1256
|
"allowNo": false,
|
|
1308
1257
|
"type": "boolean"
|
|
1309
1258
|
},
|
|
1310
|
-
"
|
|
1311
|
-
"char": "w",
|
|
1312
|
-
"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\".",
|
|
1259
|
+
"concise": {
|
|
1313
1260
|
"exclusive": [
|
|
1314
|
-
"
|
|
1315
|
-
],
|
|
1316
|
-
"name": "wait",
|
|
1317
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1318
|
-
"hasDynamicHelp": true,
|
|
1319
|
-
"helpValue": "<minutes>",
|
|
1320
|
-
"multiple": false,
|
|
1321
|
-
"type": "option"
|
|
1322
|
-
},
|
|
1323
|
-
"purge-on-delete": {
|
|
1324
|
-
"helpGroup": "Delete",
|
|
1325
|
-
"name": "purge-on-delete",
|
|
1326
|
-
"relationships": [
|
|
1327
|
-
{
|
|
1328
|
-
"type": "some",
|
|
1329
|
-
"flags": [
|
|
1330
|
-
"pre-destructive-changes",
|
|
1331
|
-
"manifest",
|
|
1332
|
-
"metadata-dir",
|
|
1333
|
-
"post-destructive-changes"
|
|
1334
|
-
]
|
|
1335
|
-
}
|
|
1261
|
+
"verbose"
|
|
1336
1262
|
],
|
|
1337
|
-
"
|
|
1263
|
+
"name": "concise",
|
|
1264
|
+
"summary": "Show concise output of the deploy result.",
|
|
1338
1265
|
"allowNo": false,
|
|
1339
1266
|
"type": "boolean"
|
|
1340
1267
|
},
|
|
1341
|
-
"
|
|
1342
|
-
"
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
"
|
|
1346
|
-
"name": "pre-destructive-changes",
|
|
1347
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
|
|
1268
|
+
"job-id": {
|
|
1269
|
+
"char": "i",
|
|
1270
|
+
"description": "The job ID is valid for 10 days from when you started the validation.",
|
|
1271
|
+
"name": "job-id",
|
|
1272
|
+
"summary": "Job ID of the deployment you want to quick deploy.",
|
|
1348
1273
|
"hasDynamicHelp": false,
|
|
1349
1274
|
"multiple": false,
|
|
1350
1275
|
"type": "option"
|
|
1351
1276
|
},
|
|
1352
|
-
"
|
|
1353
|
-
"
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
"
|
|
1357
|
-
"
|
|
1358
|
-
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1359
|
-
"hasDynamicHelp": false,
|
|
1277
|
+
"target-org": {
|
|
1278
|
+
"char": "o",
|
|
1279
|
+
"name": "target-org",
|
|
1280
|
+
"noCacheDefault": true,
|
|
1281
|
+
"summary": "Username or alias of the target org.",
|
|
1282
|
+
"hasDynamicHelp": true,
|
|
1360
1283
|
"multiple": false,
|
|
1361
1284
|
"type": "option"
|
|
1362
1285
|
},
|
|
1363
|
-
"
|
|
1364
|
-
"
|
|
1365
|
-
"
|
|
1366
|
-
"name": "
|
|
1367
|
-
"summary": "
|
|
1368
|
-
"
|
|
1369
|
-
"
|
|
1370
|
-
"options": [
|
|
1371
|
-
"clover",
|
|
1372
|
-
"cobertura",
|
|
1373
|
-
"html-spa",
|
|
1374
|
-
"html",
|
|
1375
|
-
"json",
|
|
1376
|
-
"json-summary",
|
|
1377
|
-
"lcovonly",
|
|
1378
|
-
"none",
|
|
1379
|
-
"teamcity",
|
|
1380
|
-
"text",
|
|
1381
|
-
"text-summary"
|
|
1382
|
-
],
|
|
1383
|
-
"type": "option"
|
|
1286
|
+
"use-most-recent": {
|
|
1287
|
+
"char": "r",
|
|
1288
|
+
"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.",
|
|
1289
|
+
"name": "use-most-recent",
|
|
1290
|
+
"summary": "Use the job ID of the most recently validated deployment.",
|
|
1291
|
+
"allowNo": false,
|
|
1292
|
+
"type": "boolean"
|
|
1384
1293
|
},
|
|
1385
|
-
"
|
|
1386
|
-
"
|
|
1387
|
-
|
|
1388
|
-
|
|
1294
|
+
"verbose": {
|
|
1295
|
+
"exclusive": [
|
|
1296
|
+
"concise"
|
|
1297
|
+
],
|
|
1298
|
+
"name": "verbose",
|
|
1299
|
+
"summary": "Show verbose output of the deploy result.",
|
|
1389
1300
|
"allowNo": false,
|
|
1390
1301
|
"type": "boolean"
|
|
1391
1302
|
},
|
|
1392
|
-
"
|
|
1393
|
-
"
|
|
1394
|
-
"
|
|
1395
|
-
"
|
|
1396
|
-
|
|
1397
|
-
"type": "some",
|
|
1398
|
-
"flags": [
|
|
1399
|
-
"coverage-formatters",
|
|
1400
|
-
"junit"
|
|
1401
|
-
]
|
|
1402
|
-
}
|
|
1303
|
+
"wait": {
|
|
1304
|
+
"char": "w",
|
|
1305
|
+
"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\".",
|
|
1306
|
+
"exclusive": [
|
|
1307
|
+
"async"
|
|
1403
1308
|
],
|
|
1404
|
-
"
|
|
1309
|
+
"name": "wait",
|
|
1310
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1311
|
+
"default": "33 minutes",
|
|
1312
|
+
"hasDynamicHelp": true,
|
|
1313
|
+
"helpValue": "<minutes>",
|
|
1314
|
+
"multiple": false,
|
|
1315
|
+
"type": "option"
|
|
1316
|
+
},
|
|
1317
|
+
"api-version": {
|
|
1318
|
+
"char": "a",
|
|
1319
|
+
"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.",
|
|
1320
|
+
"name": "api-version",
|
|
1321
|
+
"summary": "Target API version for the deploy.",
|
|
1405
1322
|
"hasDynamicHelp": false,
|
|
1406
1323
|
"multiple": false,
|
|
1407
1324
|
"type": "option"
|
|
@@ -1409,39 +1326,13 @@
|
|
|
1409
1326
|
},
|
|
1410
1327
|
"hasDynamicHelp": true,
|
|
1411
1328
|
"hiddenAliases": [],
|
|
1412
|
-
"id": "project:deploy:
|
|
1329
|
+
"id": "project:deploy:quick",
|
|
1413
1330
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1414
1331
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1415
1332
|
"pluginType": "core",
|
|
1416
1333
|
"strict": true,
|
|
1417
|
-
"summary": "
|
|
1334
|
+
"summary": "Quickly deploy a validated deployment to an org.",
|
|
1418
1335
|
"enableJsonFlag": true,
|
|
1419
|
-
"configurationVariablesSection": {
|
|
1420
|
-
"header": "CONFIGURATION VARIABLES",
|
|
1421
|
-
"body": [
|
|
1422
|
-
{
|
|
1423
|
-
"name": "target-org",
|
|
1424
|
-
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1425
|
-
},
|
|
1426
|
-
{
|
|
1427
|
-
"name": "org-api-version",
|
|
1428
|
-
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1429
|
-
}
|
|
1430
|
-
]
|
|
1431
|
-
},
|
|
1432
|
-
"envVariablesSection": {
|
|
1433
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1434
|
-
"body": [
|
|
1435
|
-
{
|
|
1436
|
-
"name": "SF_TARGET_ORG",
|
|
1437
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1438
|
-
},
|
|
1439
|
-
{
|
|
1440
|
-
"name": "SF_USE_PROGRESS_BAR",
|
|
1441
|
-
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1442
|
-
}
|
|
1443
|
-
]
|
|
1444
|
-
},
|
|
1445
1336
|
"errorCodes": {
|
|
1446
1337
|
"header": "ERROR CODES",
|
|
1447
1338
|
"body": [
|
|
@@ -1481,34 +1372,36 @@
|
|
|
1481
1372
|
"commands",
|
|
1482
1373
|
"project",
|
|
1483
1374
|
"deploy",
|
|
1484
|
-
"
|
|
1375
|
+
"quick.js"
|
|
1485
1376
|
],
|
|
1486
1377
|
"aliasPermutations": [
|
|
1487
|
-
"deploy:metadata",
|
|
1488
|
-
"metadata:deploy"
|
|
1378
|
+
"deploy:metadata:quick",
|
|
1379
|
+
"metadata:deploy:quick",
|
|
1380
|
+
"metadata:quick:deploy",
|
|
1381
|
+
"deploy:quick:metadata",
|
|
1382
|
+
"quick:deploy:metadata",
|
|
1383
|
+
"quick:metadata:deploy"
|
|
1489
1384
|
],
|
|
1490
1385
|
"permutations": [
|
|
1491
|
-
"project:deploy:
|
|
1492
|
-
"deploy:project:
|
|
1493
|
-
"deploy:
|
|
1494
|
-
"project:
|
|
1495
|
-
"
|
|
1496
|
-
"
|
|
1497
|
-
]
|
|
1386
|
+
"project:deploy:quick",
|
|
1387
|
+
"deploy:project:quick",
|
|
1388
|
+
"deploy:quick:project",
|
|
1389
|
+
"project:quick:deploy",
|
|
1390
|
+
"quick:project:deploy",
|
|
1391
|
+
"quick:deploy:project"
|
|
1392
|
+
]
|
|
1498
1393
|
},
|
|
1499
|
-
"project:deploy:
|
|
1394
|
+
"project:deploy:report": {
|
|
1500
1395
|
"aliases": [
|
|
1501
|
-
"deploy:metadata:
|
|
1396
|
+
"deploy:metadata:report"
|
|
1502
1397
|
],
|
|
1503
1398
|
"args": {},
|
|
1504
1399
|
"deprecateAliases": true,
|
|
1505
|
-
"description": "
|
|
1400
|
+
"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.",
|
|
1506
1401
|
"examples": [
|
|
1507
|
-
"
|
|
1508
|
-
"
|
|
1509
|
-
"
|
|
1510
|
-
"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",
|
|
1511
|
-
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
1402
|
+
"Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1403
|
+
"Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
|
|
1404
|
+
"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"
|
|
1512
1405
|
],
|
|
1513
1406
|
"flags": {
|
|
1514
1407
|
"json": {
|
|
@@ -1526,126 +1419,188 @@
|
|
|
1526
1419
|
"multiple": false,
|
|
1527
1420
|
"type": "option"
|
|
1528
1421
|
},
|
|
1529
|
-
"
|
|
1530
|
-
"char": "
|
|
1531
|
-
"
|
|
1532
|
-
"
|
|
1533
|
-
"summary": "
|
|
1422
|
+
"target-org": {
|
|
1423
|
+
"char": "o",
|
|
1424
|
+
"name": "target-org",
|
|
1425
|
+
"noCacheDefault": true,
|
|
1426
|
+
"summary": "Username or alias of the target org.",
|
|
1427
|
+
"hasDynamicHelp": true,
|
|
1428
|
+
"multiple": false,
|
|
1429
|
+
"type": "option"
|
|
1430
|
+
},
|
|
1431
|
+
"job-id": {
|
|
1432
|
+
"char": "i",
|
|
1433
|
+
"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.",
|
|
1434
|
+
"name": "job-id",
|
|
1435
|
+
"summary": "Job ID of the deploy operation you want to check the status of.",
|
|
1534
1436
|
"hasDynamicHelp": false,
|
|
1535
1437
|
"multiple": false,
|
|
1536
1438
|
"type": "option"
|
|
1537
1439
|
},
|
|
1538
|
-
"
|
|
1539
|
-
"
|
|
1540
|
-
"
|
|
1541
|
-
"
|
|
1440
|
+
"use-most-recent": {
|
|
1441
|
+
"char": "r",
|
|
1442
|
+
"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.",
|
|
1443
|
+
"name": "use-most-recent",
|
|
1444
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1542
1445
|
"allowNo": false,
|
|
1543
1446
|
"type": "boolean"
|
|
1544
1447
|
},
|
|
1545
|
-
"
|
|
1546
|
-
"
|
|
1547
|
-
|
|
1448
|
+
"coverage-formatters": {
|
|
1449
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1450
|
+
"helpGroup": "Test",
|
|
1451
|
+
"name": "coverage-formatters",
|
|
1452
|
+
"summary": "Format of the code coverage results.",
|
|
1453
|
+
"hasDynamicHelp": false,
|
|
1454
|
+
"multiple": true,
|
|
1455
|
+
"options": [
|
|
1456
|
+
"clover",
|
|
1457
|
+
"cobertura",
|
|
1458
|
+
"html-spa",
|
|
1459
|
+
"html",
|
|
1460
|
+
"json",
|
|
1461
|
+
"json-summary",
|
|
1462
|
+
"lcovonly",
|
|
1463
|
+
"none",
|
|
1464
|
+
"teamcity",
|
|
1465
|
+
"text",
|
|
1466
|
+
"text-summary"
|
|
1548
1467
|
],
|
|
1549
|
-
"
|
|
1550
|
-
|
|
1468
|
+
"type": "option"
|
|
1469
|
+
},
|
|
1470
|
+
"junit": {
|
|
1471
|
+
"helpGroup": "Test",
|
|
1472
|
+
"name": "junit",
|
|
1473
|
+
"summary": "Output JUnit test results.",
|
|
1551
1474
|
"allowNo": false,
|
|
1552
1475
|
"type": "boolean"
|
|
1553
1476
|
},
|
|
1554
|
-
"
|
|
1555
|
-
"
|
|
1556
|
-
"
|
|
1557
|
-
"
|
|
1558
|
-
|
|
1559
|
-
|
|
1477
|
+
"results-dir": {
|
|
1478
|
+
"helpGroup": "Test",
|
|
1479
|
+
"name": "results-dir",
|
|
1480
|
+
"relationships": [
|
|
1481
|
+
{
|
|
1482
|
+
"type": "some",
|
|
1483
|
+
"flags": [
|
|
1484
|
+
"coverage-formatters",
|
|
1485
|
+
"junit"
|
|
1486
|
+
]
|
|
1487
|
+
}
|
|
1488
|
+
],
|
|
1489
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
1560
1490
|
"hasDynamicHelp": false,
|
|
1561
1491
|
"multiple": false,
|
|
1562
1492
|
"type": "option"
|
|
1563
1493
|
},
|
|
1564
|
-
"
|
|
1565
|
-
"char": "
|
|
1566
|
-
"
|
|
1567
|
-
"name": "
|
|
1568
|
-
"summary": "
|
|
1569
|
-
"hasDynamicHelp":
|
|
1570
|
-
"
|
|
1571
|
-
"
|
|
1572
|
-
},
|
|
1573
|
-
"source-dir": {
|
|
1574
|
-
"char": "d",
|
|
1575
|
-
"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.",
|
|
1576
|
-
"helpGroup": "Source Format",
|
|
1577
|
-
"name": "source-dir",
|
|
1578
|
-
"summary": "Path to the local source files to validate for deployment.",
|
|
1579
|
-
"hasDynamicHelp": false,
|
|
1580
|
-
"multiple": true,
|
|
1494
|
+
"wait": {
|
|
1495
|
+
"char": "w",
|
|
1496
|
+
"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\".",
|
|
1497
|
+
"name": "wait",
|
|
1498
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1499
|
+
"hasDynamicHelp": true,
|
|
1500
|
+
"helpValue": "<minutes>",
|
|
1501
|
+
"multiple": false,
|
|
1581
1502
|
"type": "option"
|
|
1503
|
+
}
|
|
1504
|
+
},
|
|
1505
|
+
"hasDynamicHelp": true,
|
|
1506
|
+
"hiddenAliases": [],
|
|
1507
|
+
"id": "project:deploy:report",
|
|
1508
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1509
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1510
|
+
"pluginType": "core",
|
|
1511
|
+
"strict": true,
|
|
1512
|
+
"summary": "Check or poll for the status of a deploy operation.",
|
|
1513
|
+
"enableJsonFlag": true,
|
|
1514
|
+
"isESM": true,
|
|
1515
|
+
"relativePath": [
|
|
1516
|
+
"lib",
|
|
1517
|
+
"commands",
|
|
1518
|
+
"project",
|
|
1519
|
+
"deploy",
|
|
1520
|
+
"report.js"
|
|
1521
|
+
],
|
|
1522
|
+
"aliasPermutations": [
|
|
1523
|
+
"deploy:metadata:report",
|
|
1524
|
+
"metadata:deploy:report",
|
|
1525
|
+
"metadata:report:deploy",
|
|
1526
|
+
"deploy:report:metadata",
|
|
1527
|
+
"report:deploy:metadata",
|
|
1528
|
+
"report:metadata:deploy"
|
|
1529
|
+
],
|
|
1530
|
+
"permutations": [
|
|
1531
|
+
"project:deploy:report",
|
|
1532
|
+
"deploy:project:report",
|
|
1533
|
+
"deploy:report:project",
|
|
1534
|
+
"project:report:deploy",
|
|
1535
|
+
"report:project:deploy",
|
|
1536
|
+
"report:deploy:project"
|
|
1537
|
+
]
|
|
1538
|
+
},
|
|
1539
|
+
"project:deploy:resume": {
|
|
1540
|
+
"aliases": [
|
|
1541
|
+
"deploy:metadata:resume"
|
|
1542
|
+
],
|
|
1543
|
+
"args": {},
|
|
1544
|
+
"deprecateAliases": true,
|
|
1545
|
+
"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.",
|
|
1546
|
+
"examples": [
|
|
1547
|
+
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1548
|
+
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1549
|
+
],
|
|
1550
|
+
"flags": {
|
|
1551
|
+
"json": {
|
|
1552
|
+
"description": "Format output as json.",
|
|
1553
|
+
"helpGroup": "GLOBAL",
|
|
1554
|
+
"name": "json",
|
|
1555
|
+
"allowNo": false,
|
|
1556
|
+
"type": "boolean"
|
|
1582
1557
|
},
|
|
1583
|
-
"
|
|
1584
|
-
"helpGroup": "
|
|
1585
|
-
"name": "
|
|
1586
|
-
"summary": "
|
|
1558
|
+
"flags-dir": {
|
|
1559
|
+
"helpGroup": "GLOBAL",
|
|
1560
|
+
"name": "flags-dir",
|
|
1561
|
+
"summary": "Import flag values from a directory.",
|
|
1587
1562
|
"hasDynamicHelp": false,
|
|
1588
1563
|
"multiple": false,
|
|
1589
1564
|
"type": "option"
|
|
1590
1565
|
},
|
|
1591
|
-
"
|
|
1592
|
-
"
|
|
1593
|
-
"
|
|
1566
|
+
"concise": {
|
|
1567
|
+
"exclusive": [
|
|
1568
|
+
"verbose"
|
|
1594
1569
|
],
|
|
1595
|
-
"
|
|
1596
|
-
"
|
|
1597
|
-
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1570
|
+
"name": "concise",
|
|
1571
|
+
"summary": "Show concise output of the deploy operation result.",
|
|
1598
1572
|
"allowNo": false,
|
|
1599
1573
|
"type": "boolean"
|
|
1600
1574
|
},
|
|
1601
|
-
"
|
|
1602
|
-
"char": "
|
|
1603
|
-
"
|
|
1604
|
-
"
|
|
1605
|
-
"
|
|
1606
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1607
|
-
"hasDynamicHelp": true,
|
|
1608
|
-
"multiple": false,
|
|
1609
|
-
"type": "option"
|
|
1610
|
-
},
|
|
1611
|
-
"tests": {
|
|
1612
|
-
"char": "t",
|
|
1613
|
-
"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\"",
|
|
1614
|
-
"helpGroup": "Test",
|
|
1615
|
-
"name": "tests",
|
|
1616
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1617
|
-
"hasDynamicHelp": false,
|
|
1618
|
-
"multiple": true,
|
|
1619
|
-
"type": "option"
|
|
1620
|
-
},
|
|
1621
|
-
"test-level": {
|
|
1622
|
-
"char": "l",
|
|
1623
|
-
"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.",
|
|
1624
|
-
"helpGroup": "Test",
|
|
1625
|
-
"name": "test-level",
|
|
1626
|
-
"summary": "Deployment Apex testing level.",
|
|
1627
|
-
"default": "RunLocalTests",
|
|
1575
|
+
"job-id": {
|
|
1576
|
+
"char": "i",
|
|
1577
|
+
"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.",
|
|
1578
|
+
"name": "job-id",
|
|
1579
|
+
"summary": "Job ID of the deploy operation you want to resume.",
|
|
1628
1580
|
"hasDynamicHelp": false,
|
|
1629
1581
|
"multiple": false,
|
|
1630
|
-
"options": [
|
|
1631
|
-
"RunAllTestsInOrg",
|
|
1632
|
-
"RunLocalTests",
|
|
1633
|
-
"RunSpecifiedTests"
|
|
1634
|
-
],
|
|
1635
1582
|
"type": "option"
|
|
1636
1583
|
},
|
|
1584
|
+
"use-most-recent": {
|
|
1585
|
+
"char": "r",
|
|
1586
|
+
"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.",
|
|
1587
|
+
"name": "use-most-recent",
|
|
1588
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1589
|
+
"allowNo": false,
|
|
1590
|
+
"type": "boolean"
|
|
1591
|
+
},
|
|
1637
1592
|
"verbose": {
|
|
1638
1593
|
"exclusive": [
|
|
1639
1594
|
"concise"
|
|
1640
1595
|
],
|
|
1641
1596
|
"name": "verbose",
|
|
1642
|
-
"summary": "Show verbose output of the
|
|
1597
|
+
"summary": "Show verbose output of the deploy operation result.",
|
|
1643
1598
|
"allowNo": false,
|
|
1644
1599
|
"type": "boolean"
|
|
1645
1600
|
},
|
|
1646
1601
|
"wait": {
|
|
1647
1602
|
"char": "w",
|
|
1648
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you
|
|
1603
|
+
"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\".",
|
|
1649
1604
|
"name": "wait",
|
|
1650
1605
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1651
1606
|
"hasDynamicHelp": true,
|
|
@@ -1653,14 +1608,6 @@
|
|
|
1653
1608
|
"multiple": false,
|
|
1654
1609
|
"type": "option"
|
|
1655
1610
|
},
|
|
1656
|
-
"ignore-warnings": {
|
|
1657
|
-
"char": "g",
|
|
1658
|
-
"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.",
|
|
1659
|
-
"name": "ignore-warnings",
|
|
1660
|
-
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1661
|
-
"allowNo": false,
|
|
1662
|
-
"type": "boolean"
|
|
1663
|
-
},
|
|
1664
1611
|
"coverage-formatters": {
|
|
1665
1612
|
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1666
1613
|
"helpGroup": "Test",
|
|
@@ -1706,78 +1653,20 @@
|
|
|
1706
1653
|
"hasDynamicHelp": false,
|
|
1707
1654
|
"multiple": false,
|
|
1708
1655
|
"type": "option"
|
|
1709
|
-
},
|
|
1710
|
-
"purge-on-delete": {
|
|
1711
|
-
"dependsOn": [
|
|
1712
|
-
"manifest"
|
|
1713
|
-
],
|
|
1714
|
-
"helpGroup": "Delete",
|
|
1715
|
-
"name": "purge-on-delete",
|
|
1716
|
-
"relationships": [
|
|
1717
|
-
{
|
|
1718
|
-
"type": "some",
|
|
1719
|
-
"flags": [
|
|
1720
|
-
"pre-destructive-changes",
|
|
1721
|
-
"post-destructive-changes"
|
|
1722
|
-
]
|
|
1723
|
-
}
|
|
1724
|
-
],
|
|
1725
|
-
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1726
|
-
"allowNo": false,
|
|
1727
|
-
"type": "boolean"
|
|
1728
|
-
},
|
|
1729
|
-
"pre-destructive-changes": {
|
|
1730
|
-
"dependsOn": [
|
|
1731
|
-
"manifest"
|
|
1732
|
-
],
|
|
1733
|
-
"helpGroup": "Delete",
|
|
1734
|
-
"name": "pre-destructive-changes",
|
|
1735
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
1736
|
-
"hasDynamicHelp": false,
|
|
1737
|
-
"multiple": false,
|
|
1738
|
-
"type": "option"
|
|
1739
|
-
},
|
|
1740
|
-
"post-destructive-changes": {
|
|
1741
|
-
"dependsOn": [
|
|
1742
|
-
"manifest"
|
|
1743
|
-
],
|
|
1744
|
-
"helpGroup": "Delete",
|
|
1745
|
-
"name": "post-destructive-changes",
|
|
1746
|
-
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1747
|
-
"hasDynamicHelp": false,
|
|
1748
|
-
"multiple": false,
|
|
1749
|
-
"type": "option"
|
|
1750
1656
|
}
|
|
1751
1657
|
},
|
|
1752
1658
|
"hasDynamicHelp": true,
|
|
1753
1659
|
"hiddenAliases": [],
|
|
1754
|
-
"id": "project:deploy:
|
|
1660
|
+
"id": "project:deploy:resume",
|
|
1755
1661
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1756
1662
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1757
1663
|
"pluginType": "core",
|
|
1758
1664
|
"strict": true,
|
|
1759
|
-
"summary": "
|
|
1665
|
+
"summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
|
|
1760
1666
|
"enableJsonFlag": true,
|
|
1761
|
-
"configurationVariablesSection": {
|
|
1762
|
-
"header": "CONFIGURATION VARIABLES",
|
|
1763
|
-
"body": [
|
|
1764
|
-
{
|
|
1765
|
-
"name": "target-org",
|
|
1766
|
-
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1767
|
-
},
|
|
1768
|
-
{
|
|
1769
|
-
"name": "org-api-version",
|
|
1770
|
-
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1771
|
-
}
|
|
1772
|
-
]
|
|
1773
|
-
},
|
|
1774
1667
|
"envVariablesSection": {
|
|
1775
1668
|
"header": "ENVIRONMENT VARIABLES",
|
|
1776
1669
|
"body": [
|
|
1777
|
-
{
|
|
1778
|
-
"name": "SF_TARGET_ORG",
|
|
1779
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1780
|
-
},
|
|
1781
1670
|
{
|
|
1782
1671
|
"name": "SF_USE_PROGRESS_BAR",
|
|
1783
1672
|
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
@@ -1823,35 +1712,47 @@
|
|
|
1823
1712
|
"commands",
|
|
1824
1713
|
"project",
|
|
1825
1714
|
"deploy",
|
|
1826
|
-
"
|
|
1715
|
+
"resume.js"
|
|
1827
1716
|
],
|
|
1828
1717
|
"aliasPermutations": [
|
|
1829
|
-
"deploy:metadata:
|
|
1830
|
-
"metadata:deploy:
|
|
1831
|
-
"metadata:
|
|
1832
|
-
"deploy:
|
|
1833
|
-
"
|
|
1834
|
-
"
|
|
1718
|
+
"deploy:metadata:resume",
|
|
1719
|
+
"metadata:deploy:resume",
|
|
1720
|
+
"metadata:resume:deploy",
|
|
1721
|
+
"deploy:resume:metadata",
|
|
1722
|
+
"resume:deploy:metadata",
|
|
1723
|
+
"resume:metadata:deploy"
|
|
1835
1724
|
],
|
|
1836
1725
|
"permutations": [
|
|
1837
|
-
"project:deploy:
|
|
1838
|
-
"deploy:project:
|
|
1839
|
-
"deploy:
|
|
1840
|
-
"project:
|
|
1841
|
-
"
|
|
1842
|
-
"
|
|
1726
|
+
"project:deploy:resume",
|
|
1727
|
+
"deploy:project:resume",
|
|
1728
|
+
"deploy:resume:project",
|
|
1729
|
+
"project:resume:deploy",
|
|
1730
|
+
"resume:project:deploy",
|
|
1731
|
+
"resume:deploy:project"
|
|
1843
1732
|
]
|
|
1844
1733
|
},
|
|
1845
|
-
"project:
|
|
1734
|
+
"project:deploy:start": {
|
|
1846
1735
|
"aliases": [
|
|
1847
|
-
"
|
|
1736
|
+
"deploy:metadata"
|
|
1848
1737
|
],
|
|
1849
1738
|
"args": {},
|
|
1850
1739
|
"deprecateAliases": true,
|
|
1851
|
-
"description": "
|
|
1740
|
+
"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.",
|
|
1852
1741
|
"examples": [
|
|
1853
|
-
"
|
|
1854
|
-
"
|
|
1742
|
+
"Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1743
|
+
"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",
|
|
1744
|
+
"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",
|
|
1745
|
+
"Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
1746
|
+
"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",
|
|
1747
|
+
"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",
|
|
1748
|
+
"Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
|
|
1749
|
+
"Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
|
|
1750
|
+
"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",
|
|
1751
|
+
"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\"",
|
|
1752
|
+
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1753
|
+
"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",
|
|
1754
|
+
"Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
|
|
1755
|
+
"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"
|
|
1855
1756
|
],
|
|
1856
1757
|
"flags": {
|
|
1857
1758
|
"json": {
|
|
@@ -1870,397 +1771,377 @@
|
|
|
1870
1771
|
"type": "option"
|
|
1871
1772
|
},
|
|
1872
1773
|
"api-version": {
|
|
1873
|
-
"
|
|
1874
|
-
|
|
1875
|
-
],
|
|
1876
|
-
"deprecateAliases": true,
|
|
1877
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1774
|
+
"char": "a",
|
|
1775
|
+
"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.",
|
|
1878
1776
|
"name": "api-version",
|
|
1777
|
+
"summary": "Target API version for the deploy.",
|
|
1879
1778
|
"hasDynamicHelp": false,
|
|
1880
1779
|
"multiple": false,
|
|
1881
1780
|
"type": "option"
|
|
1882
1781
|
},
|
|
1883
|
-
"
|
|
1884
|
-
"
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
"name": "
|
|
1889
|
-
"
|
|
1890
|
-
"
|
|
1891
|
-
"type": "
|
|
1782
|
+
"async": {
|
|
1783
|
+
"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\".",
|
|
1784
|
+
"exclusive": [
|
|
1785
|
+
"wait"
|
|
1786
|
+
],
|
|
1787
|
+
"name": "async",
|
|
1788
|
+
"summary": "Run the command asynchronously.",
|
|
1789
|
+
"allowNo": false,
|
|
1790
|
+
"type": "boolean"
|
|
1892
1791
|
},
|
|
1893
|
-
"
|
|
1894
|
-
"
|
|
1895
|
-
"
|
|
1792
|
+
"concise": {
|
|
1793
|
+
"exclusive": [
|
|
1794
|
+
"verbose"
|
|
1896
1795
|
],
|
|
1796
|
+
"name": "concise",
|
|
1797
|
+
"summary": "Show concise output of the deploy result.",
|
|
1798
|
+
"allowNo": false,
|
|
1799
|
+
"type": "boolean"
|
|
1800
|
+
},
|
|
1801
|
+
"dry-run": {
|
|
1802
|
+
"name": "dry-run",
|
|
1803
|
+
"summary": "Validate deploy and run Apex tests but don’t save to the org.",
|
|
1804
|
+
"allowNo": false,
|
|
1805
|
+
"type": "boolean"
|
|
1806
|
+
},
|
|
1807
|
+
"ignore-conflicts": {
|
|
1808
|
+
"char": "c",
|
|
1809
|
+
"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.",
|
|
1810
|
+
"name": "ignore-conflicts",
|
|
1811
|
+
"summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
|
|
1812
|
+
"allowNo": false,
|
|
1813
|
+
"type": "boolean"
|
|
1814
|
+
},
|
|
1815
|
+
"ignore-errors": {
|
|
1897
1816
|
"char": "r",
|
|
1898
|
-
"
|
|
1899
|
-
"name": "
|
|
1900
|
-
"
|
|
1901
|
-
"
|
|
1902
|
-
"
|
|
1903
|
-
"multiple": false,
|
|
1904
|
-
"type": "option"
|
|
1817
|
+
"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.",
|
|
1818
|
+
"name": "ignore-errors",
|
|
1819
|
+
"summary": "Ignore any errors and don’t roll back deployment.",
|
|
1820
|
+
"allowNo": false,
|
|
1821
|
+
"type": "boolean"
|
|
1905
1822
|
},
|
|
1906
|
-
"
|
|
1907
|
-
"
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
"
|
|
1911
|
-
"
|
|
1912
|
-
"
|
|
1913
|
-
"summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
|
|
1914
|
-
"hasDynamicHelp": false,
|
|
1915
|
-
"multiple": false,
|
|
1916
|
-
"type": "option"
|
|
1823
|
+
"ignore-warnings": {
|
|
1824
|
+
"char": "g",
|
|
1825
|
+
"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.",
|
|
1826
|
+
"name": "ignore-warnings",
|
|
1827
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1828
|
+
"allowNo": false,
|
|
1829
|
+
"type": "boolean"
|
|
1917
1830
|
},
|
|
1918
1831
|
"manifest": {
|
|
1919
1832
|
"char": "x",
|
|
1920
|
-
"description": "If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1833
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1834
|
+
"exclusive": [
|
|
1835
|
+
"source-dir",
|
|
1836
|
+
"metadata",
|
|
1837
|
+
"metadata-dir"
|
|
1838
|
+
],
|
|
1839
|
+
"helpGroup": "Source Format",
|
|
1921
1840
|
"name": "manifest",
|
|
1922
|
-
"summary": "
|
|
1841
|
+
"summary": "Full file path for manifest (package.xml) of components to deploy.",
|
|
1923
1842
|
"hasDynamicHelp": false,
|
|
1924
1843
|
"multiple": false,
|
|
1925
1844
|
"type": "option"
|
|
1926
1845
|
},
|
|
1927
|
-
"metadata
|
|
1928
|
-
"
|
|
1929
|
-
|
|
1846
|
+
"metadata": {
|
|
1847
|
+
"char": "m",
|
|
1848
|
+
"exclusive": [
|
|
1849
|
+
"manifest",
|
|
1850
|
+
"source-dir",
|
|
1851
|
+
"metadata-dir"
|
|
1930
1852
|
],
|
|
1931
|
-
"
|
|
1932
|
-
"
|
|
1933
|
-
"
|
|
1853
|
+
"helpGroup": "Source Format",
|
|
1854
|
+
"name": "metadata",
|
|
1855
|
+
"summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
|
|
1856
|
+
"hasDynamicHelp": false,
|
|
1857
|
+
"multiple": true,
|
|
1858
|
+
"type": "option"
|
|
1859
|
+
},
|
|
1860
|
+
"metadata-dir": {
|
|
1934
1861
|
"exclusive": [
|
|
1935
1862
|
"manifest",
|
|
1863
|
+
"source-dir",
|
|
1936
1864
|
"metadata"
|
|
1937
1865
|
],
|
|
1866
|
+
"helpGroup": "Metadata API Format",
|
|
1938
1867
|
"name": "metadata-dir",
|
|
1939
|
-
"summary": "Root of directory or zip file of metadata formatted files to
|
|
1940
|
-
"delimiter": ",",
|
|
1868
|
+
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1941
1869
|
"hasDynamicHelp": false,
|
|
1942
|
-
"multiple":
|
|
1870
|
+
"multiple": false,
|
|
1943
1871
|
"type": "option"
|
|
1944
1872
|
},
|
|
1945
|
-
"
|
|
1946
|
-
"
|
|
1873
|
+
"single-package": {
|
|
1874
|
+
"dependsOn": [
|
|
1875
|
+
"metadata-dir"
|
|
1876
|
+
],
|
|
1877
|
+
"helpGroup": "Metadata API Format",
|
|
1878
|
+
"name": "single-package",
|
|
1879
|
+
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1880
|
+
"allowNo": false,
|
|
1881
|
+
"type": "boolean"
|
|
1882
|
+
},
|
|
1883
|
+
"source-dir": {
|
|
1884
|
+
"char": "d",
|
|
1885
|
+
"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.",
|
|
1947
1886
|
"exclusive": [
|
|
1948
1887
|
"manifest",
|
|
1949
|
-
"
|
|
1888
|
+
"metadata",
|
|
1889
|
+
"metadata-dir"
|
|
1950
1890
|
],
|
|
1951
|
-
"
|
|
1952
|
-
"
|
|
1953
|
-
"
|
|
1891
|
+
"helpGroup": "Source Format",
|
|
1892
|
+
"name": "source-dir",
|
|
1893
|
+
"summary": "Path to the local source files to deploy.",
|
|
1954
1894
|
"hasDynamicHelp": false,
|
|
1955
1895
|
"multiple": true,
|
|
1956
1896
|
"type": "option"
|
|
1957
|
-
}
|
|
1958
|
-
},
|
|
1959
|
-
"hasDynamicHelp": false,
|
|
1960
|
-
"hiddenAliases": [],
|
|
1961
|
-
"id": "project:convert:mdapi",
|
|
1962
|
-
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1963
|
-
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1964
|
-
"pluginType": "core",
|
|
1965
|
-
"strict": true,
|
|
1966
|
-
"summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
|
|
1967
|
-
"enableJsonFlag": true,
|
|
1968
|
-
"requiresProject": true,
|
|
1969
|
-
"isESM": true,
|
|
1970
|
-
"relativePath": [
|
|
1971
|
-
"lib",
|
|
1972
|
-
"commands",
|
|
1973
|
-
"project",
|
|
1974
|
-
"convert",
|
|
1975
|
-
"mdapi.js"
|
|
1976
|
-
],
|
|
1977
|
-
"aliasPermutations": [
|
|
1978
|
-
"force:mdapi:convert",
|
|
1979
|
-
"mdapi:force:convert",
|
|
1980
|
-
"mdapi:convert:force",
|
|
1981
|
-
"force:convert:mdapi",
|
|
1982
|
-
"convert:force:mdapi",
|
|
1983
|
-
"convert:mdapi:force"
|
|
1984
|
-
],
|
|
1985
|
-
"permutations": [
|
|
1986
|
-
"project:convert:mdapi",
|
|
1987
|
-
"convert:project:mdapi",
|
|
1988
|
-
"convert:mdapi:project",
|
|
1989
|
-
"project:mdapi:convert",
|
|
1990
|
-
"mdapi:project:convert",
|
|
1991
|
-
"mdapi:convert:project"
|
|
1992
|
-
]
|
|
1993
|
-
},
|
|
1994
|
-
"project:convert:source-behavior": {
|
|
1995
|
-
"aliases": [],
|
|
1996
|
-
"args": {},
|
|
1997
|
-
"description": "Specifically, this command updates the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file and then converts the associated local source files in your project as needed.\n\nFor example, run this command with the \"--behavior decomposePermissionSetBeta\" flag to start decomposing permission sets when you deploy or retrieve them. Decomposing means breaking up the monolithic metadata API format XML file that corresponds to a metadata component into smaller XML files and directories based on its subtypes. Permission sets are not decomposed by default; you must opt-in to start decomposing them by using this command. When the command finishes, your \"sfdx-project.json\" file is updated to always decompose permission sets, and the existing permission set files in your local package directories are converted into the new decomposed format. You run this command only once for a given behavior change.\n\nFor more information about the possible values for the --behavior flag, see the \"sourceBehaviorOptions\" section in the https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.",
|
|
1998
|
-
"examples": [
|
|
1999
|
-
"Update your Salesforce DX project to decompose custom permission sets:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta",
|
|
2000
|
-
"Display what the command would do, but don't change any existing files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run",
|
|
2001
|
-
"Keep the temporary directory that contains the interim metadata API formatted files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir"
|
|
2002
|
-
],
|
|
2003
|
-
"flags": {
|
|
2004
|
-
"json": {
|
|
2005
|
-
"description": "Format output as json.",
|
|
2006
|
-
"helpGroup": "GLOBAL",
|
|
2007
|
-
"name": "json",
|
|
2008
|
-
"allowNo": false,
|
|
2009
|
-
"type": "boolean"
|
|
2010
|
-
},
|
|
2011
|
-
"flags-dir": {
|
|
2012
|
-
"helpGroup": "GLOBAL",
|
|
2013
|
-
"name": "flags-dir",
|
|
2014
|
-
"summary": "Import flag values from a directory.",
|
|
2015
|
-
"hasDynamicHelp": false,
|
|
2016
|
-
"multiple": false,
|
|
2017
|
-
"type": "option"
|
|
2018
|
-
},
|
|
2019
|
-
"behavior": {
|
|
2020
|
-
"char": "b",
|
|
2021
|
-
"name": "behavior",
|
|
2022
|
-
"required": true,
|
|
2023
|
-
"summary": "Behavior to enable; the values correspond to the possible values of the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file.",
|
|
2024
|
-
"hasDynamicHelp": false,
|
|
2025
|
-
"multiple": false,
|
|
2026
|
-
"options": [
|
|
2027
|
-
"decomposeCustomLabelsBeta2",
|
|
2028
|
-
"decomposeCustomLabelsBeta",
|
|
2029
|
-
"decomposePermissionSetBeta",
|
|
2030
|
-
"decomposePermissionSetBeta2",
|
|
2031
|
-
"decomposeSharingRulesBeta",
|
|
2032
|
-
"decomposeWorkflowBeta",
|
|
2033
|
-
"decomposeExternalServiceRegistrationBeta"
|
|
2034
|
-
],
|
|
2035
|
-
"type": "option"
|
|
2036
|
-
},
|
|
2037
|
-
"dry-run": {
|
|
2038
|
-
"name": "dry-run",
|
|
2039
|
-
"summary": "Display what the command would do, but don't make any actual changes.",
|
|
2040
|
-
"allowNo": false,
|
|
2041
|
-
"type": "boolean"
|
|
2042
|
-
},
|
|
2043
|
-
"preserve-temp-dir": {
|
|
2044
|
-
"name": "preserve-temp-dir",
|
|
2045
|
-
"summary": "Don't delete the metadata API format temporary directory that this command creates. Useful for debugging.",
|
|
2046
|
-
"allowNo": false,
|
|
2047
|
-
"type": "boolean"
|
|
2048
1897
|
},
|
|
2049
1898
|
"target-org": {
|
|
2050
1899
|
"char": "o",
|
|
2051
1900
|
"name": "target-org",
|
|
2052
1901
|
"noCacheDefault": true,
|
|
2053
|
-
"
|
|
1902
|
+
"required": true,
|
|
1903
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2054
1904
|
"hasDynamicHelp": true,
|
|
2055
1905
|
"multiple": false,
|
|
2056
1906
|
"type": "option"
|
|
2057
|
-
}
|
|
2058
|
-
},
|
|
2059
|
-
"hasDynamicHelp": true,
|
|
2060
|
-
"hiddenAliases": [],
|
|
2061
|
-
"id": "project:convert:source-behavior",
|
|
2062
|
-
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2063
|
-
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2064
|
-
"pluginType": "core",
|
|
2065
|
-
"state": "beta",
|
|
2066
|
-
"strict": true,
|
|
2067
|
-
"summary": "Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.",
|
|
2068
|
-
"enableJsonFlag": true,
|
|
2069
|
-
"requiresProject": true,
|
|
2070
|
-
"isESM": true,
|
|
2071
|
-
"relativePath": [
|
|
2072
|
-
"lib",
|
|
2073
|
-
"commands",
|
|
2074
|
-
"project",
|
|
2075
|
-
"convert",
|
|
2076
|
-
"source-behavior.js"
|
|
2077
|
-
],
|
|
2078
|
-
"aliasPermutations": [],
|
|
2079
|
-
"permutations": [
|
|
2080
|
-
"project:convert:source-behavior",
|
|
2081
|
-
"convert:project:source-behavior",
|
|
2082
|
-
"convert:source-behavior:project",
|
|
2083
|
-
"project:source-behavior:convert",
|
|
2084
|
-
"source-behavior:project:convert",
|
|
2085
|
-
"source-behavior:convert:project"
|
|
2086
|
-
]
|
|
2087
|
-
},
|
|
2088
|
-
"project:convert:source": {
|
|
2089
|
-
"aliases": [
|
|
2090
|
-
"force:source:convert"
|
|
2091
|
-
],
|
|
2092
|
-
"args": {},
|
|
2093
|
-
"deprecateAliases": true,
|
|
2094
|
-
"description": "To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using \"<%= config.bin %> project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"<%= config.bin %> project convert mdapi\".\n\nTo specify a package name that includes spaces, enclose the name in single quotes.\n\nTo convert multiple 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.",
|
|
2095
|
-
"examples": [
|
|
2096
|
-
"Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source",
|
|
2097
|
-
"Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'"
|
|
2098
|
-
],
|
|
2099
|
-
"flags": {
|
|
2100
|
-
"json": {
|
|
2101
|
-
"description": "Format output as json.",
|
|
2102
|
-
"helpGroup": "GLOBAL",
|
|
2103
|
-
"name": "json",
|
|
2104
|
-
"allowNo": false,
|
|
2105
|
-
"type": "boolean"
|
|
2106
|
-
},
|
|
2107
|
-
"flags-dir": {
|
|
2108
|
-
"helpGroup": "GLOBAL",
|
|
2109
|
-
"name": "flags-dir",
|
|
2110
|
-
"summary": "Import flag values from a directory.",
|
|
2111
|
-
"hasDynamicHelp": false,
|
|
2112
|
-
"multiple": false,
|
|
2113
|
-
"type": "option"
|
|
2114
1907
|
},
|
|
2115
|
-
"
|
|
2116
|
-
"
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
"
|
|
2120
|
-
"
|
|
2121
|
-
"name": "api-version",
|
|
2122
|
-
"summary": "API Version to use in the generated project's manifest. By default, will use the version from sfdx-project.json",
|
|
1908
|
+
"tests": {
|
|
1909
|
+
"char": "t",
|
|
1910
|
+
"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\"",
|
|
1911
|
+
"helpGroup": "Test",
|
|
1912
|
+
"name": "tests",
|
|
1913
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2123
1914
|
"hasDynamicHelp": false,
|
|
2124
|
-
"multiple":
|
|
1915
|
+
"multiple": true,
|
|
2125
1916
|
"type": "option"
|
|
2126
1917
|
},
|
|
2127
|
-
"
|
|
2128
|
-
"
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
"
|
|
2132
|
-
"
|
|
1918
|
+
"test-level": {
|
|
1919
|
+
"char": "l",
|
|
1920
|
+
"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\".",
|
|
1921
|
+
"helpGroup": "Test",
|
|
1922
|
+
"name": "test-level",
|
|
1923
|
+
"summary": "Deployment Apex testing level.",
|
|
2133
1924
|
"hasDynamicHelp": false,
|
|
2134
1925
|
"multiple": false,
|
|
1926
|
+
"options": [
|
|
1927
|
+
"NoTestRun",
|
|
1928
|
+
"RunSpecifiedTests",
|
|
1929
|
+
"RunLocalTests",
|
|
1930
|
+
"RunAllTestsInOrg"
|
|
1931
|
+
],
|
|
2135
1932
|
"type": "option"
|
|
2136
1933
|
},
|
|
2137
|
-
"
|
|
2138
|
-
"
|
|
2139
|
-
"
|
|
1934
|
+
"verbose": {
|
|
1935
|
+
"exclusive": [
|
|
1936
|
+
"concise"
|
|
2140
1937
|
],
|
|
2141
|
-
"
|
|
2142
|
-
"
|
|
2143
|
-
"
|
|
2144
|
-
"
|
|
2145
|
-
"hasDynamicHelp": false,
|
|
2146
|
-
"multiple": false,
|
|
2147
|
-
"type": "option"
|
|
1938
|
+
"name": "verbose",
|
|
1939
|
+
"summary": "Show verbose output of the deploy result.",
|
|
1940
|
+
"allowNo": false,
|
|
1941
|
+
"type": "boolean"
|
|
2148
1942
|
},
|
|
2149
|
-
"
|
|
2150
|
-
"
|
|
2151
|
-
|
|
1943
|
+
"wait": {
|
|
1944
|
+
"char": "w",
|
|
1945
|
+
"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\".",
|
|
1946
|
+
"exclusive": [
|
|
1947
|
+
"async"
|
|
2152
1948
|
],
|
|
2153
|
-
"
|
|
2154
|
-
"
|
|
2155
|
-
"name": "output-dir",
|
|
2156
|
-
"summary": "Output directory to store the Metadata API–formatted files in.",
|
|
2157
|
-
"default": "metadataPackage_>timestamp<",
|
|
1949
|
+
"name": "wait",
|
|
1950
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2158
1951
|
"hasDynamicHelp": true,
|
|
1952
|
+
"helpValue": "<minutes>",
|
|
2159
1953
|
"multiple": false,
|
|
2160
1954
|
"type": "option"
|
|
2161
1955
|
},
|
|
2162
|
-
"
|
|
2163
|
-
"
|
|
2164
|
-
|
|
1956
|
+
"purge-on-delete": {
|
|
1957
|
+
"helpGroup": "Delete",
|
|
1958
|
+
"name": "purge-on-delete",
|
|
1959
|
+
"relationships": [
|
|
1960
|
+
{
|
|
1961
|
+
"type": "some",
|
|
1962
|
+
"flags": [
|
|
1963
|
+
"pre-destructive-changes",
|
|
1964
|
+
"manifest",
|
|
1965
|
+
"metadata-dir",
|
|
1966
|
+
"post-destructive-changes"
|
|
1967
|
+
]
|
|
1968
|
+
}
|
|
2165
1969
|
],
|
|
2166
|
-
"
|
|
2167
|
-
"
|
|
2168
|
-
"
|
|
2169
|
-
"summary": "Name of the package to associate with the metadata-formatted files.",
|
|
2170
|
-
"hasDynamicHelp": false,
|
|
2171
|
-
"multiple": false,
|
|
2172
|
-
"type": "option"
|
|
1970
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1971
|
+
"allowNo": false,
|
|
1972
|
+
"type": "boolean"
|
|
2173
1973
|
},
|
|
2174
|
-
"
|
|
2175
|
-
"
|
|
2176
|
-
|
|
2177
|
-
|
|
2178
|
-
"
|
|
1974
|
+
"pre-destructive-changes": {
|
|
1975
|
+
"dependsOn": [
|
|
1976
|
+
"manifest"
|
|
1977
|
+
],
|
|
1978
|
+
"helpGroup": "Delete",
|
|
1979
|
+
"name": "pre-destructive-changes",
|
|
1980
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
|
|
2179
1981
|
"hasDynamicHelp": false,
|
|
2180
1982
|
"multiple": false,
|
|
2181
1983
|
"type": "option"
|
|
2182
1984
|
},
|
|
2183
|
-
"
|
|
2184
|
-
"
|
|
2185
|
-
"
|
|
2186
|
-
],
|
|
2187
|
-
"char": "p",
|
|
2188
|
-
"deprecateAliases": true,
|
|
2189
|
-
"description": "The supplied paths 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 sub-directories).\n\nIf you specify this flag, don’t specify --manifest or --metadata.",
|
|
2190
|
-
"exclusive": [
|
|
2191
|
-
"manifest",
|
|
2192
|
-
"metadata"
|
|
1985
|
+
"post-destructive-changes": {
|
|
1986
|
+
"dependsOn": [
|
|
1987
|
+
"manifest"
|
|
2193
1988
|
],
|
|
2194
|
-
"
|
|
2195
|
-
"
|
|
2196
|
-
"
|
|
1989
|
+
"helpGroup": "Delete",
|
|
1990
|
+
"name": "post-destructive-changes",
|
|
1991
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1992
|
+
"hasDynamicHelp": false,
|
|
1993
|
+
"multiple": false,
|
|
1994
|
+
"type": "option"
|
|
1995
|
+
},
|
|
1996
|
+
"coverage-formatters": {
|
|
1997
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1998
|
+
"helpGroup": "Test",
|
|
1999
|
+
"name": "coverage-formatters",
|
|
2000
|
+
"summary": "Format of the code coverage results.",
|
|
2197
2001
|
"hasDynamicHelp": false,
|
|
2198
2002
|
"multiple": true,
|
|
2003
|
+
"options": [
|
|
2004
|
+
"clover",
|
|
2005
|
+
"cobertura",
|
|
2006
|
+
"html-spa",
|
|
2007
|
+
"html",
|
|
2008
|
+
"json",
|
|
2009
|
+
"json-summary",
|
|
2010
|
+
"lcovonly",
|
|
2011
|
+
"none",
|
|
2012
|
+
"teamcity",
|
|
2013
|
+
"text",
|
|
2014
|
+
"text-summary"
|
|
2015
|
+
],
|
|
2199
2016
|
"type": "option"
|
|
2200
2017
|
},
|
|
2201
|
-
"
|
|
2202
|
-
"
|
|
2203
|
-
"
|
|
2204
|
-
|
|
2205
|
-
|
|
2018
|
+
"junit": {
|
|
2019
|
+
"helpGroup": "Test",
|
|
2020
|
+
"name": "junit",
|
|
2021
|
+
"summary": "Output JUnit test results.",
|
|
2022
|
+
"allowNo": false,
|
|
2023
|
+
"type": "boolean"
|
|
2024
|
+
},
|
|
2025
|
+
"results-dir": {
|
|
2026
|
+
"helpGroup": "Test",
|
|
2027
|
+
"name": "results-dir",
|
|
2028
|
+
"relationships": [
|
|
2029
|
+
{
|
|
2030
|
+
"type": "some",
|
|
2031
|
+
"flags": [
|
|
2032
|
+
"coverage-formatters",
|
|
2033
|
+
"junit"
|
|
2034
|
+
]
|
|
2035
|
+
}
|
|
2206
2036
|
],
|
|
2207
|
-
"
|
|
2208
|
-
"summary": "Metadata component names to convert.",
|
|
2209
|
-
"delimiter": ",",
|
|
2037
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
2210
2038
|
"hasDynamicHelp": false,
|
|
2211
|
-
"multiple":
|
|
2039
|
+
"multiple": false,
|
|
2212
2040
|
"type": "option"
|
|
2213
2041
|
}
|
|
2214
2042
|
},
|
|
2215
2043
|
"hasDynamicHelp": true,
|
|
2216
2044
|
"hiddenAliases": [],
|
|
2217
|
-
"id": "project:
|
|
2045
|
+
"id": "project:deploy:start",
|
|
2218
2046
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2219
2047
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2220
2048
|
"pluginType": "core",
|
|
2221
2049
|
"strict": true,
|
|
2222
|
-
"summary": "
|
|
2050
|
+
"summary": "Deploy metadata to an org from your local project.",
|
|
2223
2051
|
"enableJsonFlag": true,
|
|
2224
|
-
"
|
|
2052
|
+
"configurationVariablesSection": {
|
|
2053
|
+
"header": "CONFIGURATION VARIABLES",
|
|
2054
|
+
"body": [
|
|
2055
|
+
{
|
|
2056
|
+
"name": "target-org",
|
|
2057
|
+
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
2058
|
+
},
|
|
2059
|
+
{
|
|
2060
|
+
"name": "org-api-version",
|
|
2061
|
+
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
2062
|
+
}
|
|
2063
|
+
]
|
|
2064
|
+
},
|
|
2065
|
+
"envVariablesSection": {
|
|
2066
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2067
|
+
"body": [
|
|
2068
|
+
{
|
|
2069
|
+
"name": "SF_TARGET_ORG",
|
|
2070
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2071
|
+
},
|
|
2072
|
+
{
|
|
2073
|
+
"name": "SF_USE_PROGRESS_BAR",
|
|
2074
|
+
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
2075
|
+
}
|
|
2076
|
+
]
|
|
2077
|
+
},
|
|
2078
|
+
"errorCodes": {
|
|
2079
|
+
"header": "ERROR CODES",
|
|
2080
|
+
"body": [
|
|
2081
|
+
{
|
|
2082
|
+
"name": "Succeeded (0)",
|
|
2083
|
+
"description": "The deploy succeeded."
|
|
2084
|
+
},
|
|
2085
|
+
{
|
|
2086
|
+
"name": "Canceled (1)",
|
|
2087
|
+
"description": "The deploy was canceled."
|
|
2088
|
+
},
|
|
2089
|
+
{
|
|
2090
|
+
"name": "Failed (1)",
|
|
2091
|
+
"description": "The deploy failed."
|
|
2092
|
+
},
|
|
2093
|
+
{
|
|
2094
|
+
"name": "SucceededPartial (68)",
|
|
2095
|
+
"description": "The deploy partially succeeded."
|
|
2096
|
+
},
|
|
2097
|
+
{
|
|
2098
|
+
"name": "InProgress (69)",
|
|
2099
|
+
"description": "The deploy is in progress."
|
|
2100
|
+
},
|
|
2101
|
+
{
|
|
2102
|
+
"name": "Pending (69)",
|
|
2103
|
+
"description": "The deploy is pending."
|
|
2104
|
+
},
|
|
2105
|
+
{
|
|
2106
|
+
"name": "Canceling (69)",
|
|
2107
|
+
"description": "The deploy is being canceled."
|
|
2108
|
+
}
|
|
2109
|
+
]
|
|
2110
|
+
},
|
|
2225
2111
|
"isESM": true,
|
|
2226
2112
|
"relativePath": [
|
|
2227
2113
|
"lib",
|
|
2228
2114
|
"commands",
|
|
2229
2115
|
"project",
|
|
2230
|
-
"
|
|
2231
|
-
"
|
|
2116
|
+
"deploy",
|
|
2117
|
+
"start.js"
|
|
2232
2118
|
],
|
|
2233
2119
|
"aliasPermutations": [
|
|
2234
|
-
"
|
|
2235
|
-
"
|
|
2236
|
-
"source:convert:force",
|
|
2237
|
-
"force:convert:source",
|
|
2238
|
-
"convert:force:source",
|
|
2239
|
-
"convert:source:force"
|
|
2120
|
+
"deploy:metadata",
|
|
2121
|
+
"metadata:deploy"
|
|
2240
2122
|
],
|
|
2241
2123
|
"permutations": [
|
|
2242
|
-
"project:
|
|
2243
|
-
"
|
|
2244
|
-
"
|
|
2245
|
-
"project:
|
|
2246
|
-
"
|
|
2247
|
-
"
|
|
2124
|
+
"project:deploy:start",
|
|
2125
|
+
"deploy:project:start",
|
|
2126
|
+
"deploy:start:project",
|
|
2127
|
+
"project:start:deploy",
|
|
2128
|
+
"start:project:deploy",
|
|
2129
|
+
"start:deploy:project"
|
|
2248
2130
|
]
|
|
2249
2131
|
},
|
|
2250
|
-
"project:
|
|
2132
|
+
"project:deploy:validate": {
|
|
2251
2133
|
"aliases": [
|
|
2252
|
-
"
|
|
2134
|
+
"deploy:metadata:validate"
|
|
2253
2135
|
],
|
|
2254
2136
|
"args": {},
|
|
2255
2137
|
"deprecateAliases": true,
|
|
2256
|
-
"description": "
|
|
2138
|
+
"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.",
|
|
2257
2139
|
"examples": [
|
|
2258
|
-
"
|
|
2259
|
-
"
|
|
2260
|
-
"
|
|
2261
|
-
"
|
|
2262
|
-
"
|
|
2263
|
-
"Create a manifest from all metadata components in an org excluding specific metadata types:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --excluded-metadata StandardValueSet"
|
|
2140
|
+
"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.",
|
|
2141
|
+
"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",
|
|
2142
|
+
"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",
|
|
2143
|
+
"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",
|
|
2144
|
+
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
2264
2145
|
],
|
|
2265
2146
|
"flags": {
|
|
2266
2147
|
"json": {
|
|
@@ -2279,200 +2160,319 @@
|
|
|
2279
2160
|
"type": "option"
|
|
2280
2161
|
},
|
|
2281
2162
|
"api-version": {
|
|
2282
|
-
"
|
|
2283
|
-
|
|
2284
|
-
],
|
|
2285
|
-
"deprecateAliases": true,
|
|
2286
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2163
|
+
"char": "a",
|
|
2164
|
+
"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.",
|
|
2287
2165
|
"name": "api-version",
|
|
2166
|
+
"summary": "Target API version for the validation.",
|
|
2288
2167
|
"hasDynamicHelp": false,
|
|
2289
2168
|
"multiple": false,
|
|
2290
2169
|
"type": "option"
|
|
2291
2170
|
},
|
|
2292
|
-
"
|
|
2293
|
-
"
|
|
2294
|
-
|
|
2295
|
-
|
|
2296
|
-
"
|
|
2297
|
-
"
|
|
2171
|
+
"async": {
|
|
2172
|
+
"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\".",
|
|
2173
|
+
"name": "async",
|
|
2174
|
+
"summary": "Run the command asynchronously.",
|
|
2175
|
+
"allowNo": false,
|
|
2176
|
+
"type": "boolean"
|
|
2177
|
+
},
|
|
2178
|
+
"concise": {
|
|
2179
|
+
"exclusive": [
|
|
2180
|
+
"verbose"
|
|
2181
|
+
],
|
|
2182
|
+
"name": "concise",
|
|
2183
|
+
"summary": "Show concise output of the validation result.",
|
|
2184
|
+
"allowNo": false,
|
|
2185
|
+
"type": "boolean"
|
|
2186
|
+
},
|
|
2187
|
+
"manifest": {
|
|
2188
|
+
"char": "x",
|
|
2189
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
2190
|
+
"helpGroup": "Source Format",
|
|
2191
|
+
"name": "manifest",
|
|
2192
|
+
"summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
|
|
2298
2193
|
"hasDynamicHelp": false,
|
|
2299
2194
|
"multiple": false,
|
|
2300
2195
|
"type": "option"
|
|
2301
2196
|
},
|
|
2302
2197
|
"metadata": {
|
|
2303
2198
|
"char": "m",
|
|
2199
|
+
"helpGroup": "Source Format",
|
|
2304
2200
|
"name": "metadata",
|
|
2305
|
-
"summary": "
|
|
2306
|
-
"delimiter": ",",
|
|
2201
|
+
"summary": "Metadata component names to validate for deployment.",
|
|
2307
2202
|
"hasDynamicHelp": false,
|
|
2308
2203
|
"multiple": true,
|
|
2309
2204
|
"type": "option"
|
|
2310
2205
|
},
|
|
2311
2206
|
"source-dir": {
|
|
2312
|
-
"
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
|
-
"char": "p",
|
|
2316
|
-
"deprecateAliases": true,
|
|
2207
|
+
"char": "d",
|
|
2208
|
+
"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.",
|
|
2209
|
+
"helpGroup": "Source Format",
|
|
2317
2210
|
"name": "source-dir",
|
|
2318
|
-
"summary": "
|
|
2319
|
-
"delimiter": ",",
|
|
2211
|
+
"summary": "Path to the local source files to validate for deployment.",
|
|
2320
2212
|
"hasDynamicHelp": false,
|
|
2321
2213
|
"multiple": true,
|
|
2322
2214
|
"type": "option"
|
|
2323
2215
|
},
|
|
2324
|
-
"
|
|
2325
|
-
"
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
"
|
|
2329
|
-
"
|
|
2330
|
-
"
|
|
2331
|
-
|
|
2216
|
+
"metadata-dir": {
|
|
2217
|
+
"helpGroup": "Metadata API Format",
|
|
2218
|
+
"name": "metadata-dir",
|
|
2219
|
+
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
2220
|
+
"hasDynamicHelp": false,
|
|
2221
|
+
"multiple": false,
|
|
2222
|
+
"type": "option"
|
|
2223
|
+
},
|
|
2224
|
+
"single-package": {
|
|
2225
|
+
"dependsOn": [
|
|
2226
|
+
"metadata-dir"
|
|
2332
2227
|
],
|
|
2333
|
-
"
|
|
2334
|
-
"
|
|
2228
|
+
"helpGroup": "Metadata API Format",
|
|
2229
|
+
"name": "single-package",
|
|
2230
|
+
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
2231
|
+
"allowNo": false,
|
|
2232
|
+
"type": "boolean"
|
|
2233
|
+
},
|
|
2234
|
+
"target-org": {
|
|
2235
|
+
"char": "o",
|
|
2236
|
+
"name": "target-org",
|
|
2237
|
+
"noCacheDefault": true,
|
|
2238
|
+
"required": true,
|
|
2239
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2240
|
+
"hasDynamicHelp": true,
|
|
2241
|
+
"multiple": false,
|
|
2242
|
+
"type": "option"
|
|
2243
|
+
},
|
|
2244
|
+
"tests": {
|
|
2245
|
+
"char": "t",
|
|
2246
|
+
"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\"",
|
|
2247
|
+
"helpGroup": "Test",
|
|
2248
|
+
"name": "tests",
|
|
2249
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2250
|
+
"hasDynamicHelp": false,
|
|
2251
|
+
"multiple": true,
|
|
2252
|
+
"type": "option"
|
|
2253
|
+
},
|
|
2254
|
+
"test-level": {
|
|
2255
|
+
"char": "l",
|
|
2256
|
+
"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.",
|
|
2257
|
+
"helpGroup": "Test",
|
|
2258
|
+
"name": "test-level",
|
|
2259
|
+
"summary": "Deployment Apex testing level.",
|
|
2260
|
+
"default": "RunLocalTests",
|
|
2335
2261
|
"hasDynamicHelp": false,
|
|
2336
2262
|
"multiple": false,
|
|
2263
|
+
"options": [
|
|
2264
|
+
"RunAllTestsInOrg",
|
|
2265
|
+
"RunLocalTests",
|
|
2266
|
+
"RunSpecifiedTests"
|
|
2267
|
+
],
|
|
2337
2268
|
"type": "option"
|
|
2338
2269
|
},
|
|
2339
|
-
"
|
|
2340
|
-
"aliases": [
|
|
2341
|
-
"manifesttype"
|
|
2342
|
-
],
|
|
2343
|
-
"char": "t",
|
|
2344
|
-
"deprecateAliases": true,
|
|
2270
|
+
"verbose": {
|
|
2345
2271
|
"exclusive": [
|
|
2346
|
-
"
|
|
2272
|
+
"concise"
|
|
2347
2273
|
],
|
|
2348
|
-
"name": "
|
|
2349
|
-
"summary": "
|
|
2350
|
-
"
|
|
2274
|
+
"name": "verbose",
|
|
2275
|
+
"summary": "Show verbose output of the validation result.",
|
|
2276
|
+
"allowNo": false,
|
|
2277
|
+
"type": "boolean"
|
|
2278
|
+
},
|
|
2279
|
+
"wait": {
|
|
2280
|
+
"char": "w",
|
|
2281
|
+
"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\".",
|
|
2282
|
+
"name": "wait",
|
|
2283
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
2284
|
+
"hasDynamicHelp": true,
|
|
2285
|
+
"helpValue": "<minutes>",
|
|
2351
2286
|
"multiple": false,
|
|
2352
|
-
"options": [
|
|
2353
|
-
"pre",
|
|
2354
|
-
"post",
|
|
2355
|
-
"destroy",
|
|
2356
|
-
"package"
|
|
2357
|
-
],
|
|
2358
2287
|
"type": "option"
|
|
2359
2288
|
},
|
|
2360
|
-
"
|
|
2361
|
-
"
|
|
2362
|
-
|
|
2363
|
-
|
|
2364
|
-
"
|
|
2365
|
-
"
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
|
|
2369
|
-
"
|
|
2370
|
-
"
|
|
2371
|
-
"
|
|
2289
|
+
"ignore-warnings": {
|
|
2290
|
+
"char": "g",
|
|
2291
|
+
"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.",
|
|
2292
|
+
"name": "ignore-warnings",
|
|
2293
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
2294
|
+
"allowNo": false,
|
|
2295
|
+
"type": "boolean"
|
|
2296
|
+
},
|
|
2297
|
+
"coverage-formatters": {
|
|
2298
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
2299
|
+
"helpGroup": "Test",
|
|
2300
|
+
"name": "coverage-formatters",
|
|
2301
|
+
"summary": "Format of the code coverage results.",
|
|
2372
2302
|
"hasDynamicHelp": false,
|
|
2373
2303
|
"multiple": true,
|
|
2374
2304
|
"options": [
|
|
2375
|
-
"
|
|
2376
|
-
"
|
|
2305
|
+
"clover",
|
|
2306
|
+
"cobertura",
|
|
2307
|
+
"html-spa",
|
|
2308
|
+
"html",
|
|
2309
|
+
"json",
|
|
2310
|
+
"json-summary",
|
|
2311
|
+
"lcovonly",
|
|
2312
|
+
"none",
|
|
2313
|
+
"teamcity",
|
|
2314
|
+
"text",
|
|
2315
|
+
"text-summary"
|
|
2377
2316
|
],
|
|
2378
2317
|
"type": "option"
|
|
2379
2318
|
},
|
|
2380
|
-
"
|
|
2381
|
-
"
|
|
2319
|
+
"junit": {
|
|
2320
|
+
"helpGroup": "Test",
|
|
2321
|
+
"name": "junit",
|
|
2322
|
+
"summary": "Output JUnit test results.",
|
|
2323
|
+
"allowNo": false,
|
|
2324
|
+
"type": "boolean"
|
|
2325
|
+
},
|
|
2326
|
+
"results-dir": {
|
|
2327
|
+
"helpGroup": "Test",
|
|
2328
|
+
"name": "results-dir",
|
|
2382
2329
|
"relationships": [
|
|
2383
2330
|
{
|
|
2384
2331
|
"type": "some",
|
|
2385
2332
|
"flags": [
|
|
2386
|
-
"
|
|
2387
|
-
"
|
|
2333
|
+
"coverage-formatters",
|
|
2334
|
+
"junit"
|
|
2388
2335
|
]
|
|
2389
2336
|
}
|
|
2390
2337
|
],
|
|
2391
|
-
"summary": "
|
|
2392
|
-
"delimiter": ",",
|
|
2338
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
2393
2339
|
"hasDynamicHelp": false,
|
|
2394
|
-
"multiple":
|
|
2340
|
+
"multiple": false,
|
|
2395
2341
|
"type": "option"
|
|
2396
2342
|
},
|
|
2397
|
-
"
|
|
2398
|
-
"
|
|
2399
|
-
"
|
|
2343
|
+
"purge-on-delete": {
|
|
2344
|
+
"dependsOn": [
|
|
2345
|
+
"manifest"
|
|
2400
2346
|
],
|
|
2401
|
-
"
|
|
2402
|
-
"
|
|
2403
|
-
|
|
2347
|
+
"helpGroup": "Delete",
|
|
2348
|
+
"name": "purge-on-delete",
|
|
2349
|
+
"relationships": [
|
|
2350
|
+
{
|
|
2351
|
+
"type": "some",
|
|
2352
|
+
"flags": [
|
|
2353
|
+
"pre-destructive-changes",
|
|
2354
|
+
"post-destructive-changes"
|
|
2355
|
+
]
|
|
2356
|
+
}
|
|
2404
2357
|
],
|
|
2405
|
-
"
|
|
2406
|
-
"
|
|
2358
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
2359
|
+
"allowNo": false,
|
|
2360
|
+
"type": "boolean"
|
|
2361
|
+
},
|
|
2362
|
+
"pre-destructive-changes": {
|
|
2363
|
+
"dependsOn": [
|
|
2364
|
+
"manifest"
|
|
2365
|
+
],
|
|
2366
|
+
"helpGroup": "Delete",
|
|
2367
|
+
"name": "pre-destructive-changes",
|
|
2368
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
2407
2369
|
"hasDynamicHelp": false,
|
|
2408
2370
|
"multiple": false,
|
|
2409
2371
|
"type": "option"
|
|
2410
2372
|
},
|
|
2411
|
-
"
|
|
2412
|
-
"
|
|
2413
|
-
"
|
|
2414
|
-
"o"
|
|
2373
|
+
"post-destructive-changes": {
|
|
2374
|
+
"dependsOn": [
|
|
2375
|
+
"manifest"
|
|
2415
2376
|
],
|
|
2416
|
-
"
|
|
2417
|
-
"
|
|
2418
|
-
"
|
|
2419
|
-
"summary": "Directory to save the created manifest.",
|
|
2377
|
+
"helpGroup": "Delete",
|
|
2378
|
+
"name": "post-destructive-changes",
|
|
2379
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
2420
2380
|
"hasDynamicHelp": false,
|
|
2421
2381
|
"multiple": false,
|
|
2422
2382
|
"type": "option"
|
|
2423
2383
|
}
|
|
2424
2384
|
},
|
|
2425
|
-
"hasDynamicHelp":
|
|
2385
|
+
"hasDynamicHelp": true,
|
|
2426
2386
|
"hiddenAliases": [],
|
|
2427
|
-
"id": "project:
|
|
2387
|
+
"id": "project:deploy:validate",
|
|
2428
2388
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2429
2389
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2430
2390
|
"pluginType": "core",
|
|
2431
2391
|
"strict": true,
|
|
2432
|
-
"summary": "
|
|
2392
|
+
"summary": "Validate a metadata deployment without actually executing it.",
|
|
2433
2393
|
"enableJsonFlag": true,
|
|
2434
|
-
"
|
|
2394
|
+
"configurationVariablesSection": {
|
|
2395
|
+
"header": "CONFIGURATION VARIABLES",
|
|
2396
|
+
"body": [
|
|
2397
|
+
{
|
|
2398
|
+
"name": "target-org",
|
|
2399
|
+
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
2400
|
+
},
|
|
2401
|
+
{
|
|
2402
|
+
"name": "org-api-version",
|
|
2403
|
+
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
2404
|
+
}
|
|
2405
|
+
]
|
|
2406
|
+
},
|
|
2407
|
+
"envVariablesSection": {
|
|
2408
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2409
|
+
"body": [
|
|
2410
|
+
{
|
|
2411
|
+
"name": "SF_TARGET_ORG",
|
|
2412
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2413
|
+
},
|
|
2414
|
+
{
|
|
2415
|
+
"name": "SF_USE_PROGRESS_BAR",
|
|
2416
|
+
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
2417
|
+
}
|
|
2418
|
+
]
|
|
2419
|
+
},
|
|
2420
|
+
"errorCodes": {
|
|
2421
|
+
"header": "ERROR CODES",
|
|
2422
|
+
"body": [
|
|
2423
|
+
{
|
|
2424
|
+
"name": "Succeeded (0)",
|
|
2425
|
+
"description": "The deploy succeeded."
|
|
2426
|
+
},
|
|
2427
|
+
{
|
|
2428
|
+
"name": "Canceled (1)",
|
|
2429
|
+
"description": "The deploy was canceled."
|
|
2430
|
+
},
|
|
2431
|
+
{
|
|
2432
|
+
"name": "Failed (1)",
|
|
2433
|
+
"description": "The deploy failed."
|
|
2434
|
+
},
|
|
2435
|
+
{
|
|
2436
|
+
"name": "SucceededPartial (68)",
|
|
2437
|
+
"description": "The deploy partially succeeded."
|
|
2438
|
+
},
|
|
2439
|
+
{
|
|
2440
|
+
"name": "InProgress (69)",
|
|
2441
|
+
"description": "The deploy is in progress."
|
|
2442
|
+
},
|
|
2443
|
+
{
|
|
2444
|
+
"name": "Pending (69)",
|
|
2445
|
+
"description": "The deploy is pending."
|
|
2446
|
+
},
|
|
2447
|
+
{
|
|
2448
|
+
"name": "Canceling (69)",
|
|
2449
|
+
"description": "The deploy is being canceled."
|
|
2450
|
+
}
|
|
2451
|
+
]
|
|
2452
|
+
},
|
|
2435
2453
|
"isESM": true,
|
|
2436
2454
|
"relativePath": [
|
|
2437
2455
|
"lib",
|
|
2438
2456
|
"commands",
|
|
2439
2457
|
"project",
|
|
2440
|
-
"
|
|
2441
|
-
"
|
|
2458
|
+
"deploy",
|
|
2459
|
+
"validate.js"
|
|
2442
2460
|
],
|
|
2443
2461
|
"aliasPermutations": [
|
|
2444
|
-
"
|
|
2445
|
-
"
|
|
2446
|
-
"
|
|
2447
|
-
"
|
|
2448
|
-
"
|
|
2449
|
-
"
|
|
2450
|
-
"manifest:source:force:create",
|
|
2451
|
-
"manifest:source:create:force",
|
|
2452
|
-
"force:manifest:create:source",
|
|
2453
|
-
"manifest:force:create:source",
|
|
2454
|
-
"manifest:create:force:source",
|
|
2455
|
-
"manifest:create:source:force",
|
|
2456
|
-
"force:source:create:manifest",
|
|
2457
|
-
"source:force:create:manifest",
|
|
2458
|
-
"source:create:force:manifest",
|
|
2459
|
-
"source:create:manifest:force",
|
|
2460
|
-
"force:create:source:manifest",
|
|
2461
|
-
"create:force:source:manifest",
|
|
2462
|
-
"create:source:force:manifest",
|
|
2463
|
-
"create:source:manifest:force",
|
|
2464
|
-
"force:create:manifest:source",
|
|
2465
|
-
"create:force:manifest:source",
|
|
2466
|
-
"create:manifest:force:source",
|
|
2467
|
-
"create:manifest:source:force"
|
|
2462
|
+
"deploy:metadata:validate",
|
|
2463
|
+
"metadata:deploy:validate",
|
|
2464
|
+
"metadata:validate:deploy",
|
|
2465
|
+
"deploy:validate:metadata",
|
|
2466
|
+
"validate:deploy:metadata",
|
|
2467
|
+
"validate:metadata:deploy"
|
|
2468
2468
|
],
|
|
2469
2469
|
"permutations": [
|
|
2470
|
-
"project:
|
|
2471
|
-
"
|
|
2472
|
-
"
|
|
2473
|
-
"project:
|
|
2474
|
-
"
|
|
2475
|
-
"
|
|
2470
|
+
"project:deploy:validate",
|
|
2471
|
+
"deploy:project:validate",
|
|
2472
|
+
"deploy:validate:project",
|
|
2473
|
+
"project:validate:deploy",
|
|
2474
|
+
"validate:project:deploy",
|
|
2475
|
+
"validate:deploy:project"
|
|
2476
2476
|
]
|
|
2477
2477
|
},
|
|
2478
2478
|
"project:list:ignored": {
|
|
@@ -3051,5 +3051,5 @@
|
|
|
3051
3051
|
]
|
|
3052
3052
|
}
|
|
3053
3053
|
},
|
|
3054
|
-
"version": "3.22.
|
|
3054
|
+
"version": "3.22.15"
|
|
3055
3055
|
}
|