@salesforce/plugin-deploy-retrieve 3.22.32 → 3.22.34-dev.0
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/messages/metadata.transfer.md +4 -0
- package/oclif.manifest.json +1055 -1055
- package/package.json +9 -6
- package/schemas/project-delete-source.json +10 -1
- package/schemas/project-deploy-cancel.json +16 -7
- package/schemas/project-deploy-quick.json +16 -7
- package/schemas/project-deploy-report.json +16 -7
- package/schemas/project-deploy-resume.json +16 -7
- package/schemas/project-deploy-start.json +16 -7
- package/schemas/project-deploy-validate.json +16 -7
- package/schemas/project-retrieve-start.json +10 -1
package/oclif.manifest.json
CHANGED
|
@@ -752,17 +752,16 @@
|
|
|
752
752
|
"tracking:delete:project"
|
|
753
753
|
]
|
|
754
754
|
},
|
|
755
|
-
"project:
|
|
755
|
+
"project:deploy:cancel": {
|
|
756
756
|
"aliases": [
|
|
757
|
-
"
|
|
757
|
+
"deploy:metadata:cancel"
|
|
758
758
|
],
|
|
759
759
|
"args": {},
|
|
760
760
|
"deprecateAliases": true,
|
|
761
|
-
"description": "
|
|
761
|
+
"description": "Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
762
762
|
"examples": [
|
|
763
|
-
"
|
|
764
|
-
"
|
|
765
|
-
"Check if a particular file is ignored:\n<%= config.bin %> <%= command.id %> --source-dir package.xml"
|
|
763
|
+
"Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
764
|
+
"Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
766
765
|
],
|
|
767
766
|
"flags": {
|
|
768
767
|
"json": {
|
|
@@ -780,86 +779,103 @@
|
|
|
780
779
|
"multiple": false,
|
|
781
780
|
"type": "option"
|
|
782
781
|
},
|
|
783
|
-
"
|
|
784
|
-
"
|
|
785
|
-
|
|
782
|
+
"target-org": {
|
|
783
|
+
"char": "o",
|
|
784
|
+
"name": "target-org",
|
|
785
|
+
"noCacheDefault": true,
|
|
786
|
+
"summary": "Username or alias of the target org.",
|
|
787
|
+
"hasDynamicHelp": true,
|
|
788
|
+
"multiple": false,
|
|
789
|
+
"type": "option"
|
|
790
|
+
},
|
|
791
|
+
"async": {
|
|
792
|
+
"description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run \"<%= config.bin %> project deploy resume\". To check the status of the cancellation, run \"<%= config.bin %> project deploy report\".",
|
|
793
|
+
"exclusive": [
|
|
794
|
+
"wait"
|
|
786
795
|
],
|
|
787
|
-
"
|
|
788
|
-
"
|
|
789
|
-
"
|
|
790
|
-
"
|
|
796
|
+
"name": "async",
|
|
797
|
+
"summary": "Run the command asynchronously.",
|
|
798
|
+
"allowNo": false,
|
|
799
|
+
"type": "boolean"
|
|
800
|
+
},
|
|
801
|
+
"job-id": {
|
|
802
|
+
"char": "i",
|
|
803
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
804
|
+
"name": "job-id",
|
|
805
|
+
"summary": "Job ID of the deploy operation you want to cancel.",
|
|
791
806
|
"hasDynamicHelp": false,
|
|
792
807
|
"multiple": false,
|
|
793
808
|
"type": "option"
|
|
809
|
+
},
|
|
810
|
+
"use-most-recent": {
|
|
811
|
+
"char": "r",
|
|
812
|
+
"description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.",
|
|
813
|
+
"name": "use-most-recent",
|
|
814
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
815
|
+
"allowNo": false,
|
|
816
|
+
"type": "boolean"
|
|
817
|
+
},
|
|
818
|
+
"wait": {
|
|
819
|
+
"char": "w",
|
|
820
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run \"<%= config.bin %> project deploy resume\". To check the status of the cancellation, run \"<%= config.bin %> project deploy report\".",
|
|
821
|
+
"exclusive": [
|
|
822
|
+
"async"
|
|
823
|
+
],
|
|
824
|
+
"name": "wait",
|
|
825
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
826
|
+
"hasDynamicHelp": true,
|
|
827
|
+
"helpValue": "<minutes>",
|
|
828
|
+
"multiple": false,
|
|
829
|
+
"type": "option"
|
|
794
830
|
}
|
|
795
831
|
},
|
|
796
|
-
"hasDynamicHelp":
|
|
832
|
+
"hasDynamicHelp": true,
|
|
797
833
|
"hiddenAliases": [],
|
|
798
|
-
"id": "project:
|
|
834
|
+
"id": "project:deploy:cancel",
|
|
799
835
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
800
836
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
801
837
|
"pluginType": "core",
|
|
802
838
|
"strict": true,
|
|
803
|
-
"summary": "
|
|
839
|
+
"summary": "Cancel a deploy operation.",
|
|
804
840
|
"enableJsonFlag": true,
|
|
805
|
-
"requiresProject": true,
|
|
806
841
|
"isESM": true,
|
|
807
842
|
"relativePath": [
|
|
808
843
|
"lib",
|
|
809
844
|
"commands",
|
|
810
845
|
"project",
|
|
811
|
-
"
|
|
812
|
-
"
|
|
846
|
+
"deploy",
|
|
847
|
+
"cancel.js"
|
|
813
848
|
],
|
|
814
849
|
"aliasPermutations": [
|
|
815
|
-
"
|
|
816
|
-
"
|
|
817
|
-
"
|
|
818
|
-
"
|
|
819
|
-
"
|
|
820
|
-
"
|
|
821
|
-
"ignored:source:force:list",
|
|
822
|
-
"ignored:source:list:force",
|
|
823
|
-
"force:ignored:list:source",
|
|
824
|
-
"ignored:force:list:source",
|
|
825
|
-
"ignored:list:force:source",
|
|
826
|
-
"ignored:list:source:force",
|
|
827
|
-
"force:source:list:ignored",
|
|
828
|
-
"source:force:list:ignored",
|
|
829
|
-
"source:list:force:ignored",
|
|
830
|
-
"source:list:ignored:force",
|
|
831
|
-
"force:list:source:ignored",
|
|
832
|
-
"list:force:source:ignored",
|
|
833
|
-
"list:source:force:ignored",
|
|
834
|
-
"list:source:ignored:force",
|
|
835
|
-
"force:list:ignored:source",
|
|
836
|
-
"list:force:ignored:source",
|
|
837
|
-
"list:ignored:force:source",
|
|
838
|
-
"list:ignored:source:force"
|
|
850
|
+
"deploy:metadata:cancel",
|
|
851
|
+
"metadata:deploy:cancel",
|
|
852
|
+
"metadata:cancel:deploy",
|
|
853
|
+
"deploy:cancel:metadata",
|
|
854
|
+
"cancel:deploy:metadata",
|
|
855
|
+
"cancel:metadata:deploy"
|
|
839
856
|
],
|
|
840
857
|
"permutations": [
|
|
841
|
-
"project:
|
|
842
|
-
"
|
|
843
|
-
"
|
|
844
|
-
"project:
|
|
845
|
-
"
|
|
846
|
-
"
|
|
858
|
+
"project:deploy:cancel",
|
|
859
|
+
"deploy:project:cancel",
|
|
860
|
+
"deploy:cancel:project",
|
|
861
|
+
"project:cancel:deploy",
|
|
862
|
+
"cancel:project:deploy",
|
|
863
|
+
"cancel:deploy:project"
|
|
847
864
|
]
|
|
848
865
|
},
|
|
849
|
-
"project:
|
|
866
|
+
"project:deploy:preview": {
|
|
850
867
|
"aliases": [
|
|
851
|
-
"
|
|
868
|
+
"deploy:metadata:preview"
|
|
852
869
|
],
|
|
853
870
|
"args": {},
|
|
854
871
|
"deprecateAliases": true,
|
|
855
|
-
"description": "
|
|
872
|
+
"description": "You must run this command from within a project.\n\nThe command outputs a table that describes what will happen if you run the \"<%= config.bin %> project deploy start\" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.\n\nIf your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
|
|
856
873
|
"examples": [
|
|
857
|
-
"
|
|
858
|
-
"
|
|
859
|
-
"
|
|
860
|
-
"
|
|
861
|
-
"
|
|
862
|
-
"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"
|
|
874
|
+
"NOTE: The commands to preview a deployment and actually deploy it use similar flags. We provide a few preview examples here, but see the help for \"<%= config.bin %> project deploy start\" for more examples that you can adapt for previewing.",
|
|
875
|
+
"Preview the deployment of source files in a directory, such as force-app, to your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
|
|
876
|
+
"Preview the deployment of all Apex classes to an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch",
|
|
877
|
+
"Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
878
|
+
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
863
879
|
],
|
|
864
880
|
"flags": {
|
|
865
881
|
"json": {
|
|
@@ -877,158 +893,77 @@
|
|
|
877
893
|
"multiple": false,
|
|
878
894
|
"type": "option"
|
|
879
895
|
},
|
|
880
|
-
"
|
|
881
|
-
"
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
"
|
|
885
|
-
"
|
|
886
|
-
"
|
|
887
|
-
"hasDynamicHelp": false,
|
|
888
|
-
"multiple": false,
|
|
889
|
-
"type": "option"
|
|
896
|
+
"ignore-conflicts": {
|
|
897
|
+
"char": "c",
|
|
898
|
+
"description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
|
|
899
|
+
"name": "ignore-conflicts",
|
|
900
|
+
"summary": "Don't display conflicts in preview of the deployment.",
|
|
901
|
+
"allowNo": false,
|
|
902
|
+
"type": "boolean"
|
|
890
903
|
},
|
|
891
|
-
"
|
|
892
|
-
"
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
904
|
+
"manifest": {
|
|
905
|
+
"char": "x",
|
|
906
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
907
|
+
"exclusive": [
|
|
908
|
+
"source-dir",
|
|
909
|
+
"metadata"
|
|
910
|
+
],
|
|
911
|
+
"name": "manifest",
|
|
912
|
+
"summary": "Full file path for manifest (package.xml) of components to preview.",
|
|
897
913
|
"hasDynamicHelp": false,
|
|
898
914
|
"multiple": false,
|
|
899
915
|
"type": "option"
|
|
900
916
|
},
|
|
901
917
|
"metadata": {
|
|
902
918
|
"char": "m",
|
|
919
|
+
"exclusive": [
|
|
920
|
+
"manifest",
|
|
921
|
+
"source-dir"
|
|
922
|
+
],
|
|
903
923
|
"name": "metadata",
|
|
904
|
-
"summary": "
|
|
905
|
-
"delimiter": ",",
|
|
924
|
+
"summary": "Metadata component names to preview.",
|
|
906
925
|
"hasDynamicHelp": false,
|
|
907
926
|
"multiple": true,
|
|
908
927
|
"type": "option"
|
|
909
928
|
},
|
|
910
929
|
"source-dir": {
|
|
911
|
-
"
|
|
912
|
-
|
|
930
|
+
"char": "d",
|
|
931
|
+
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
|
|
932
|
+
"exclusive": [
|
|
933
|
+
"manifest",
|
|
934
|
+
"metadata"
|
|
913
935
|
],
|
|
914
|
-
"char": "p",
|
|
915
|
-
"deprecateAliases": true,
|
|
916
936
|
"name": "source-dir",
|
|
917
|
-
"summary": "
|
|
918
|
-
"delimiter": ",",
|
|
937
|
+
"summary": "Path to the local source files to preview.",
|
|
919
938
|
"hasDynamicHelp": false,
|
|
920
939
|
"multiple": true,
|
|
921
940
|
"type": "option"
|
|
922
941
|
},
|
|
923
|
-
"
|
|
924
|
-
"
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
"
|
|
928
|
-
"
|
|
929
|
-
"
|
|
930
|
-
"type"
|
|
931
|
-
],
|
|
932
|
-
"name": "name",
|
|
933
|
-
"summary": "Name of a custom manifest file to create.",
|
|
934
|
-
"hasDynamicHelp": false,
|
|
935
|
-
"multiple": false,
|
|
936
|
-
"type": "option"
|
|
937
|
-
},
|
|
938
|
-
"type": {
|
|
939
|
-
"aliases": [
|
|
940
|
-
"manifesttype"
|
|
941
|
-
],
|
|
942
|
-
"char": "t",
|
|
943
|
-
"deprecateAliases": true,
|
|
944
|
-
"exclusive": [
|
|
945
|
-
"name"
|
|
946
|
-
],
|
|
947
|
-
"name": "type",
|
|
948
|
-
"summary": "Type of manifest to create; the type determines the name of the created file.",
|
|
949
|
-
"hasDynamicHelp": false,
|
|
942
|
+
"target-org": {
|
|
943
|
+
"char": "o",
|
|
944
|
+
"name": "target-org",
|
|
945
|
+
"noCacheDefault": true,
|
|
946
|
+
"required": true,
|
|
947
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
948
|
+
"hasDynamicHelp": true,
|
|
950
949
|
"multiple": false,
|
|
951
|
-
"options": [
|
|
952
|
-
"pre",
|
|
953
|
-
"post",
|
|
954
|
-
"destroy",
|
|
955
|
-
"package"
|
|
956
|
-
],
|
|
957
|
-
"type": "option"
|
|
958
|
-
},
|
|
959
|
-
"include-packages": {
|
|
960
|
-
"aliases": [
|
|
961
|
-
"includepackages"
|
|
962
|
-
],
|
|
963
|
-
"char": "c",
|
|
964
|
-
"dependsOn": [
|
|
965
|
-
"from-org"
|
|
966
|
-
],
|
|
967
|
-
"deprecateAliases": true,
|
|
968
|
-
"name": "include-packages",
|
|
969
|
-
"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.",
|
|
970
|
-
"delimiter": ",",
|
|
971
|
-
"hasDynamicHelp": false,
|
|
972
|
-
"multiple": true,
|
|
973
|
-
"options": [
|
|
974
|
-
"managed",
|
|
975
|
-
"unlocked"
|
|
976
|
-
],
|
|
977
950
|
"type": "option"
|
|
978
951
|
},
|
|
979
|
-
"
|
|
980
|
-
"name": "
|
|
981
|
-
"
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
"flags": [
|
|
985
|
-
"from-org",
|
|
986
|
-
"source-dir"
|
|
987
|
-
]
|
|
988
|
-
}
|
|
989
|
-
],
|
|
990
|
-
"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.",
|
|
991
|
-
"delimiter": ",",
|
|
992
|
-
"hasDynamicHelp": false,
|
|
993
|
-
"multiple": true,
|
|
994
|
-
"type": "option"
|
|
995
|
-
},
|
|
996
|
-
"from-org": {
|
|
997
|
-
"aliases": [
|
|
998
|
-
"fromorg"
|
|
999
|
-
],
|
|
1000
|
-
"deprecateAliases": true,
|
|
1001
|
-
"exclusive": [
|
|
1002
|
-
"source-dir"
|
|
1003
|
-
],
|
|
1004
|
-
"name": "from-org",
|
|
1005
|
-
"summary": "Username or alias of the org that contains the metadata components from which to build a manifest.",
|
|
1006
|
-
"hasDynamicHelp": false,
|
|
1007
|
-
"multiple": false,
|
|
1008
|
-
"type": "option"
|
|
1009
|
-
},
|
|
1010
|
-
"output-dir": {
|
|
1011
|
-
"aliases": [
|
|
1012
|
-
"outputdir",
|
|
1013
|
-
"o"
|
|
1014
|
-
],
|
|
1015
|
-
"char": "d",
|
|
1016
|
-
"deprecateAliases": true,
|
|
1017
|
-
"name": "output-dir",
|
|
1018
|
-
"summary": "Directory to save the created manifest.",
|
|
1019
|
-
"hasDynamicHelp": false,
|
|
1020
|
-
"multiple": false,
|
|
1021
|
-
"type": "option"
|
|
952
|
+
"concise": {
|
|
953
|
+
"name": "concise",
|
|
954
|
+
"summary": "Show only the changes that will be deployed; omits files that are forceignored.",
|
|
955
|
+
"allowNo": false,
|
|
956
|
+
"type": "boolean"
|
|
1022
957
|
}
|
|
1023
958
|
},
|
|
1024
|
-
"hasDynamicHelp":
|
|
959
|
+
"hasDynamicHelp": true,
|
|
1025
960
|
"hiddenAliases": [],
|
|
1026
|
-
"id": "project:
|
|
961
|
+
"id": "project:deploy:preview",
|
|
1027
962
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1028
963
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1029
964
|
"pluginType": "core",
|
|
1030
965
|
"strict": true,
|
|
1031
|
-
"summary": "
|
|
966
|
+
"summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
|
|
1032
967
|
"enableJsonFlag": true,
|
|
1033
968
|
"requiresProject": true,
|
|
1034
969
|
"isESM": true,
|
|
@@ -1036,54 +971,36 @@
|
|
|
1036
971
|
"lib",
|
|
1037
972
|
"commands",
|
|
1038
973
|
"project",
|
|
1039
|
-
"
|
|
1040
|
-
"
|
|
974
|
+
"deploy",
|
|
975
|
+
"preview.js"
|
|
1041
976
|
],
|
|
1042
977
|
"aliasPermutations": [
|
|
1043
|
-
"
|
|
1044
|
-
"
|
|
1045
|
-
"
|
|
1046
|
-
"
|
|
1047
|
-
"
|
|
1048
|
-
"
|
|
1049
|
-
"manifest:source:force:create",
|
|
1050
|
-
"manifest:source:create:force",
|
|
1051
|
-
"force:manifest:create:source",
|
|
1052
|
-
"manifest:force:create:source",
|
|
1053
|
-
"manifest:create:force:source",
|
|
1054
|
-
"manifest:create:source:force",
|
|
1055
|
-
"force:source:create:manifest",
|
|
1056
|
-
"source:force:create:manifest",
|
|
1057
|
-
"source:create:force:manifest",
|
|
1058
|
-
"source:create:manifest:force",
|
|
1059
|
-
"force:create:source:manifest",
|
|
1060
|
-
"create:force:source:manifest",
|
|
1061
|
-
"create:source:force:manifest",
|
|
1062
|
-
"create:source:manifest:force",
|
|
1063
|
-
"force:create:manifest:source",
|
|
1064
|
-
"create:force:manifest:source",
|
|
1065
|
-
"create:manifest:force:source",
|
|
1066
|
-
"create:manifest:source:force"
|
|
978
|
+
"deploy:metadata:preview",
|
|
979
|
+
"metadata:deploy:preview",
|
|
980
|
+
"metadata:preview:deploy",
|
|
981
|
+
"deploy:preview:metadata",
|
|
982
|
+
"preview:deploy:metadata",
|
|
983
|
+
"preview:metadata:deploy"
|
|
1067
984
|
],
|
|
1068
985
|
"permutations": [
|
|
1069
|
-
"project:
|
|
1070
|
-
"
|
|
1071
|
-
"
|
|
1072
|
-
"project:
|
|
1073
|
-
"
|
|
1074
|
-
"
|
|
986
|
+
"project:deploy:preview",
|
|
987
|
+
"deploy:project:preview",
|
|
988
|
+
"deploy:preview:project",
|
|
989
|
+
"project:preview:deploy",
|
|
990
|
+
"preview:project:deploy",
|
|
991
|
+
"preview:deploy:project"
|
|
1075
992
|
]
|
|
1076
993
|
},
|
|
1077
|
-
"project:deploy:
|
|
994
|
+
"project:deploy:quick": {
|
|
1078
995
|
"aliases": [
|
|
1079
|
-
"deploy:metadata:
|
|
996
|
+
"deploy:metadata:quick"
|
|
1080
997
|
],
|
|
1081
998
|
"args": {},
|
|
1082
999
|
"deprecateAliases": true,
|
|
1083
|
-
"description": "
|
|
1000
|
+
"description": "Before you run this command, first create a validated deployment with the \"<%= config.bin %> project deploy validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. Use \"<%= config.bin %> project deploy start\" instead.",
|
|
1084
1001
|
"examples": [
|
|
1085
|
-
"
|
|
1086
|
-
"
|
|
1002
|
+
"Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1003
|
+
"Asynchronously run a quick deploy of the most recently validated deployment to an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --target-org my-prod-org"
|
|
1087
1004
|
],
|
|
1088
1005
|
"flags": {
|
|
1089
1006
|
"json": {
|
|
@@ -1101,17 +1018,8 @@
|
|
|
1101
1018
|
"multiple": false,
|
|
1102
1019
|
"type": "option"
|
|
1103
1020
|
},
|
|
1104
|
-
"target-org": {
|
|
1105
|
-
"char": "o",
|
|
1106
|
-
"name": "target-org",
|
|
1107
|
-
"noCacheDefault": true,
|
|
1108
|
-
"summary": "Username or alias of the target org.",
|
|
1109
|
-
"hasDynamicHelp": true,
|
|
1110
|
-
"multiple": false,
|
|
1111
|
-
"type": "option"
|
|
1112
|
-
},
|
|
1113
1021
|
"async": {
|
|
1114
|
-
"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
|
|
1022
|
+
"description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
|
|
1115
1023
|
"exclusive": [
|
|
1116
1024
|
"wait"
|
|
1117
1025
|
],
|
|
@@ -1120,84 +1028,152 @@
|
|
|
1120
1028
|
"allowNo": false,
|
|
1121
1029
|
"type": "boolean"
|
|
1122
1030
|
},
|
|
1031
|
+
"concise": {
|
|
1032
|
+
"exclusive": [
|
|
1033
|
+
"verbose"
|
|
1034
|
+
],
|
|
1035
|
+
"name": "concise",
|
|
1036
|
+
"summary": "Show concise output of the deploy result.",
|
|
1037
|
+
"allowNo": false,
|
|
1038
|
+
"type": "boolean"
|
|
1039
|
+
},
|
|
1123
1040
|
"job-id": {
|
|
1124
1041
|
"char": "i",
|
|
1125
|
-
"description": "
|
|
1042
|
+
"description": "The job ID is valid for 10 days from when you started the validation.",
|
|
1126
1043
|
"name": "job-id",
|
|
1127
|
-
"summary": "Job ID of the
|
|
1044
|
+
"summary": "Job ID of the deployment you want to quick deploy.",
|
|
1128
1045
|
"hasDynamicHelp": false,
|
|
1129
1046
|
"multiple": false,
|
|
1130
1047
|
"type": "option"
|
|
1131
1048
|
},
|
|
1049
|
+
"target-org": {
|
|
1050
|
+
"char": "o",
|
|
1051
|
+
"name": "target-org",
|
|
1052
|
+
"noCacheDefault": true,
|
|
1053
|
+
"summary": "Username or alias of the target org.",
|
|
1054
|
+
"hasDynamicHelp": true,
|
|
1055
|
+
"multiple": false,
|
|
1056
|
+
"type": "option"
|
|
1057
|
+
},
|
|
1132
1058
|
"use-most-recent": {
|
|
1133
1059
|
"char": "r",
|
|
1134
|
-
"description": "For performance reasons, this flag uses job IDs
|
|
1060
|
+
"description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find a job ID.",
|
|
1135
1061
|
"name": "use-most-recent",
|
|
1136
|
-
"summary": "Use the job ID of the most
|
|
1062
|
+
"summary": "Use the job ID of the most recently validated deployment.",
|
|
1063
|
+
"allowNo": false,
|
|
1064
|
+
"type": "boolean"
|
|
1065
|
+
},
|
|
1066
|
+
"verbose": {
|
|
1067
|
+
"exclusive": [
|
|
1068
|
+
"concise"
|
|
1069
|
+
],
|
|
1070
|
+
"name": "verbose",
|
|
1071
|
+
"summary": "Show verbose output of the deploy result.",
|
|
1137
1072
|
"allowNo": false,
|
|
1138
1073
|
"type": "boolean"
|
|
1139
1074
|
},
|
|
1140
1075
|
"wait": {
|
|
1141
1076
|
"char": "w",
|
|
1142
|
-
"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
|
|
1077
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
|
|
1143
1078
|
"exclusive": [
|
|
1144
1079
|
"async"
|
|
1145
1080
|
],
|
|
1146
1081
|
"name": "wait",
|
|
1147
1082
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1083
|
+
"default": "33 minutes",
|
|
1148
1084
|
"hasDynamicHelp": true,
|
|
1149
1085
|
"helpValue": "<minutes>",
|
|
1150
1086
|
"multiple": false,
|
|
1151
1087
|
"type": "option"
|
|
1088
|
+
},
|
|
1089
|
+
"api-version": {
|
|
1090
|
+
"char": "a",
|
|
1091
|
+
"description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
|
|
1092
|
+
"name": "api-version",
|
|
1093
|
+
"summary": "Target API version for the deploy.",
|
|
1094
|
+
"hasDynamicHelp": false,
|
|
1095
|
+
"multiple": false,
|
|
1096
|
+
"type": "option"
|
|
1152
1097
|
}
|
|
1153
1098
|
},
|
|
1154
1099
|
"hasDynamicHelp": true,
|
|
1155
1100
|
"hiddenAliases": [],
|
|
1156
|
-
"id": "project:deploy:
|
|
1101
|
+
"id": "project:deploy:quick",
|
|
1157
1102
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1158
1103
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1159
1104
|
"pluginType": "core",
|
|
1160
1105
|
"strict": true,
|
|
1161
|
-
"summary": "
|
|
1106
|
+
"summary": "Quickly deploy a validated deployment to an org.",
|
|
1162
1107
|
"enableJsonFlag": true,
|
|
1108
|
+
"errorCodes": {
|
|
1109
|
+
"header": "ERROR CODES",
|
|
1110
|
+
"body": [
|
|
1111
|
+
{
|
|
1112
|
+
"name": "Succeeded (0)",
|
|
1113
|
+
"description": "The deploy succeeded."
|
|
1114
|
+
},
|
|
1115
|
+
{
|
|
1116
|
+
"name": "Canceled (1)",
|
|
1117
|
+
"description": "The deploy was canceled."
|
|
1118
|
+
},
|
|
1119
|
+
{
|
|
1120
|
+
"name": "Failed (1)",
|
|
1121
|
+
"description": "The deploy failed."
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
"name": "SucceededPartial (68)",
|
|
1125
|
+
"description": "The deploy partially succeeded."
|
|
1126
|
+
},
|
|
1127
|
+
{
|
|
1128
|
+
"name": "InProgress (69)",
|
|
1129
|
+
"description": "The deploy is in progress."
|
|
1130
|
+
},
|
|
1131
|
+
{
|
|
1132
|
+
"name": "Pending (69)",
|
|
1133
|
+
"description": "The deploy is pending."
|
|
1134
|
+
},
|
|
1135
|
+
{
|
|
1136
|
+
"name": "Canceling (69)",
|
|
1137
|
+
"description": "The deploy is being canceled."
|
|
1138
|
+
}
|
|
1139
|
+
]
|
|
1140
|
+
},
|
|
1163
1141
|
"isESM": true,
|
|
1164
1142
|
"relativePath": [
|
|
1165
1143
|
"lib",
|
|
1166
1144
|
"commands",
|
|
1167
1145
|
"project",
|
|
1168
1146
|
"deploy",
|
|
1169
|
-
"
|
|
1147
|
+
"quick.js"
|
|
1170
1148
|
],
|
|
1171
1149
|
"aliasPermutations": [
|
|
1172
|
-
"deploy:metadata:
|
|
1173
|
-
"metadata:deploy:
|
|
1174
|
-
"metadata:
|
|
1175
|
-
"deploy:
|
|
1176
|
-
"
|
|
1177
|
-
"
|
|
1150
|
+
"deploy:metadata:quick",
|
|
1151
|
+
"metadata:deploy:quick",
|
|
1152
|
+
"metadata:quick:deploy",
|
|
1153
|
+
"deploy:quick:metadata",
|
|
1154
|
+
"quick:deploy:metadata",
|
|
1155
|
+
"quick:metadata:deploy"
|
|
1178
1156
|
],
|
|
1179
1157
|
"permutations": [
|
|
1180
|
-
"project:deploy:
|
|
1181
|
-
"deploy:project:
|
|
1182
|
-
"deploy:
|
|
1183
|
-
"project:
|
|
1184
|
-
"
|
|
1185
|
-
"
|
|
1158
|
+
"project:deploy:quick",
|
|
1159
|
+
"deploy:project:quick",
|
|
1160
|
+
"deploy:quick:project",
|
|
1161
|
+
"project:quick:deploy",
|
|
1162
|
+
"quick:project:deploy",
|
|
1163
|
+
"quick:deploy:project"
|
|
1186
1164
|
]
|
|
1187
1165
|
},
|
|
1188
|
-
"project:deploy:
|
|
1166
|
+
"project:deploy:report": {
|
|
1189
1167
|
"aliases": [
|
|
1190
|
-
"deploy:metadata:
|
|
1168
|
+
"deploy:metadata:report"
|
|
1191
1169
|
],
|
|
1192
1170
|
"args": {},
|
|
1193
1171
|
"deprecateAliases": true,
|
|
1194
|
-
"description": "
|
|
1172
|
+
"description": "Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation. If you specify the --wait flag, the command polls for the status every second until the timeout of --wait minutes. If you don't specify the --wait flag, the command simply checks and displays the status of the deploy; the command doesn't poll for the status.\n\nYou typically don't specify the --target-org flag because the cached job already references the org to which you deployed. But if you run this command on a computer different than the one from which you deployed, then you must specify the --target-org and it must point to the same org.\n\nThis command doesn't update source tracking information.",
|
|
1195
1173
|
"examples": [
|
|
1196
|
-
"
|
|
1197
|
-
"
|
|
1198
|
-
"
|
|
1199
|
-
"Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
1200
|
-
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
1174
|
+
"Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1175
|
+
"Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
|
|
1176
|
+
"Poll for the status using a job ID and target org:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30"
|
|
1201
1177
|
],
|
|
1202
1178
|
"flags": {
|
|
1203
1179
|
"json": {
|
|
@@ -1215,114 +1191,133 @@
|
|
|
1215
1191
|
"multiple": false,
|
|
1216
1192
|
"type": "option"
|
|
1217
1193
|
},
|
|
1218
|
-
"
|
|
1219
|
-
"char": "
|
|
1220
|
-
"
|
|
1221
|
-
"
|
|
1222
|
-
"summary": "
|
|
1223
|
-
"
|
|
1224
|
-
"type": "boolean"
|
|
1225
|
-
},
|
|
1226
|
-
"manifest": {
|
|
1227
|
-
"char": "x",
|
|
1228
|
-
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1229
|
-
"exclusive": [
|
|
1230
|
-
"source-dir",
|
|
1231
|
-
"metadata"
|
|
1232
|
-
],
|
|
1233
|
-
"name": "manifest",
|
|
1234
|
-
"summary": "Full file path for manifest (package.xml) of components to preview.",
|
|
1235
|
-
"hasDynamicHelp": false,
|
|
1194
|
+
"target-org": {
|
|
1195
|
+
"char": "o",
|
|
1196
|
+
"name": "target-org",
|
|
1197
|
+
"noCacheDefault": true,
|
|
1198
|
+
"summary": "Username or alias of the target org.",
|
|
1199
|
+
"hasDynamicHelp": true,
|
|
1236
1200
|
"multiple": false,
|
|
1237
1201
|
"type": "option"
|
|
1238
1202
|
},
|
|
1239
|
-
"
|
|
1240
|
-
"char": "
|
|
1241
|
-
"
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
"
|
|
1246
|
-
"
|
|
1203
|
+
"job-id": {
|
|
1204
|
+
"char": "i",
|
|
1205
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
1206
|
+
"name": "job-id",
|
|
1207
|
+
"summary": "Job ID of the deploy operation you want to check the status of.",
|
|
1208
|
+
"hasDynamicHelp": false,
|
|
1209
|
+
"multiple": false,
|
|
1210
|
+
"type": "option"
|
|
1211
|
+
},
|
|
1212
|
+
"use-most-recent": {
|
|
1213
|
+
"char": "r",
|
|
1214
|
+
"description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.",
|
|
1215
|
+
"name": "use-most-recent",
|
|
1216
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1217
|
+
"allowNo": false,
|
|
1218
|
+
"type": "boolean"
|
|
1219
|
+
},
|
|
1220
|
+
"coverage-formatters": {
|
|
1221
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1222
|
+
"helpGroup": "Test",
|
|
1223
|
+
"name": "coverage-formatters",
|
|
1224
|
+
"summary": "Format of the code coverage results.",
|
|
1247
1225
|
"hasDynamicHelp": false,
|
|
1248
1226
|
"multiple": true,
|
|
1227
|
+
"options": [
|
|
1228
|
+
"clover",
|
|
1229
|
+
"cobertura",
|
|
1230
|
+
"html-spa",
|
|
1231
|
+
"html",
|
|
1232
|
+
"json",
|
|
1233
|
+
"json-summary",
|
|
1234
|
+
"lcovonly",
|
|
1235
|
+
"none",
|
|
1236
|
+
"teamcity",
|
|
1237
|
+
"text",
|
|
1238
|
+
"text-summary"
|
|
1239
|
+
],
|
|
1249
1240
|
"type": "option"
|
|
1250
1241
|
},
|
|
1251
|
-
"
|
|
1252
|
-
"
|
|
1253
|
-
"
|
|
1254
|
-
"
|
|
1255
|
-
|
|
1256
|
-
|
|
1242
|
+
"junit": {
|
|
1243
|
+
"helpGroup": "Test",
|
|
1244
|
+
"name": "junit",
|
|
1245
|
+
"summary": "Output JUnit test results.",
|
|
1246
|
+
"allowNo": false,
|
|
1247
|
+
"type": "boolean"
|
|
1248
|
+
},
|
|
1249
|
+
"results-dir": {
|
|
1250
|
+
"helpGroup": "Test",
|
|
1251
|
+
"name": "results-dir",
|
|
1252
|
+
"relationships": [
|
|
1253
|
+
{
|
|
1254
|
+
"type": "some",
|
|
1255
|
+
"flags": [
|
|
1256
|
+
"coverage-formatters",
|
|
1257
|
+
"junit"
|
|
1258
|
+
]
|
|
1259
|
+
}
|
|
1257
1260
|
],
|
|
1258
|
-
"
|
|
1259
|
-
"summary": "Path to the local source files to preview.",
|
|
1261
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
1260
1262
|
"hasDynamicHelp": false,
|
|
1261
|
-
"multiple":
|
|
1263
|
+
"multiple": false,
|
|
1262
1264
|
"type": "option"
|
|
1263
1265
|
},
|
|
1264
|
-
"
|
|
1265
|
-
"char": "
|
|
1266
|
-
"
|
|
1267
|
-
"
|
|
1268
|
-
"
|
|
1269
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1266
|
+
"wait": {
|
|
1267
|
+
"char": "w",
|
|
1268
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
|
|
1269
|
+
"name": "wait",
|
|
1270
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1270
1271
|
"hasDynamicHelp": true,
|
|
1272
|
+
"helpValue": "<minutes>",
|
|
1271
1273
|
"multiple": false,
|
|
1272
1274
|
"type": "option"
|
|
1273
|
-
},
|
|
1274
|
-
"concise": {
|
|
1275
|
-
"name": "concise",
|
|
1276
|
-
"summary": "Show only the changes that will be deployed; omits files that are forceignored.",
|
|
1277
|
-
"allowNo": false,
|
|
1278
|
-
"type": "boolean"
|
|
1279
1275
|
}
|
|
1280
1276
|
},
|
|
1281
1277
|
"hasDynamicHelp": true,
|
|
1282
1278
|
"hiddenAliases": [],
|
|
1283
|
-
"id": "project:deploy:
|
|
1279
|
+
"id": "project:deploy:report",
|
|
1284
1280
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1285
1281
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1286
1282
|
"pluginType": "core",
|
|
1287
1283
|
"strict": true,
|
|
1288
|
-
"summary": "
|
|
1284
|
+
"summary": "Check or poll for the status of a deploy operation.",
|
|
1289
1285
|
"enableJsonFlag": true,
|
|
1290
|
-
"requiresProject": true,
|
|
1291
1286
|
"isESM": true,
|
|
1292
1287
|
"relativePath": [
|
|
1293
1288
|
"lib",
|
|
1294
1289
|
"commands",
|
|
1295
1290
|
"project",
|
|
1296
1291
|
"deploy",
|
|
1297
|
-
"
|
|
1292
|
+
"report.js"
|
|
1298
1293
|
],
|
|
1299
1294
|
"aliasPermutations": [
|
|
1300
|
-
"deploy:metadata:
|
|
1301
|
-
"metadata:deploy:
|
|
1302
|
-
"metadata:
|
|
1303
|
-
"deploy:
|
|
1304
|
-
"
|
|
1305
|
-
"
|
|
1295
|
+
"deploy:metadata:report",
|
|
1296
|
+
"metadata:deploy:report",
|
|
1297
|
+
"metadata:report:deploy",
|
|
1298
|
+
"deploy:report:metadata",
|
|
1299
|
+
"report:deploy:metadata",
|
|
1300
|
+
"report:metadata:deploy"
|
|
1306
1301
|
],
|
|
1307
1302
|
"permutations": [
|
|
1308
|
-
"project:deploy:
|
|
1309
|
-
"deploy:project:
|
|
1310
|
-
"deploy:
|
|
1311
|
-
"project:
|
|
1312
|
-
"
|
|
1313
|
-
"
|
|
1303
|
+
"project:deploy:report",
|
|
1304
|
+
"deploy:project:report",
|
|
1305
|
+
"deploy:report:project",
|
|
1306
|
+
"project:report:deploy",
|
|
1307
|
+
"report:project:deploy",
|
|
1308
|
+
"report:deploy:project"
|
|
1314
1309
|
]
|
|
1315
1310
|
},
|
|
1316
|
-
"project:deploy:
|
|
1311
|
+
"project:deploy:resume": {
|
|
1317
1312
|
"aliases": [
|
|
1318
|
-
"deploy:metadata:
|
|
1313
|
+
"deploy:metadata:resume"
|
|
1319
1314
|
],
|
|
1320
1315
|
"args": {},
|
|
1321
1316
|
"deprecateAliases": true,
|
|
1322
|
-
"description": "
|
|
1317
|
+
"description": "Use this command to resume watching a deploy operation if the original command times out or you specified the --async flag. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations. This command doesn't resume the original operation itself, because the operation always continues after you've started it, regardless of whether you're watching it or not. When the deploy completes, source tracking information is updated as needed.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
1323
1318
|
"examples": [
|
|
1324
|
-
"
|
|
1325
|
-
"
|
|
1319
|
+
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1320
|
+
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1326
1321
|
],
|
|
1327
1322
|
"flags": {
|
|
1328
1323
|
"json": {
|
|
@@ -1340,48 +1335,29 @@
|
|
|
1340
1335
|
"multiple": false,
|
|
1341
1336
|
"type": "option"
|
|
1342
1337
|
},
|
|
1343
|
-
"async": {
|
|
1344
|
-
"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\".",
|
|
1345
|
-
"exclusive": [
|
|
1346
|
-
"wait"
|
|
1347
|
-
],
|
|
1348
|
-
"name": "async",
|
|
1349
|
-
"summary": "Run the command asynchronously.",
|
|
1350
|
-
"allowNo": false,
|
|
1351
|
-
"type": "boolean"
|
|
1352
|
-
},
|
|
1353
1338
|
"concise": {
|
|
1354
1339
|
"exclusive": [
|
|
1355
1340
|
"verbose"
|
|
1356
1341
|
],
|
|
1357
1342
|
"name": "concise",
|
|
1358
|
-
"summary": "Show concise output of the deploy result.",
|
|
1343
|
+
"summary": "Show concise output of the deploy operation result.",
|
|
1359
1344
|
"allowNo": false,
|
|
1360
1345
|
"type": "boolean"
|
|
1361
1346
|
},
|
|
1362
1347
|
"job-id": {
|
|
1363
1348
|
"char": "i",
|
|
1364
|
-
"description": "
|
|
1349
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
1365
1350
|
"name": "job-id",
|
|
1366
|
-
"summary": "Job ID of the
|
|
1351
|
+
"summary": "Job ID of the deploy operation you want to resume.",
|
|
1367
1352
|
"hasDynamicHelp": false,
|
|
1368
1353
|
"multiple": false,
|
|
1369
1354
|
"type": "option"
|
|
1370
1355
|
},
|
|
1371
|
-
"target-org": {
|
|
1372
|
-
"char": "o",
|
|
1373
|
-
"name": "target-org",
|
|
1374
|
-
"noCacheDefault": true,
|
|
1375
|
-
"summary": "Username or alias of the target org.",
|
|
1376
|
-
"hasDynamicHelp": true,
|
|
1377
|
-
"multiple": false,
|
|
1378
|
-
"type": "option"
|
|
1379
|
-
},
|
|
1380
1356
|
"use-most-recent": {
|
|
1381
1357
|
"char": "r",
|
|
1382
|
-
"description": "For performance reasons, this flag uses
|
|
1358
|
+
"description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.",
|
|
1383
1359
|
"name": "use-most-recent",
|
|
1384
|
-
"summary": "Use the job ID of the most
|
|
1360
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1385
1361
|
"allowNo": false,
|
|
1386
1362
|
"type": "boolean"
|
|
1387
1363
|
},
|
|
@@ -1390,29 +1366,62 @@
|
|
|
1390
1366
|
"concise"
|
|
1391
1367
|
],
|
|
1392
1368
|
"name": "verbose",
|
|
1393
|
-
"summary": "Show verbose output of the deploy result.",
|
|
1369
|
+
"summary": "Show verbose output of the deploy operation result.",
|
|
1394
1370
|
"allowNo": false,
|
|
1395
1371
|
"type": "boolean"
|
|
1396
1372
|
},
|
|
1397
1373
|
"wait": {
|
|
1398
1374
|
"char": "w",
|
|
1399
|
-
"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
|
|
1400
|
-
"exclusive": [
|
|
1401
|
-
"async"
|
|
1402
|
-
],
|
|
1375
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy operation, run this command again. To check the status of the deploy operation, run \"<%= config.bin %> project deploy report\".",
|
|
1403
1376
|
"name": "wait",
|
|
1404
1377
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1405
|
-
"default": "33 minutes",
|
|
1406
1378
|
"hasDynamicHelp": true,
|
|
1407
1379
|
"helpValue": "<minutes>",
|
|
1408
1380
|
"multiple": false,
|
|
1409
1381
|
"type": "option"
|
|
1410
1382
|
},
|
|
1411
|
-
"
|
|
1412
|
-
"
|
|
1413
|
-
"
|
|
1414
|
-
"name": "
|
|
1415
|
-
"summary": "
|
|
1383
|
+
"coverage-formatters": {
|
|
1384
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1385
|
+
"helpGroup": "Test",
|
|
1386
|
+
"name": "coverage-formatters",
|
|
1387
|
+
"summary": "Format of the code coverage results.",
|
|
1388
|
+
"hasDynamicHelp": false,
|
|
1389
|
+
"multiple": true,
|
|
1390
|
+
"options": [
|
|
1391
|
+
"clover",
|
|
1392
|
+
"cobertura",
|
|
1393
|
+
"html-spa",
|
|
1394
|
+
"html",
|
|
1395
|
+
"json",
|
|
1396
|
+
"json-summary",
|
|
1397
|
+
"lcovonly",
|
|
1398
|
+
"none",
|
|
1399
|
+
"teamcity",
|
|
1400
|
+
"text",
|
|
1401
|
+
"text-summary"
|
|
1402
|
+
],
|
|
1403
|
+
"type": "option"
|
|
1404
|
+
},
|
|
1405
|
+
"junit": {
|
|
1406
|
+
"helpGroup": "Test",
|
|
1407
|
+
"name": "junit",
|
|
1408
|
+
"summary": "Output JUnit test results.",
|
|
1409
|
+
"allowNo": false,
|
|
1410
|
+
"type": "boolean"
|
|
1411
|
+
},
|
|
1412
|
+
"results-dir": {
|
|
1413
|
+
"helpGroup": "Test",
|
|
1414
|
+
"name": "results-dir",
|
|
1415
|
+
"relationships": [
|
|
1416
|
+
{
|
|
1417
|
+
"type": "some",
|
|
1418
|
+
"flags": [
|
|
1419
|
+
"coverage-formatters",
|
|
1420
|
+
"junit"
|
|
1421
|
+
]
|
|
1422
|
+
}
|
|
1423
|
+
],
|
|
1424
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
1416
1425
|
"hasDynamicHelp": false,
|
|
1417
1426
|
"multiple": false,
|
|
1418
1427
|
"type": "option"
|
|
@@ -1420,13 +1429,22 @@
|
|
|
1420
1429
|
},
|
|
1421
1430
|
"hasDynamicHelp": true,
|
|
1422
1431
|
"hiddenAliases": [],
|
|
1423
|
-
"id": "project:deploy:
|
|
1432
|
+
"id": "project:deploy:resume",
|
|
1424
1433
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1425
1434
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1426
1435
|
"pluginType": "core",
|
|
1427
1436
|
"strict": true,
|
|
1428
|
-
"summary": "
|
|
1437
|
+
"summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
|
|
1429
1438
|
"enableJsonFlag": true,
|
|
1439
|
+
"envVariablesSection": {
|
|
1440
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1441
|
+
"body": [
|
|
1442
|
+
{
|
|
1443
|
+
"name": "SF_USE_PROGRESS_BAR",
|
|
1444
|
+
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1445
|
+
}
|
|
1446
|
+
]
|
|
1447
|
+
},
|
|
1430
1448
|
"errorCodes": {
|
|
1431
1449
|
"header": "ERROR CODES",
|
|
1432
1450
|
"body": [
|
|
@@ -1466,36 +1484,47 @@
|
|
|
1466
1484
|
"commands",
|
|
1467
1485
|
"project",
|
|
1468
1486
|
"deploy",
|
|
1469
|
-
"
|
|
1487
|
+
"resume.js"
|
|
1470
1488
|
],
|
|
1471
1489
|
"aliasPermutations": [
|
|
1472
|
-
"deploy:metadata:
|
|
1473
|
-
"metadata:deploy:
|
|
1474
|
-
"metadata:
|
|
1475
|
-
"deploy:
|
|
1476
|
-
"
|
|
1477
|
-
"
|
|
1490
|
+
"deploy:metadata:resume",
|
|
1491
|
+
"metadata:deploy:resume",
|
|
1492
|
+
"metadata:resume:deploy",
|
|
1493
|
+
"deploy:resume:metadata",
|
|
1494
|
+
"resume:deploy:metadata",
|
|
1495
|
+
"resume:metadata:deploy"
|
|
1478
1496
|
],
|
|
1479
1497
|
"permutations": [
|
|
1480
|
-
"project:deploy:
|
|
1481
|
-
"deploy:project:
|
|
1482
|
-
"deploy:
|
|
1483
|
-
"project:
|
|
1484
|
-
"
|
|
1485
|
-
"
|
|
1498
|
+
"project:deploy:resume",
|
|
1499
|
+
"deploy:project:resume",
|
|
1500
|
+
"deploy:resume:project",
|
|
1501
|
+
"project:resume:deploy",
|
|
1502
|
+
"resume:project:deploy",
|
|
1503
|
+
"resume:deploy:project"
|
|
1486
1504
|
]
|
|
1487
1505
|
},
|
|
1488
|
-
"project:deploy:
|
|
1506
|
+
"project:deploy:start": {
|
|
1489
1507
|
"aliases": [
|
|
1490
|
-
"deploy:metadata
|
|
1508
|
+
"deploy:metadata"
|
|
1491
1509
|
],
|
|
1492
1510
|
"args": {},
|
|
1493
1511
|
"deprecateAliases": true,
|
|
1494
|
-
"description": "
|
|
1512
|
+
"description": "You must run this command from within a project.\n\nMetadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
|
|
1495
1513
|
"examples": [
|
|
1496
|
-
"
|
|
1497
|
-
"
|
|
1498
|
-
"
|
|
1514
|
+
"Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1515
|
+
"Deploy all source files in the \"force-app\" directory to an org with alias \"my-scratch\"; show only concise output, in other words don't print a list of all the source that was deployed:\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch --concise",
|
|
1516
|
+
"Deploy all the Apex classes and custom objects that are in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
|
|
1517
|
+
"Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
1518
|
+
"Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
|
|
1519
|
+
"Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings",
|
|
1520
|
+
"Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
|
|
1521
|
+
"Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
|
|
1522
|
+
"Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
|
|
1523
|
+
"Deploy all Apex classes and a profile that has a space in its name:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --metadata \"Profile:My Profile\"",
|
|
1524
|
+
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1525
|
+
"Run the tests that aren’t in any managed packages as part of a deployment:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests",
|
|
1526
|
+
"Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
|
|
1527
|
+
"Deploy all metadata formatted files in the \"MDAPI\" directory; items listed in the MDAPI/destructiveChangesPre.xml and MDAPI/destructiveChangesPost.xml manifests are immediately eligible for deletion rather than stored in the Recycle Bin:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI --purge-on-delete"
|
|
1499
1528
|
],
|
|
1500
1529
|
"flags": {
|
|
1501
1530
|
"json": {
|
|
@@ -1513,32 +1542,229 @@
|
|
|
1513
1542
|
"multiple": false,
|
|
1514
1543
|
"type": "option"
|
|
1515
1544
|
},
|
|
1545
|
+
"api-version": {
|
|
1546
|
+
"char": "a",
|
|
1547
|
+
"description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
|
|
1548
|
+
"name": "api-version",
|
|
1549
|
+
"summary": "Target API version for the deploy.",
|
|
1550
|
+
"hasDynamicHelp": false,
|
|
1551
|
+
"multiple": false,
|
|
1552
|
+
"type": "option"
|
|
1553
|
+
},
|
|
1554
|
+
"async": {
|
|
1555
|
+
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
|
|
1556
|
+
"exclusive": [
|
|
1557
|
+
"wait"
|
|
1558
|
+
],
|
|
1559
|
+
"name": "async",
|
|
1560
|
+
"summary": "Run the command asynchronously.",
|
|
1561
|
+
"allowNo": false,
|
|
1562
|
+
"type": "boolean"
|
|
1563
|
+
},
|
|
1564
|
+
"concise": {
|
|
1565
|
+
"exclusive": [
|
|
1566
|
+
"verbose"
|
|
1567
|
+
],
|
|
1568
|
+
"name": "concise",
|
|
1569
|
+
"summary": "Show concise output of the deploy result.",
|
|
1570
|
+
"allowNo": false,
|
|
1571
|
+
"type": "boolean"
|
|
1572
|
+
},
|
|
1573
|
+
"dry-run": {
|
|
1574
|
+
"name": "dry-run",
|
|
1575
|
+
"summary": "Validate deploy and run Apex tests but don’t save to the org.",
|
|
1576
|
+
"allowNo": false,
|
|
1577
|
+
"type": "boolean"
|
|
1578
|
+
},
|
|
1579
|
+
"ignore-conflicts": {
|
|
1580
|
+
"char": "c",
|
|
1581
|
+
"description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
|
|
1582
|
+
"name": "ignore-conflicts",
|
|
1583
|
+
"summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
|
|
1584
|
+
"allowNo": false,
|
|
1585
|
+
"type": "boolean"
|
|
1586
|
+
},
|
|
1587
|
+
"ignore-errors": {
|
|
1588
|
+
"char": "r",
|
|
1589
|
+
"description": "Never use this flag when deploying to a production org. If you specify it, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
|
|
1590
|
+
"name": "ignore-errors",
|
|
1591
|
+
"summary": "Ignore any errors and don’t roll back deployment.",
|
|
1592
|
+
"allowNo": false,
|
|
1593
|
+
"type": "boolean"
|
|
1594
|
+
},
|
|
1595
|
+
"ignore-warnings": {
|
|
1596
|
+
"char": "g",
|
|
1597
|
+
"description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
|
|
1598
|
+
"name": "ignore-warnings",
|
|
1599
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1600
|
+
"allowNo": false,
|
|
1601
|
+
"type": "boolean"
|
|
1602
|
+
},
|
|
1603
|
+
"manifest": {
|
|
1604
|
+
"char": "x",
|
|
1605
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1606
|
+
"exclusive": [
|
|
1607
|
+
"source-dir",
|
|
1608
|
+
"metadata",
|
|
1609
|
+
"metadata-dir"
|
|
1610
|
+
],
|
|
1611
|
+
"helpGroup": "Source Format",
|
|
1612
|
+
"name": "manifest",
|
|
1613
|
+
"summary": "Full file path for manifest (package.xml) of components to deploy.",
|
|
1614
|
+
"hasDynamicHelp": false,
|
|
1615
|
+
"multiple": false,
|
|
1616
|
+
"type": "option"
|
|
1617
|
+
},
|
|
1618
|
+
"metadata": {
|
|
1619
|
+
"char": "m",
|
|
1620
|
+
"exclusive": [
|
|
1621
|
+
"manifest",
|
|
1622
|
+
"source-dir",
|
|
1623
|
+
"metadata-dir"
|
|
1624
|
+
],
|
|
1625
|
+
"helpGroup": "Source Format",
|
|
1626
|
+
"name": "metadata",
|
|
1627
|
+
"summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
|
|
1628
|
+
"hasDynamicHelp": false,
|
|
1629
|
+
"multiple": true,
|
|
1630
|
+
"type": "option"
|
|
1631
|
+
},
|
|
1632
|
+
"metadata-dir": {
|
|
1633
|
+
"exclusive": [
|
|
1634
|
+
"manifest",
|
|
1635
|
+
"source-dir",
|
|
1636
|
+
"metadata"
|
|
1637
|
+
],
|
|
1638
|
+
"helpGroup": "Metadata API Format",
|
|
1639
|
+
"name": "metadata-dir",
|
|
1640
|
+
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1641
|
+
"hasDynamicHelp": false,
|
|
1642
|
+
"multiple": false,
|
|
1643
|
+
"type": "option"
|
|
1644
|
+
},
|
|
1645
|
+
"single-package": {
|
|
1646
|
+
"dependsOn": [
|
|
1647
|
+
"metadata-dir"
|
|
1648
|
+
],
|
|
1649
|
+
"helpGroup": "Metadata API Format",
|
|
1650
|
+
"name": "single-package",
|
|
1651
|
+
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1652
|
+
"allowNo": false,
|
|
1653
|
+
"type": "boolean"
|
|
1654
|
+
},
|
|
1655
|
+
"source-dir": {
|
|
1656
|
+
"char": "d",
|
|
1657
|
+
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
|
|
1658
|
+
"exclusive": [
|
|
1659
|
+
"manifest",
|
|
1660
|
+
"metadata",
|
|
1661
|
+
"metadata-dir"
|
|
1662
|
+
],
|
|
1663
|
+
"helpGroup": "Source Format",
|
|
1664
|
+
"name": "source-dir",
|
|
1665
|
+
"summary": "Path to the local source files to deploy.",
|
|
1666
|
+
"hasDynamicHelp": false,
|
|
1667
|
+
"multiple": true,
|
|
1668
|
+
"type": "option"
|
|
1669
|
+
},
|
|
1516
1670
|
"target-org": {
|
|
1517
1671
|
"char": "o",
|
|
1518
1672
|
"name": "target-org",
|
|
1519
1673
|
"noCacheDefault": true,
|
|
1520
|
-
"
|
|
1674
|
+
"required": true,
|
|
1675
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1521
1676
|
"hasDynamicHelp": true,
|
|
1522
1677
|
"multiple": false,
|
|
1523
1678
|
"type": "option"
|
|
1524
1679
|
},
|
|
1525
|
-
"
|
|
1526
|
-
"char": "
|
|
1527
|
-
"description": "
|
|
1528
|
-
"
|
|
1529
|
-
"
|
|
1680
|
+
"tests": {
|
|
1681
|
+
"char": "t",
|
|
1682
|
+
"description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
|
|
1683
|
+
"helpGroup": "Test",
|
|
1684
|
+
"name": "tests",
|
|
1685
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1686
|
+
"hasDynamicHelp": false,
|
|
1687
|
+
"multiple": true,
|
|
1688
|
+
"type": "option"
|
|
1689
|
+
},
|
|
1690
|
+
"test-level": {
|
|
1691
|
+
"char": "l",
|
|
1692
|
+
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\n If you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
|
|
1693
|
+
"helpGroup": "Test",
|
|
1694
|
+
"name": "test-level",
|
|
1695
|
+
"summary": "Deployment Apex testing level.",
|
|
1530
1696
|
"hasDynamicHelp": false,
|
|
1531
1697
|
"multiple": false,
|
|
1698
|
+
"options": [
|
|
1699
|
+
"NoTestRun",
|
|
1700
|
+
"RunSpecifiedTests",
|
|
1701
|
+
"RunLocalTests",
|
|
1702
|
+
"RunAllTestsInOrg"
|
|
1703
|
+
],
|
|
1532
1704
|
"type": "option"
|
|
1533
1705
|
},
|
|
1534
|
-
"
|
|
1535
|
-
"
|
|
1536
|
-
|
|
1537
|
-
|
|
1538
|
-
"
|
|
1706
|
+
"verbose": {
|
|
1707
|
+
"exclusive": [
|
|
1708
|
+
"concise"
|
|
1709
|
+
],
|
|
1710
|
+
"name": "verbose",
|
|
1711
|
+
"summary": "Show verbose output of the deploy result.",
|
|
1712
|
+
"allowNo": false,
|
|
1713
|
+
"type": "boolean"
|
|
1714
|
+
},
|
|
1715
|
+
"wait": {
|
|
1716
|
+
"char": "w",
|
|
1717
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
|
|
1718
|
+
"exclusive": [
|
|
1719
|
+
"async"
|
|
1720
|
+
],
|
|
1721
|
+
"name": "wait",
|
|
1722
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1723
|
+
"hasDynamicHelp": true,
|
|
1724
|
+
"helpValue": "<minutes>",
|
|
1725
|
+
"multiple": false,
|
|
1726
|
+
"type": "option"
|
|
1727
|
+
},
|
|
1728
|
+
"purge-on-delete": {
|
|
1729
|
+
"helpGroup": "Delete",
|
|
1730
|
+
"name": "purge-on-delete",
|
|
1731
|
+
"relationships": [
|
|
1732
|
+
{
|
|
1733
|
+
"type": "some",
|
|
1734
|
+
"flags": [
|
|
1735
|
+
"pre-destructive-changes",
|
|
1736
|
+
"manifest",
|
|
1737
|
+
"metadata-dir",
|
|
1738
|
+
"post-destructive-changes"
|
|
1739
|
+
]
|
|
1740
|
+
}
|
|
1741
|
+
],
|
|
1742
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1539
1743
|
"allowNo": false,
|
|
1540
1744
|
"type": "boolean"
|
|
1541
1745
|
},
|
|
1746
|
+
"pre-destructive-changes": {
|
|
1747
|
+
"dependsOn": [
|
|
1748
|
+
"manifest"
|
|
1749
|
+
],
|
|
1750
|
+
"helpGroup": "Delete",
|
|
1751
|
+
"name": "pre-destructive-changes",
|
|
1752
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
|
|
1753
|
+
"hasDynamicHelp": false,
|
|
1754
|
+
"multiple": false,
|
|
1755
|
+
"type": "option"
|
|
1756
|
+
},
|
|
1757
|
+
"post-destructive-changes": {
|
|
1758
|
+
"dependsOn": [
|
|
1759
|
+
"manifest"
|
|
1760
|
+
],
|
|
1761
|
+
"helpGroup": "Delete",
|
|
1762
|
+
"name": "post-destructive-changes",
|
|
1763
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1764
|
+
"hasDynamicHelp": false,
|
|
1765
|
+
"multiple": false,
|
|
1766
|
+
"type": "option"
|
|
1767
|
+
},
|
|
1542
1768
|
"coverage-formatters": {
|
|
1543
1769
|
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1544
1770
|
"helpGroup": "Test",
|
|
@@ -1584,62 +1810,110 @@
|
|
|
1584
1810
|
"hasDynamicHelp": false,
|
|
1585
1811
|
"multiple": false,
|
|
1586
1812
|
"type": "option"
|
|
1587
|
-
},
|
|
1588
|
-
"wait": {
|
|
1589
|
-
"char": "w",
|
|
1590
|
-
"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\".",
|
|
1591
|
-
"name": "wait",
|
|
1592
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1593
|
-
"hasDynamicHelp": true,
|
|
1594
|
-
"helpValue": "<minutes>",
|
|
1595
|
-
"multiple": false,
|
|
1596
|
-
"type": "option"
|
|
1597
1813
|
}
|
|
1598
1814
|
},
|
|
1599
1815
|
"hasDynamicHelp": true,
|
|
1600
1816
|
"hiddenAliases": [],
|
|
1601
|
-
"id": "project:deploy:
|
|
1817
|
+
"id": "project:deploy:start",
|
|
1602
1818
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1603
1819
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1604
1820
|
"pluginType": "core",
|
|
1605
1821
|
"strict": true,
|
|
1606
|
-
"summary": "
|
|
1822
|
+
"summary": "Deploy metadata to an org from your local project.",
|
|
1607
1823
|
"enableJsonFlag": true,
|
|
1608
|
-
"
|
|
1609
|
-
|
|
1824
|
+
"configurationVariablesSection": {
|
|
1825
|
+
"header": "CONFIGURATION VARIABLES",
|
|
1826
|
+
"body": [
|
|
1827
|
+
{
|
|
1828
|
+
"name": "target-org",
|
|
1829
|
+
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1830
|
+
},
|
|
1831
|
+
{
|
|
1832
|
+
"name": "org-api-version",
|
|
1833
|
+
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1834
|
+
}
|
|
1835
|
+
]
|
|
1836
|
+
},
|
|
1837
|
+
"envVariablesSection": {
|
|
1838
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1839
|
+
"body": [
|
|
1840
|
+
{
|
|
1841
|
+
"name": "SF_TARGET_ORG",
|
|
1842
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1843
|
+
},
|
|
1844
|
+
{
|
|
1845
|
+
"name": "SF_USE_PROGRESS_BAR",
|
|
1846
|
+
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1847
|
+
}
|
|
1848
|
+
]
|
|
1849
|
+
},
|
|
1850
|
+
"errorCodes": {
|
|
1851
|
+
"header": "ERROR CODES",
|
|
1852
|
+
"body": [
|
|
1853
|
+
{
|
|
1854
|
+
"name": "Succeeded (0)",
|
|
1855
|
+
"description": "The deploy succeeded."
|
|
1856
|
+
},
|
|
1857
|
+
{
|
|
1858
|
+
"name": "Canceled (1)",
|
|
1859
|
+
"description": "The deploy was canceled."
|
|
1860
|
+
},
|
|
1861
|
+
{
|
|
1862
|
+
"name": "Failed (1)",
|
|
1863
|
+
"description": "The deploy failed."
|
|
1864
|
+
},
|
|
1865
|
+
{
|
|
1866
|
+
"name": "SucceededPartial (68)",
|
|
1867
|
+
"description": "The deploy partially succeeded."
|
|
1868
|
+
},
|
|
1869
|
+
{
|
|
1870
|
+
"name": "InProgress (69)",
|
|
1871
|
+
"description": "The deploy is in progress."
|
|
1872
|
+
},
|
|
1873
|
+
{
|
|
1874
|
+
"name": "Pending (69)",
|
|
1875
|
+
"description": "The deploy is pending."
|
|
1876
|
+
},
|
|
1877
|
+
{
|
|
1878
|
+
"name": "Canceling (69)",
|
|
1879
|
+
"description": "The deploy is being canceled."
|
|
1880
|
+
}
|
|
1881
|
+
]
|
|
1882
|
+
},
|
|
1883
|
+
"isESM": true,
|
|
1884
|
+
"relativePath": [
|
|
1610
1885
|
"lib",
|
|
1611
1886
|
"commands",
|
|
1612
1887
|
"project",
|
|
1613
1888
|
"deploy",
|
|
1614
|
-
"
|
|
1889
|
+
"start.js"
|
|
1615
1890
|
],
|
|
1616
1891
|
"aliasPermutations": [
|
|
1617
|
-
"deploy:metadata
|
|
1618
|
-
"metadata:deploy
|
|
1619
|
-
"metadata:report:deploy",
|
|
1620
|
-
"deploy:report:metadata",
|
|
1621
|
-
"report:deploy:metadata",
|
|
1622
|
-
"report:metadata:deploy"
|
|
1892
|
+
"deploy:metadata",
|
|
1893
|
+
"metadata:deploy"
|
|
1623
1894
|
],
|
|
1624
1895
|
"permutations": [
|
|
1625
|
-
"project:deploy:
|
|
1626
|
-
"deploy:project:
|
|
1627
|
-
"deploy:
|
|
1628
|
-
"project:
|
|
1629
|
-
"
|
|
1630
|
-
"
|
|
1896
|
+
"project:deploy:start",
|
|
1897
|
+
"deploy:project:start",
|
|
1898
|
+
"deploy:start:project",
|
|
1899
|
+
"project:start:deploy",
|
|
1900
|
+
"start:project:deploy",
|
|
1901
|
+
"start:deploy:project"
|
|
1631
1902
|
]
|
|
1632
1903
|
},
|
|
1633
|
-
"project:deploy:
|
|
1904
|
+
"project:deploy:validate": {
|
|
1634
1905
|
"aliases": [
|
|
1635
|
-
"deploy:metadata:
|
|
1906
|
+
"deploy:metadata:validate"
|
|
1636
1907
|
],
|
|
1637
1908
|
"args": {},
|
|
1638
1909
|
"deprecateAliases": true,
|
|
1639
|
-
"description": "Use this command to
|
|
1910
|
+
"description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"<%= config.bin %> project deploy start\", except you're required to run Apex tests, and the command returns a job ID rather than executing the deployment. If the validation succeeds, then you pass this job ID to the \"<%= config.bin %> project deploy quick\" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests. The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nYou must run this command from within a project.\n\nThis command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.\n\nTo validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use \"<%= config.bin %> project deploy start --dry-run --test-level RunLocalTests\" instead.",
|
|
1640
1911
|
"examples": [
|
|
1641
|
-
"
|
|
1642
|
-
"
|
|
1912
|
+
"NOTE: These examples focus on validating large deployments. See the help for \"<%= config.bin %> project deploy start\" for examples of deploying smaller sets of metadata which you can also use to validate.",
|
|
1913
|
+
"Validate the deployment of all source files in the \"force-app\" directory to the default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
|
|
1914
|
+
"Validate the deployment of all source files in two directories: \"force-app\" and \"force-app-utils\":\n<%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils",
|
|
1915
|
+
"Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\n<%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org",
|
|
1916
|
+
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
1643
1917
|
],
|
|
1644
1918
|
"flags": {
|
|
1645
1919
|
"json": {
|
|
@@ -1657,44 +1931,126 @@
|
|
|
1657
1931
|
"multiple": false,
|
|
1658
1932
|
"type": "option"
|
|
1659
1933
|
},
|
|
1934
|
+
"api-version": {
|
|
1935
|
+
"char": "a",
|
|
1936
|
+
"description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
|
|
1937
|
+
"name": "api-version",
|
|
1938
|
+
"summary": "Target API version for the validation.",
|
|
1939
|
+
"hasDynamicHelp": false,
|
|
1940
|
+
"multiple": false,
|
|
1941
|
+
"type": "option"
|
|
1942
|
+
},
|
|
1943
|
+
"async": {
|
|
1944
|
+
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
|
|
1945
|
+
"name": "async",
|
|
1946
|
+
"summary": "Run the command asynchronously.",
|
|
1947
|
+
"allowNo": false,
|
|
1948
|
+
"type": "boolean"
|
|
1949
|
+
},
|
|
1660
1950
|
"concise": {
|
|
1661
1951
|
"exclusive": [
|
|
1662
1952
|
"verbose"
|
|
1663
1953
|
],
|
|
1664
1954
|
"name": "concise",
|
|
1665
|
-
"summary": "Show concise output of the
|
|
1955
|
+
"summary": "Show concise output of the validation result.",
|
|
1666
1956
|
"allowNo": false,
|
|
1667
1957
|
"type": "boolean"
|
|
1668
1958
|
},
|
|
1669
|
-
"
|
|
1670
|
-
"char": "
|
|
1671
|
-
"description": "
|
|
1672
|
-
"
|
|
1673
|
-
"
|
|
1959
|
+
"manifest": {
|
|
1960
|
+
"char": "x",
|
|
1961
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1962
|
+
"helpGroup": "Source Format",
|
|
1963
|
+
"name": "manifest",
|
|
1964
|
+
"summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
|
|
1674
1965
|
"hasDynamicHelp": false,
|
|
1675
1966
|
"multiple": false,
|
|
1676
1967
|
"type": "option"
|
|
1677
1968
|
},
|
|
1678
|
-
"
|
|
1679
|
-
"char": "
|
|
1680
|
-
"
|
|
1681
|
-
"name": "
|
|
1682
|
-
"summary": "
|
|
1969
|
+
"metadata": {
|
|
1970
|
+
"char": "m",
|
|
1971
|
+
"helpGroup": "Source Format",
|
|
1972
|
+
"name": "metadata",
|
|
1973
|
+
"summary": "Metadata component names to validate for deployment.",
|
|
1974
|
+
"hasDynamicHelp": false,
|
|
1975
|
+
"multiple": true,
|
|
1976
|
+
"type": "option"
|
|
1977
|
+
},
|
|
1978
|
+
"source-dir": {
|
|
1979
|
+
"char": "d",
|
|
1980
|
+
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
|
|
1981
|
+
"helpGroup": "Source Format",
|
|
1982
|
+
"name": "source-dir",
|
|
1983
|
+
"summary": "Path to the local source files to validate for deployment.",
|
|
1984
|
+
"hasDynamicHelp": false,
|
|
1985
|
+
"multiple": true,
|
|
1986
|
+
"type": "option"
|
|
1987
|
+
},
|
|
1988
|
+
"metadata-dir": {
|
|
1989
|
+
"helpGroup": "Metadata API Format",
|
|
1990
|
+
"name": "metadata-dir",
|
|
1991
|
+
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1992
|
+
"hasDynamicHelp": false,
|
|
1993
|
+
"multiple": false,
|
|
1994
|
+
"type": "option"
|
|
1995
|
+
},
|
|
1996
|
+
"single-package": {
|
|
1997
|
+
"dependsOn": [
|
|
1998
|
+
"metadata-dir"
|
|
1999
|
+
],
|
|
2000
|
+
"helpGroup": "Metadata API Format",
|
|
2001
|
+
"name": "single-package",
|
|
2002
|
+
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1683
2003
|
"allowNo": false,
|
|
1684
2004
|
"type": "boolean"
|
|
1685
2005
|
},
|
|
2006
|
+
"target-org": {
|
|
2007
|
+
"char": "o",
|
|
2008
|
+
"name": "target-org",
|
|
2009
|
+
"noCacheDefault": true,
|
|
2010
|
+
"required": true,
|
|
2011
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2012
|
+
"hasDynamicHelp": true,
|
|
2013
|
+
"multiple": false,
|
|
2014
|
+
"type": "option"
|
|
2015
|
+
},
|
|
2016
|
+
"tests": {
|
|
2017
|
+
"char": "t",
|
|
2018
|
+
"description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
|
|
2019
|
+
"helpGroup": "Test",
|
|
2020
|
+
"name": "tests",
|
|
2021
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2022
|
+
"hasDynamicHelp": false,
|
|
2023
|
+
"multiple": true,
|
|
2024
|
+
"type": "option"
|
|
2025
|
+
},
|
|
2026
|
+
"test-level": {
|
|
2027
|
+
"char": "l",
|
|
2028
|
+
"description": "Valid values are:\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.",
|
|
2029
|
+
"helpGroup": "Test",
|
|
2030
|
+
"name": "test-level",
|
|
2031
|
+
"summary": "Deployment Apex testing level.",
|
|
2032
|
+
"default": "RunLocalTests",
|
|
2033
|
+
"hasDynamicHelp": false,
|
|
2034
|
+
"multiple": false,
|
|
2035
|
+
"options": [
|
|
2036
|
+
"RunAllTestsInOrg",
|
|
2037
|
+
"RunLocalTests",
|
|
2038
|
+
"RunSpecifiedTests"
|
|
2039
|
+
],
|
|
2040
|
+
"type": "option"
|
|
2041
|
+
},
|
|
1686
2042
|
"verbose": {
|
|
1687
2043
|
"exclusive": [
|
|
1688
2044
|
"concise"
|
|
1689
2045
|
],
|
|
1690
2046
|
"name": "verbose",
|
|
1691
|
-
"summary": "Show verbose output of the
|
|
2047
|
+
"summary": "Show verbose output of the validation result.",
|
|
1692
2048
|
"allowNo": false,
|
|
1693
2049
|
"type": "boolean"
|
|
1694
2050
|
},
|
|
1695
2051
|
"wait": {
|
|
1696
2052
|
"char": "w",
|
|
1697
|
-
"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
|
|
2053
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
|
|
1698
2054
|
"name": "wait",
|
|
1699
2055
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1700
2056
|
"hasDynamicHelp": true,
|
|
@@ -1702,6 +2058,14 @@
|
|
|
1702
2058
|
"multiple": false,
|
|
1703
2059
|
"type": "option"
|
|
1704
2060
|
},
|
|
2061
|
+
"ignore-warnings": {
|
|
2062
|
+
"char": "g",
|
|
2063
|
+
"description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
|
|
2064
|
+
"name": "ignore-warnings",
|
|
2065
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
2066
|
+
"allowNo": false,
|
|
2067
|
+
"type": "boolean"
|
|
2068
|
+
},
|
|
1705
2069
|
"coverage-formatters": {
|
|
1706
2070
|
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1707
2071
|
"helpGroup": "Test",
|
|
@@ -1747,20 +2111,78 @@
|
|
|
1747
2111
|
"hasDynamicHelp": false,
|
|
1748
2112
|
"multiple": false,
|
|
1749
2113
|
"type": "option"
|
|
2114
|
+
},
|
|
2115
|
+
"purge-on-delete": {
|
|
2116
|
+
"dependsOn": [
|
|
2117
|
+
"manifest"
|
|
2118
|
+
],
|
|
2119
|
+
"helpGroup": "Delete",
|
|
2120
|
+
"name": "purge-on-delete",
|
|
2121
|
+
"relationships": [
|
|
2122
|
+
{
|
|
2123
|
+
"type": "some",
|
|
2124
|
+
"flags": [
|
|
2125
|
+
"pre-destructive-changes",
|
|
2126
|
+
"post-destructive-changes"
|
|
2127
|
+
]
|
|
2128
|
+
}
|
|
2129
|
+
],
|
|
2130
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
2131
|
+
"allowNo": false,
|
|
2132
|
+
"type": "boolean"
|
|
2133
|
+
},
|
|
2134
|
+
"pre-destructive-changes": {
|
|
2135
|
+
"dependsOn": [
|
|
2136
|
+
"manifest"
|
|
2137
|
+
],
|
|
2138
|
+
"helpGroup": "Delete",
|
|
2139
|
+
"name": "pre-destructive-changes",
|
|
2140
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
2141
|
+
"hasDynamicHelp": false,
|
|
2142
|
+
"multiple": false,
|
|
2143
|
+
"type": "option"
|
|
2144
|
+
},
|
|
2145
|
+
"post-destructive-changes": {
|
|
2146
|
+
"dependsOn": [
|
|
2147
|
+
"manifest"
|
|
2148
|
+
],
|
|
2149
|
+
"helpGroup": "Delete",
|
|
2150
|
+
"name": "post-destructive-changes",
|
|
2151
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
2152
|
+
"hasDynamicHelp": false,
|
|
2153
|
+
"multiple": false,
|
|
2154
|
+
"type": "option"
|
|
1750
2155
|
}
|
|
1751
2156
|
},
|
|
1752
2157
|
"hasDynamicHelp": true,
|
|
1753
2158
|
"hiddenAliases": [],
|
|
1754
|
-
"id": "project:deploy:
|
|
2159
|
+
"id": "project:deploy:validate",
|
|
1755
2160
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1756
2161
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1757
2162
|
"pluginType": "core",
|
|
1758
2163
|
"strict": true,
|
|
1759
|
-
"summary": "
|
|
2164
|
+
"summary": "Validate a metadata deployment without actually executing it.",
|
|
1760
2165
|
"enableJsonFlag": true,
|
|
2166
|
+
"configurationVariablesSection": {
|
|
2167
|
+
"header": "CONFIGURATION VARIABLES",
|
|
2168
|
+
"body": [
|
|
2169
|
+
{
|
|
2170
|
+
"name": "target-org",
|
|
2171
|
+
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
2172
|
+
},
|
|
2173
|
+
{
|
|
2174
|
+
"name": "org-api-version",
|
|
2175
|
+
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
2176
|
+
}
|
|
2177
|
+
]
|
|
2178
|
+
},
|
|
1761
2179
|
"envVariablesSection": {
|
|
1762
2180
|
"header": "ENVIRONMENT VARIABLES",
|
|
1763
2181
|
"body": [
|
|
2182
|
+
{
|
|
2183
|
+
"name": "SF_TARGET_ORG",
|
|
2184
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2185
|
+
},
|
|
1764
2186
|
{
|
|
1765
2187
|
"name": "SF_USE_PROGRESS_BAR",
|
|
1766
2188
|
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
@@ -1806,47 +2228,39 @@
|
|
|
1806
2228
|
"commands",
|
|
1807
2229
|
"project",
|
|
1808
2230
|
"deploy",
|
|
1809
|
-
"
|
|
2231
|
+
"validate.js"
|
|
1810
2232
|
],
|
|
1811
2233
|
"aliasPermutations": [
|
|
1812
|
-
"deploy:metadata:
|
|
1813
|
-
"metadata:deploy:
|
|
1814
|
-
"metadata:
|
|
1815
|
-
"deploy:
|
|
1816
|
-
"
|
|
1817
|
-
"
|
|
2234
|
+
"deploy:metadata:validate",
|
|
2235
|
+
"metadata:deploy:validate",
|
|
2236
|
+
"metadata:validate:deploy",
|
|
2237
|
+
"deploy:validate:metadata",
|
|
2238
|
+
"validate:deploy:metadata",
|
|
2239
|
+
"validate:metadata:deploy"
|
|
1818
2240
|
],
|
|
1819
2241
|
"permutations": [
|
|
1820
|
-
"project:deploy:
|
|
1821
|
-
"deploy:project:
|
|
1822
|
-
"deploy:
|
|
1823
|
-
"project:
|
|
1824
|
-
"
|
|
1825
|
-
"
|
|
2242
|
+
"project:deploy:validate",
|
|
2243
|
+
"deploy:project:validate",
|
|
2244
|
+
"deploy:validate:project",
|
|
2245
|
+
"project:validate:deploy",
|
|
2246
|
+
"validate:project:deploy",
|
|
2247
|
+
"validate:deploy:project"
|
|
1826
2248
|
]
|
|
1827
2249
|
},
|
|
1828
|
-
"project:
|
|
2250
|
+
"project:generate:manifest": {
|
|
1829
2251
|
"aliases": [
|
|
1830
|
-
"
|
|
2252
|
+
"force:source:manifest:create"
|
|
1831
2253
|
],
|
|
1832
2254
|
"args": {},
|
|
1833
2255
|
"deprecateAliases": true,
|
|
1834
|
-
"description": "
|
|
2256
|
+
"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.",
|
|
1835
2257
|
"examples": [
|
|
1836
|
-
"
|
|
1837
|
-
"
|
|
1838
|
-
"
|
|
1839
|
-
"
|
|
1840
|
-
"
|
|
1841
|
-
"
|
|
1842
|
-
"Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
|
|
1843
|
-
"Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
|
|
1844
|
-
"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",
|
|
1845
|
-
"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\"",
|
|
1846
|
-
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1847
|
-
"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",
|
|
1848
|
-
"Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
|
|
1849
|
-
"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"
|
|
2258
|
+
"Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject",
|
|
2259
|
+
"Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
|
|
2260
|
+
"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",
|
|
2261
|
+
"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",
|
|
2262
|
+
"Create a manifest from specific metadata types in an org:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --metadata ApexClass,CustomObject,CustomLabels",
|
|
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"
|
|
1850
2264
|
],
|
|
1851
2265
|
"flags": {
|
|
1852
2266
|
"json": {
|
|
@@ -1865,377 +2279,213 @@
|
|
|
1865
2279
|
"type": "option"
|
|
1866
2280
|
},
|
|
1867
2281
|
"api-version": {
|
|
1868
|
-
"
|
|
1869
|
-
|
|
2282
|
+
"aliases": [
|
|
2283
|
+
"apiversion"
|
|
2284
|
+
],
|
|
2285
|
+
"deprecateAliases": true,
|
|
2286
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1870
2287
|
"name": "api-version",
|
|
1871
|
-
"summary": "Target API version for the deploy.",
|
|
1872
2288
|
"hasDynamicHelp": false,
|
|
1873
2289
|
"multiple": false,
|
|
1874
2290
|
"type": "option"
|
|
1875
2291
|
},
|
|
1876
|
-
"
|
|
1877
|
-
"
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
"name": "
|
|
1882
|
-
"summary": "Run the command asynchronously.",
|
|
1883
|
-
"allowNo": false,
|
|
1884
|
-
"type": "boolean"
|
|
1885
|
-
},
|
|
1886
|
-
"concise": {
|
|
1887
|
-
"exclusive": [
|
|
1888
|
-
"verbose"
|
|
1889
|
-
],
|
|
1890
|
-
"name": "concise",
|
|
1891
|
-
"summary": "Show concise output of the deploy result.",
|
|
1892
|
-
"allowNo": false,
|
|
1893
|
-
"type": "boolean"
|
|
1894
|
-
},
|
|
1895
|
-
"dry-run": {
|
|
1896
|
-
"name": "dry-run",
|
|
1897
|
-
"summary": "Validate deploy and run Apex tests but don’t save to the org.",
|
|
1898
|
-
"allowNo": false,
|
|
1899
|
-
"type": "boolean"
|
|
1900
|
-
},
|
|
1901
|
-
"ignore-conflicts": {
|
|
1902
|
-
"char": "c",
|
|
1903
|
-
"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.",
|
|
1904
|
-
"name": "ignore-conflicts",
|
|
1905
|
-
"summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
|
|
1906
|
-
"allowNo": false,
|
|
1907
|
-
"type": "boolean"
|
|
1908
|
-
},
|
|
1909
|
-
"ignore-errors": {
|
|
1910
|
-
"char": "r",
|
|
1911
|
-
"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.",
|
|
1912
|
-
"name": "ignore-errors",
|
|
1913
|
-
"summary": "Ignore any errors and don’t roll back deployment.",
|
|
1914
|
-
"allowNo": false,
|
|
1915
|
-
"type": "boolean"
|
|
1916
|
-
},
|
|
1917
|
-
"ignore-warnings": {
|
|
1918
|
-
"char": "g",
|
|
1919
|
-
"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.",
|
|
1920
|
-
"name": "ignore-warnings",
|
|
1921
|
-
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1922
|
-
"allowNo": false,
|
|
1923
|
-
"type": "boolean"
|
|
1924
|
-
},
|
|
1925
|
-
"manifest": {
|
|
1926
|
-
"char": "x",
|
|
1927
|
-
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1928
|
-
"exclusive": [
|
|
1929
|
-
"source-dir",
|
|
1930
|
-
"metadata",
|
|
1931
|
-
"metadata-dir"
|
|
1932
|
-
],
|
|
1933
|
-
"helpGroup": "Source Format",
|
|
1934
|
-
"name": "manifest",
|
|
1935
|
-
"summary": "Full file path for manifest (package.xml) of components to deploy.",
|
|
2292
|
+
"loglevel": {
|
|
2293
|
+
"deprecated": {
|
|
2294
|
+
"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."
|
|
2295
|
+
},
|
|
2296
|
+
"hidden": true,
|
|
2297
|
+
"name": "loglevel",
|
|
1936
2298
|
"hasDynamicHelp": false,
|
|
1937
2299
|
"multiple": false,
|
|
1938
2300
|
"type": "option"
|
|
1939
2301
|
},
|
|
1940
2302
|
"metadata": {
|
|
1941
2303
|
"char": "m",
|
|
1942
|
-
"exclusive": [
|
|
1943
|
-
"manifest",
|
|
1944
|
-
"source-dir",
|
|
1945
|
-
"metadata-dir"
|
|
1946
|
-
],
|
|
1947
|
-
"helpGroup": "Source Format",
|
|
1948
2304
|
"name": "metadata",
|
|
1949
|
-
"summary": "
|
|
2305
|
+
"summary": "Names of metadata components to include in the manifest.",
|
|
2306
|
+
"delimiter": ",",
|
|
1950
2307
|
"hasDynamicHelp": false,
|
|
1951
2308
|
"multiple": true,
|
|
1952
2309
|
"type": "option"
|
|
1953
2310
|
},
|
|
1954
|
-
"
|
|
1955
|
-
"
|
|
1956
|
-
"
|
|
1957
|
-
"source-dir",
|
|
1958
|
-
"metadata"
|
|
2311
|
+
"source-dir": {
|
|
2312
|
+
"aliases": [
|
|
2313
|
+
"sourcepath"
|
|
1959
2314
|
],
|
|
1960
|
-
"
|
|
1961
|
-
"
|
|
1962
|
-
"
|
|
2315
|
+
"char": "p",
|
|
2316
|
+
"deprecateAliases": true,
|
|
2317
|
+
"name": "source-dir",
|
|
2318
|
+
"summary": "Paths to the local source files to include in the manifest.",
|
|
2319
|
+
"delimiter": ",",
|
|
1963
2320
|
"hasDynamicHelp": false,
|
|
1964
|
-
"multiple":
|
|
2321
|
+
"multiple": true,
|
|
1965
2322
|
"type": "option"
|
|
1966
2323
|
},
|
|
1967
|
-
"
|
|
1968
|
-
"
|
|
1969
|
-
"
|
|
2324
|
+
"name": {
|
|
2325
|
+
"aliases": [
|
|
2326
|
+
"manifestname"
|
|
1970
2327
|
],
|
|
1971
|
-
"
|
|
1972
|
-
"
|
|
1973
|
-
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1974
|
-
"allowNo": false,
|
|
1975
|
-
"type": "boolean"
|
|
1976
|
-
},
|
|
1977
|
-
"source-dir": {
|
|
1978
|
-
"char": "d",
|
|
1979
|
-
"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.",
|
|
2328
|
+
"char": "n",
|
|
2329
|
+
"deprecateAliases": true,
|
|
1980
2330
|
"exclusive": [
|
|
1981
|
-
"
|
|
1982
|
-
"metadata",
|
|
1983
|
-
"metadata-dir"
|
|
2331
|
+
"type"
|
|
1984
2332
|
],
|
|
1985
|
-
"
|
|
1986
|
-
"
|
|
1987
|
-
"summary": "Path to the local source files to deploy.",
|
|
2333
|
+
"name": "name",
|
|
2334
|
+
"summary": "Name of a custom manifest file to create.",
|
|
1988
2335
|
"hasDynamicHelp": false,
|
|
1989
|
-
"multiple": true,
|
|
1990
|
-
"type": "option"
|
|
1991
|
-
},
|
|
1992
|
-
"target-org": {
|
|
1993
|
-
"char": "o",
|
|
1994
|
-
"name": "target-org",
|
|
1995
|
-
"noCacheDefault": true,
|
|
1996
|
-
"required": true,
|
|
1997
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1998
|
-
"hasDynamicHelp": true,
|
|
1999
2336
|
"multiple": false,
|
|
2000
2337
|
"type": "option"
|
|
2001
2338
|
},
|
|
2002
|
-
"
|
|
2339
|
+
"type": {
|
|
2340
|
+
"aliases": [
|
|
2341
|
+
"manifesttype"
|
|
2342
|
+
],
|
|
2003
2343
|
"char": "t",
|
|
2004
|
-
"
|
|
2005
|
-
"
|
|
2006
|
-
|
|
2007
|
-
|
|
2344
|
+
"deprecateAliases": true,
|
|
2345
|
+
"exclusive": [
|
|
2346
|
+
"name"
|
|
2347
|
+
],
|
|
2348
|
+
"name": "type",
|
|
2349
|
+
"summary": "Type of manifest to create; the type determines the name of the created file.",
|
|
2008
2350
|
"hasDynamicHelp": false,
|
|
2009
|
-
"multiple":
|
|
2351
|
+
"multiple": false,
|
|
2352
|
+
"options": [
|
|
2353
|
+
"pre",
|
|
2354
|
+
"post",
|
|
2355
|
+
"destroy",
|
|
2356
|
+
"package"
|
|
2357
|
+
],
|
|
2010
2358
|
"type": "option"
|
|
2011
2359
|
},
|
|
2012
|
-
"
|
|
2013
|
-
"
|
|
2014
|
-
|
|
2015
|
-
|
|
2016
|
-
"
|
|
2017
|
-
"
|
|
2360
|
+
"include-packages": {
|
|
2361
|
+
"aliases": [
|
|
2362
|
+
"includepackages"
|
|
2363
|
+
],
|
|
2364
|
+
"char": "c",
|
|
2365
|
+
"dependsOn": [
|
|
2366
|
+
"from-org"
|
|
2367
|
+
],
|
|
2368
|
+
"deprecateAliases": true,
|
|
2369
|
+
"name": "include-packages",
|
|
2370
|
+
"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.",
|
|
2371
|
+
"delimiter": ",",
|
|
2018
2372
|
"hasDynamicHelp": false,
|
|
2019
|
-
"multiple":
|
|
2373
|
+
"multiple": true,
|
|
2020
2374
|
"options": [
|
|
2021
|
-
"
|
|
2022
|
-
"
|
|
2023
|
-
"RunLocalTests",
|
|
2024
|
-
"RunAllTestsInOrg"
|
|
2375
|
+
"managed",
|
|
2376
|
+
"unlocked"
|
|
2025
2377
|
],
|
|
2026
2378
|
"type": "option"
|
|
2027
2379
|
},
|
|
2028
|
-
"
|
|
2029
|
-
"
|
|
2030
|
-
"concise"
|
|
2031
|
-
],
|
|
2032
|
-
"name": "verbose",
|
|
2033
|
-
"summary": "Show verbose output of the deploy result.",
|
|
2034
|
-
"allowNo": false,
|
|
2035
|
-
"type": "boolean"
|
|
2036
|
-
},
|
|
2037
|
-
"wait": {
|
|
2038
|
-
"char": "w",
|
|
2039
|
-
"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\".",
|
|
2040
|
-
"exclusive": [
|
|
2041
|
-
"async"
|
|
2042
|
-
],
|
|
2043
|
-
"name": "wait",
|
|
2044
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2045
|
-
"hasDynamicHelp": true,
|
|
2046
|
-
"helpValue": "<minutes>",
|
|
2047
|
-
"multiple": false,
|
|
2048
|
-
"type": "option"
|
|
2049
|
-
},
|
|
2050
|
-
"purge-on-delete": {
|
|
2051
|
-
"helpGroup": "Delete",
|
|
2052
|
-
"name": "purge-on-delete",
|
|
2380
|
+
"excluded-metadata": {
|
|
2381
|
+
"name": "excluded-metadata",
|
|
2053
2382
|
"relationships": [
|
|
2054
2383
|
{
|
|
2055
2384
|
"type": "some",
|
|
2056
2385
|
"flags": [
|
|
2057
|
-
"
|
|
2058
|
-
"
|
|
2059
|
-
"metadata-dir",
|
|
2060
|
-
"post-destructive-changes"
|
|
2386
|
+
"from-org",
|
|
2387
|
+
"source-dir"
|
|
2061
2388
|
]
|
|
2062
2389
|
}
|
|
2063
2390
|
],
|
|
2064
|
-
"summary": "
|
|
2065
|
-
"
|
|
2066
|
-
"type": "boolean"
|
|
2067
|
-
},
|
|
2068
|
-
"pre-destructive-changes": {
|
|
2069
|
-
"dependsOn": [
|
|
2070
|
-
"manifest"
|
|
2071
|
-
],
|
|
2072
|
-
"helpGroup": "Delete",
|
|
2073
|
-
"name": "pre-destructive-changes",
|
|
2074
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
|
|
2391
|
+
"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.",
|
|
2392
|
+
"delimiter": ",",
|
|
2075
2393
|
"hasDynamicHelp": false,
|
|
2076
|
-
"multiple":
|
|
2394
|
+
"multiple": true,
|
|
2077
2395
|
"type": "option"
|
|
2078
2396
|
},
|
|
2079
|
-
"
|
|
2080
|
-
"
|
|
2081
|
-
"
|
|
2397
|
+
"from-org": {
|
|
2398
|
+
"aliases": [
|
|
2399
|
+
"fromorg"
|
|
2082
2400
|
],
|
|
2083
|
-
"
|
|
2084
|
-
"
|
|
2085
|
-
|
|
2401
|
+
"deprecateAliases": true,
|
|
2402
|
+
"exclusive": [
|
|
2403
|
+
"source-dir"
|
|
2404
|
+
],
|
|
2405
|
+
"name": "from-org",
|
|
2406
|
+
"summary": "Username or alias of the org that contains the metadata components from which to build a manifest.",
|
|
2086
2407
|
"hasDynamicHelp": false,
|
|
2087
2408
|
"multiple": false,
|
|
2088
2409
|
"type": "option"
|
|
2089
2410
|
},
|
|
2090
|
-
"
|
|
2091
|
-
"
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
"summary": "Format of the code coverage results.",
|
|
2095
|
-
"hasDynamicHelp": false,
|
|
2096
|
-
"multiple": true,
|
|
2097
|
-
"options": [
|
|
2098
|
-
"clover",
|
|
2099
|
-
"cobertura",
|
|
2100
|
-
"html-spa",
|
|
2101
|
-
"html",
|
|
2102
|
-
"json",
|
|
2103
|
-
"json-summary",
|
|
2104
|
-
"lcovonly",
|
|
2105
|
-
"none",
|
|
2106
|
-
"teamcity",
|
|
2107
|
-
"text",
|
|
2108
|
-
"text-summary"
|
|
2109
|
-
],
|
|
2110
|
-
"type": "option"
|
|
2111
|
-
},
|
|
2112
|
-
"junit": {
|
|
2113
|
-
"helpGroup": "Test",
|
|
2114
|
-
"name": "junit",
|
|
2115
|
-
"summary": "Output JUnit test results.",
|
|
2116
|
-
"allowNo": false,
|
|
2117
|
-
"type": "boolean"
|
|
2118
|
-
},
|
|
2119
|
-
"results-dir": {
|
|
2120
|
-
"helpGroup": "Test",
|
|
2121
|
-
"name": "results-dir",
|
|
2122
|
-
"relationships": [
|
|
2123
|
-
{
|
|
2124
|
-
"type": "some",
|
|
2125
|
-
"flags": [
|
|
2126
|
-
"coverage-formatters",
|
|
2127
|
-
"junit"
|
|
2128
|
-
]
|
|
2129
|
-
}
|
|
2411
|
+
"output-dir": {
|
|
2412
|
+
"aliases": [
|
|
2413
|
+
"outputdir",
|
|
2414
|
+
"o"
|
|
2130
2415
|
],
|
|
2131
|
-
"
|
|
2416
|
+
"char": "d",
|
|
2417
|
+
"deprecateAliases": true,
|
|
2418
|
+
"name": "output-dir",
|
|
2419
|
+
"summary": "Directory to save the created manifest.",
|
|
2132
2420
|
"hasDynamicHelp": false,
|
|
2133
2421
|
"multiple": false,
|
|
2134
2422
|
"type": "option"
|
|
2135
2423
|
}
|
|
2136
2424
|
},
|
|
2137
|
-
"hasDynamicHelp":
|
|
2425
|
+
"hasDynamicHelp": false,
|
|
2138
2426
|
"hiddenAliases": [],
|
|
2139
|
-
"id": "project:
|
|
2427
|
+
"id": "project:generate:manifest",
|
|
2140
2428
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2141
2429
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2142
2430
|
"pluginType": "core",
|
|
2143
2431
|
"strict": true,
|
|
2144
|
-
"summary": "
|
|
2432
|
+
"summary": "Create a project manifest that lists the metadata components you want to deploy or retrieve.",
|
|
2145
2433
|
"enableJsonFlag": true,
|
|
2146
|
-
"
|
|
2147
|
-
"header": "CONFIGURATION VARIABLES",
|
|
2148
|
-
"body": [
|
|
2149
|
-
{
|
|
2150
|
-
"name": "target-org",
|
|
2151
|
-
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
2152
|
-
},
|
|
2153
|
-
{
|
|
2154
|
-
"name": "org-api-version",
|
|
2155
|
-
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
2156
|
-
}
|
|
2157
|
-
]
|
|
2158
|
-
},
|
|
2159
|
-
"envVariablesSection": {
|
|
2160
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2161
|
-
"body": [
|
|
2162
|
-
{
|
|
2163
|
-
"name": "SF_TARGET_ORG",
|
|
2164
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2165
|
-
},
|
|
2166
|
-
{
|
|
2167
|
-
"name": "SF_USE_PROGRESS_BAR",
|
|
2168
|
-
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
2169
|
-
}
|
|
2170
|
-
]
|
|
2171
|
-
},
|
|
2172
|
-
"errorCodes": {
|
|
2173
|
-
"header": "ERROR CODES",
|
|
2174
|
-
"body": [
|
|
2175
|
-
{
|
|
2176
|
-
"name": "Succeeded (0)",
|
|
2177
|
-
"description": "The deploy succeeded."
|
|
2178
|
-
},
|
|
2179
|
-
{
|
|
2180
|
-
"name": "Canceled (1)",
|
|
2181
|
-
"description": "The deploy was canceled."
|
|
2182
|
-
},
|
|
2183
|
-
{
|
|
2184
|
-
"name": "Failed (1)",
|
|
2185
|
-
"description": "The deploy failed."
|
|
2186
|
-
},
|
|
2187
|
-
{
|
|
2188
|
-
"name": "SucceededPartial (68)",
|
|
2189
|
-
"description": "The deploy partially succeeded."
|
|
2190
|
-
},
|
|
2191
|
-
{
|
|
2192
|
-
"name": "InProgress (69)",
|
|
2193
|
-
"description": "The deploy is in progress."
|
|
2194
|
-
},
|
|
2195
|
-
{
|
|
2196
|
-
"name": "Pending (69)",
|
|
2197
|
-
"description": "The deploy is pending."
|
|
2198
|
-
},
|
|
2199
|
-
{
|
|
2200
|
-
"name": "Canceling (69)",
|
|
2201
|
-
"description": "The deploy is being canceled."
|
|
2202
|
-
}
|
|
2203
|
-
]
|
|
2204
|
-
},
|
|
2434
|
+
"requiresProject": true,
|
|
2205
2435
|
"isESM": true,
|
|
2206
2436
|
"relativePath": [
|
|
2207
2437
|
"lib",
|
|
2208
2438
|
"commands",
|
|
2209
2439
|
"project",
|
|
2210
|
-
"
|
|
2211
|
-
"
|
|
2440
|
+
"generate",
|
|
2441
|
+
"manifest.js"
|
|
2212
2442
|
],
|
|
2213
2443
|
"aliasPermutations": [
|
|
2214
|
-
"
|
|
2215
|
-
"
|
|
2444
|
+
"force:source:manifest:create",
|
|
2445
|
+
"source:force:manifest:create",
|
|
2446
|
+
"source:manifest:force:create",
|
|
2447
|
+
"source:manifest:create:force",
|
|
2448
|
+
"force:manifest:source:create",
|
|
2449
|
+
"manifest:force:source:create",
|
|
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"
|
|
2216
2468
|
],
|
|
2217
2469
|
"permutations": [
|
|
2218
|
-
"project:
|
|
2219
|
-
"
|
|
2220
|
-
"
|
|
2221
|
-
"project:
|
|
2222
|
-
"
|
|
2223
|
-
"
|
|
2470
|
+
"project:generate:manifest",
|
|
2471
|
+
"generate:project:manifest",
|
|
2472
|
+
"generate:manifest:project",
|
|
2473
|
+
"project:manifest:generate",
|
|
2474
|
+
"manifest:project:generate",
|
|
2475
|
+
"manifest:generate:project"
|
|
2224
2476
|
]
|
|
2225
2477
|
},
|
|
2226
|
-
"project:
|
|
2478
|
+
"project:list:ignored": {
|
|
2227
2479
|
"aliases": [
|
|
2228
|
-
"
|
|
2480
|
+
"force:source:ignored:list"
|
|
2229
2481
|
],
|
|
2230
2482
|
"args": {},
|
|
2231
2483
|
"deprecateAliases": true,
|
|
2232
|
-
"description": "
|
|
2484
|
+
"description": "When deploying or retrieving metadata between your local project and an org, you can specify the source files you want to exclude with a .forceignore file. The .forceignore file structure mimics the .gitignore structure. Each line in .forceignore specifies a pattern that corresponds to one or more files. The files typically represent metadata components, but can be any files you want to exclude, such as LWC configuration JSON files or tests.",
|
|
2233
2485
|
"examples": [
|
|
2234
|
-
"
|
|
2235
|
-
"
|
|
2236
|
-
"
|
|
2237
|
-
"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",
|
|
2238
|
-
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
2486
|
+
"List all the files in all package directories that are ignored:\n<%= config.bin %> <%= command.id %>",
|
|
2487
|
+
"List all the files in a specific directory that are ignored:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
|
|
2488
|
+
"Check if a particular file is ignored:\n<%= config.bin %> <%= command.id %> --source-dir package.xml"
|
|
2239
2489
|
],
|
|
2240
2490
|
"flags": {
|
|
2241
2491
|
"json": {
|
|
@@ -2253,320 +2503,70 @@
|
|
|
2253
2503
|
"multiple": false,
|
|
2254
2504
|
"type": "option"
|
|
2255
2505
|
},
|
|
2256
|
-
"
|
|
2257
|
-
"
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
"
|
|
2261
|
-
"
|
|
2262
|
-
"
|
|
2263
|
-
"
|
|
2264
|
-
},
|
|
2265
|
-
"async": {
|
|
2266
|
-
"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\".",
|
|
2267
|
-
"name": "async",
|
|
2268
|
-
"summary": "Run the command asynchronously.",
|
|
2269
|
-
"allowNo": false,
|
|
2270
|
-
"type": "boolean"
|
|
2271
|
-
},
|
|
2272
|
-
"concise": {
|
|
2273
|
-
"exclusive": [
|
|
2274
|
-
"verbose"
|
|
2275
|
-
],
|
|
2276
|
-
"name": "concise",
|
|
2277
|
-
"summary": "Show concise output of the validation result.",
|
|
2278
|
-
"allowNo": false,
|
|
2279
|
-
"type": "boolean"
|
|
2280
|
-
},
|
|
2281
|
-
"manifest": {
|
|
2282
|
-
"char": "x",
|
|
2283
|
-
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
2284
|
-
"helpGroup": "Source Format",
|
|
2285
|
-
"name": "manifest",
|
|
2286
|
-
"summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
|
|
2287
|
-
"hasDynamicHelp": false,
|
|
2288
|
-
"multiple": false,
|
|
2289
|
-
"type": "option"
|
|
2290
|
-
},
|
|
2291
|
-
"metadata": {
|
|
2292
|
-
"char": "m",
|
|
2293
|
-
"helpGroup": "Source Format",
|
|
2294
|
-
"name": "metadata",
|
|
2295
|
-
"summary": "Metadata component names to validate for deployment.",
|
|
2296
|
-
"hasDynamicHelp": false,
|
|
2297
|
-
"multiple": true,
|
|
2298
|
-
"type": "option"
|
|
2299
|
-
},
|
|
2300
|
-
"source-dir": {
|
|
2301
|
-
"char": "d",
|
|
2302
|
-
"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.",
|
|
2303
|
-
"helpGroup": "Source Format",
|
|
2304
|
-
"name": "source-dir",
|
|
2305
|
-
"summary": "Path to the local source files to validate for deployment.",
|
|
2306
|
-
"hasDynamicHelp": false,
|
|
2307
|
-
"multiple": true,
|
|
2308
|
-
"type": "option"
|
|
2309
|
-
},
|
|
2310
|
-
"metadata-dir": {
|
|
2311
|
-
"helpGroup": "Metadata API Format",
|
|
2312
|
-
"name": "metadata-dir",
|
|
2313
|
-
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
2314
|
-
"hasDynamicHelp": false,
|
|
2315
|
-
"multiple": false,
|
|
2316
|
-
"type": "option"
|
|
2317
|
-
},
|
|
2318
|
-
"single-package": {
|
|
2319
|
-
"dependsOn": [
|
|
2320
|
-
"metadata-dir"
|
|
2321
|
-
],
|
|
2322
|
-
"helpGroup": "Metadata API Format",
|
|
2323
|
-
"name": "single-package",
|
|
2324
|
-
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
2325
|
-
"allowNo": false,
|
|
2326
|
-
"type": "boolean"
|
|
2327
|
-
},
|
|
2328
|
-
"target-org": {
|
|
2329
|
-
"char": "o",
|
|
2330
|
-
"name": "target-org",
|
|
2331
|
-
"noCacheDefault": true,
|
|
2332
|
-
"required": true,
|
|
2333
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2334
|
-
"hasDynamicHelp": true,
|
|
2335
|
-
"multiple": false,
|
|
2336
|
-
"type": "option"
|
|
2337
|
-
},
|
|
2338
|
-
"tests": {
|
|
2339
|
-
"char": "t",
|
|
2340
|
-
"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\"",
|
|
2341
|
-
"helpGroup": "Test",
|
|
2342
|
-
"name": "tests",
|
|
2343
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2344
|
-
"hasDynamicHelp": false,
|
|
2345
|
-
"multiple": true,
|
|
2346
|
-
"type": "option"
|
|
2347
|
-
},
|
|
2348
|
-
"test-level": {
|
|
2349
|
-
"char": "l",
|
|
2350
|
-
"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.",
|
|
2351
|
-
"helpGroup": "Test",
|
|
2352
|
-
"name": "test-level",
|
|
2353
|
-
"summary": "Deployment Apex testing level.",
|
|
2354
|
-
"default": "RunLocalTests",
|
|
2355
|
-
"hasDynamicHelp": false,
|
|
2356
|
-
"multiple": false,
|
|
2357
|
-
"options": [
|
|
2358
|
-
"RunAllTestsInOrg",
|
|
2359
|
-
"RunLocalTests",
|
|
2360
|
-
"RunSpecifiedTests"
|
|
2361
|
-
],
|
|
2362
|
-
"type": "option"
|
|
2363
|
-
},
|
|
2364
|
-
"verbose": {
|
|
2365
|
-
"exclusive": [
|
|
2366
|
-
"concise"
|
|
2367
|
-
],
|
|
2368
|
-
"name": "verbose",
|
|
2369
|
-
"summary": "Show verbose output of the validation result.",
|
|
2370
|
-
"allowNo": false,
|
|
2371
|
-
"type": "boolean"
|
|
2372
|
-
},
|
|
2373
|
-
"wait": {
|
|
2374
|
-
"char": "w",
|
|
2375
|
-
"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\".",
|
|
2376
|
-
"name": "wait",
|
|
2377
|
-
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
2378
|
-
"hasDynamicHelp": true,
|
|
2379
|
-
"helpValue": "<minutes>",
|
|
2380
|
-
"multiple": false,
|
|
2381
|
-
"type": "option"
|
|
2382
|
-
},
|
|
2383
|
-
"ignore-warnings": {
|
|
2384
|
-
"char": "g",
|
|
2385
|
-
"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.",
|
|
2386
|
-
"name": "ignore-warnings",
|
|
2387
|
-
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
2388
|
-
"allowNo": false,
|
|
2389
|
-
"type": "boolean"
|
|
2390
|
-
},
|
|
2391
|
-
"coverage-formatters": {
|
|
2392
|
-
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
2393
|
-
"helpGroup": "Test",
|
|
2394
|
-
"name": "coverage-formatters",
|
|
2395
|
-
"summary": "Format of the code coverage results.",
|
|
2396
|
-
"hasDynamicHelp": false,
|
|
2397
|
-
"multiple": true,
|
|
2398
|
-
"options": [
|
|
2399
|
-
"clover",
|
|
2400
|
-
"cobertura",
|
|
2401
|
-
"html-spa",
|
|
2402
|
-
"html",
|
|
2403
|
-
"json",
|
|
2404
|
-
"json-summary",
|
|
2405
|
-
"lcovonly",
|
|
2406
|
-
"none",
|
|
2407
|
-
"teamcity",
|
|
2408
|
-
"text",
|
|
2409
|
-
"text-summary"
|
|
2410
|
-
],
|
|
2411
|
-
"type": "option"
|
|
2412
|
-
},
|
|
2413
|
-
"junit": {
|
|
2414
|
-
"helpGroup": "Test",
|
|
2415
|
-
"name": "junit",
|
|
2416
|
-
"summary": "Output JUnit test results.",
|
|
2417
|
-
"allowNo": false,
|
|
2418
|
-
"type": "boolean"
|
|
2419
|
-
},
|
|
2420
|
-
"results-dir": {
|
|
2421
|
-
"helpGroup": "Test",
|
|
2422
|
-
"name": "results-dir",
|
|
2423
|
-
"relationships": [
|
|
2424
|
-
{
|
|
2425
|
-
"type": "some",
|
|
2426
|
-
"flags": [
|
|
2427
|
-
"coverage-formatters",
|
|
2428
|
-
"junit"
|
|
2429
|
-
]
|
|
2430
|
-
}
|
|
2431
|
-
],
|
|
2432
|
-
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
2433
|
-
"hasDynamicHelp": false,
|
|
2434
|
-
"multiple": false,
|
|
2435
|
-
"type": "option"
|
|
2436
|
-
},
|
|
2437
|
-
"purge-on-delete": {
|
|
2438
|
-
"dependsOn": [
|
|
2439
|
-
"manifest"
|
|
2440
|
-
],
|
|
2441
|
-
"helpGroup": "Delete",
|
|
2442
|
-
"name": "purge-on-delete",
|
|
2443
|
-
"relationships": [
|
|
2444
|
-
{
|
|
2445
|
-
"type": "some",
|
|
2446
|
-
"flags": [
|
|
2447
|
-
"pre-destructive-changes",
|
|
2448
|
-
"post-destructive-changes"
|
|
2449
|
-
]
|
|
2450
|
-
}
|
|
2451
|
-
],
|
|
2452
|
-
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
2453
|
-
"allowNo": false,
|
|
2454
|
-
"type": "boolean"
|
|
2455
|
-
},
|
|
2456
|
-
"pre-destructive-changes": {
|
|
2457
|
-
"dependsOn": [
|
|
2458
|
-
"manifest"
|
|
2459
|
-
],
|
|
2460
|
-
"helpGroup": "Delete",
|
|
2461
|
-
"name": "pre-destructive-changes",
|
|
2462
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
2463
|
-
"hasDynamicHelp": false,
|
|
2464
|
-
"multiple": false,
|
|
2465
|
-
"type": "option"
|
|
2466
|
-
},
|
|
2467
|
-
"post-destructive-changes": {
|
|
2468
|
-
"dependsOn": [
|
|
2469
|
-
"manifest"
|
|
2470
|
-
],
|
|
2471
|
-
"helpGroup": "Delete",
|
|
2472
|
-
"name": "post-destructive-changes",
|
|
2473
|
-
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
2506
|
+
"source-dir": {
|
|
2507
|
+
"aliases": [
|
|
2508
|
+
"sourcepath"
|
|
2509
|
+
],
|
|
2510
|
+
"char": "p",
|
|
2511
|
+
"deprecateAliases": true,
|
|
2512
|
+
"name": "source-dir",
|
|
2513
|
+
"summary": "File or directory of files that the command checks for foreceignored files.",
|
|
2474
2514
|
"hasDynamicHelp": false,
|
|
2475
2515
|
"multiple": false,
|
|
2476
2516
|
"type": "option"
|
|
2477
2517
|
}
|
|
2478
2518
|
},
|
|
2479
|
-
"hasDynamicHelp":
|
|
2519
|
+
"hasDynamicHelp": false,
|
|
2480
2520
|
"hiddenAliases": [],
|
|
2481
|
-
"id": "project:
|
|
2521
|
+
"id": "project:list:ignored",
|
|
2482
2522
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2483
2523
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2484
2524
|
"pluginType": "core",
|
|
2485
2525
|
"strict": true,
|
|
2486
|
-
"summary": "
|
|
2526
|
+
"summary": "Check your local project package directories for forceignored files.",
|
|
2487
2527
|
"enableJsonFlag": true,
|
|
2488
|
-
"
|
|
2489
|
-
"header": "CONFIGURATION VARIABLES",
|
|
2490
|
-
"body": [
|
|
2491
|
-
{
|
|
2492
|
-
"name": "target-org",
|
|
2493
|
-
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
2494
|
-
},
|
|
2495
|
-
{
|
|
2496
|
-
"name": "org-api-version",
|
|
2497
|
-
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
2498
|
-
}
|
|
2499
|
-
]
|
|
2500
|
-
},
|
|
2501
|
-
"envVariablesSection": {
|
|
2502
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2503
|
-
"body": [
|
|
2504
|
-
{
|
|
2505
|
-
"name": "SF_TARGET_ORG",
|
|
2506
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2507
|
-
},
|
|
2508
|
-
{
|
|
2509
|
-
"name": "SF_USE_PROGRESS_BAR",
|
|
2510
|
-
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
2511
|
-
}
|
|
2512
|
-
]
|
|
2513
|
-
},
|
|
2514
|
-
"errorCodes": {
|
|
2515
|
-
"header": "ERROR CODES",
|
|
2516
|
-
"body": [
|
|
2517
|
-
{
|
|
2518
|
-
"name": "Succeeded (0)",
|
|
2519
|
-
"description": "The deploy succeeded."
|
|
2520
|
-
},
|
|
2521
|
-
{
|
|
2522
|
-
"name": "Canceled (1)",
|
|
2523
|
-
"description": "The deploy was canceled."
|
|
2524
|
-
},
|
|
2525
|
-
{
|
|
2526
|
-
"name": "Failed (1)",
|
|
2527
|
-
"description": "The deploy failed."
|
|
2528
|
-
},
|
|
2529
|
-
{
|
|
2530
|
-
"name": "SucceededPartial (68)",
|
|
2531
|
-
"description": "The deploy partially succeeded."
|
|
2532
|
-
},
|
|
2533
|
-
{
|
|
2534
|
-
"name": "InProgress (69)",
|
|
2535
|
-
"description": "The deploy is in progress."
|
|
2536
|
-
},
|
|
2537
|
-
{
|
|
2538
|
-
"name": "Pending (69)",
|
|
2539
|
-
"description": "The deploy is pending."
|
|
2540
|
-
},
|
|
2541
|
-
{
|
|
2542
|
-
"name": "Canceling (69)",
|
|
2543
|
-
"description": "The deploy is being canceled."
|
|
2544
|
-
}
|
|
2545
|
-
]
|
|
2546
|
-
},
|
|
2528
|
+
"requiresProject": true,
|
|
2547
2529
|
"isESM": true,
|
|
2548
2530
|
"relativePath": [
|
|
2549
2531
|
"lib",
|
|
2550
2532
|
"commands",
|
|
2551
2533
|
"project",
|
|
2552
|
-
"
|
|
2553
|
-
"
|
|
2534
|
+
"list",
|
|
2535
|
+
"ignored.js"
|
|
2554
2536
|
],
|
|
2555
2537
|
"aliasPermutations": [
|
|
2556
|
-
"
|
|
2557
|
-
"
|
|
2558
|
-
"
|
|
2559
|
-
"
|
|
2560
|
-
"
|
|
2561
|
-
"
|
|
2538
|
+
"force:source:ignored:list",
|
|
2539
|
+
"source:force:ignored:list",
|
|
2540
|
+
"source:ignored:force:list",
|
|
2541
|
+
"source:ignored:list:force",
|
|
2542
|
+
"force:ignored:source:list",
|
|
2543
|
+
"ignored:force:source:list",
|
|
2544
|
+
"ignored:source:force:list",
|
|
2545
|
+
"ignored:source:list:force",
|
|
2546
|
+
"force:ignored:list:source",
|
|
2547
|
+
"ignored:force:list:source",
|
|
2548
|
+
"ignored:list:force:source",
|
|
2549
|
+
"ignored:list:source:force",
|
|
2550
|
+
"force:source:list:ignored",
|
|
2551
|
+
"source:force:list:ignored",
|
|
2552
|
+
"source:list:force:ignored",
|
|
2553
|
+
"source:list:ignored:force",
|
|
2554
|
+
"force:list:source:ignored",
|
|
2555
|
+
"list:force:source:ignored",
|
|
2556
|
+
"list:source:force:ignored",
|
|
2557
|
+
"list:source:ignored:force",
|
|
2558
|
+
"force:list:ignored:source",
|
|
2559
|
+
"list:force:ignored:source",
|
|
2560
|
+
"list:ignored:force:source",
|
|
2561
|
+
"list:ignored:source:force"
|
|
2562
2562
|
],
|
|
2563
2563
|
"permutations": [
|
|
2564
|
-
"project:
|
|
2565
|
-
"
|
|
2566
|
-
"
|
|
2567
|
-
"project:
|
|
2568
|
-
"
|
|
2569
|
-
"
|
|
2564
|
+
"project:list:ignored",
|
|
2565
|
+
"list:project:ignored",
|
|
2566
|
+
"list:ignored:project",
|
|
2567
|
+
"project:ignored:list",
|
|
2568
|
+
"ignored:project:list",
|
|
2569
|
+
"ignored:list:project"
|
|
2570
2570
|
]
|
|
2571
2571
|
},
|
|
2572
2572
|
"project:reset:tracking": {
|
|
@@ -3051,5 +3051,5 @@
|
|
|
3051
3051
|
]
|
|
3052
3052
|
}
|
|
3053
3053
|
},
|
|
3054
|
-
"version": "3.22.
|
|
3054
|
+
"version": "3.22.34-dev.0"
|
|
3055
3055
|
}
|