@salesforce/cli 2.158.6 → 2.158.7
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 +42 -42
- package/node_modules/@salesforce/plugin-apex/README.md +32 -74
- package/node_modules/@salesforce/plugin-apex/oclif.manifest.json +1 -1
- package/node_modules/@salesforce/plugin-apex/package.json +3 -3
- package/node_modules/@salesforce/plugin-api/README.md +6 -21
- package/node_modules/@salesforce/plugin-api/oclif.manifest.json +1 -1
- package/node_modules/@salesforce/plugin-api/package.json +6 -6
- package/node_modules/@salesforce/plugin-auth/README.md +13 -29
- package/node_modules/@salesforce/plugin-auth/oclif.manifest.json +1 -1
- package/node_modules/@salesforce/plugin-auth/package.json +3 -3
- package/node_modules/@salesforce/plugin-deploy-retrieve/README.md +21 -37
- package/node_modules/@salesforce/plugin-deploy-retrieve/lib/formatters/deployResultFormatter.d.ts +1 -0
- package/node_modules/@salesforce/plugin-deploy-retrieve/lib/formatters/deployResultFormatter.js +45 -0
- package/node_modules/@salesforce/plugin-deploy-retrieve/lib/formatters/deployResultFormatter.js.map +1 -1
- package/node_modules/@salesforce/plugin-deploy-retrieve/oclif.manifest.json +1438 -1438
- package/node_modules/@salesforce/plugin-deploy-retrieve/package.json +4 -4
- package/node_modules/@salesforce/plugin-deploy-retrieve/schemas/project-delete-source.json +46 -0
- package/node_modules/@salesforce/plugin-deploy-retrieve/schemas/project-deploy-cancel.json +46 -0
- package/node_modules/@salesforce/plugin-deploy-retrieve/schemas/project-deploy-quick.json +46 -0
- package/node_modules/@salesforce/plugin-deploy-retrieve/schemas/project-deploy-report.json +46 -0
- package/node_modules/@salesforce/plugin-deploy-retrieve/schemas/project-deploy-resume.json +46 -0
- package/node_modules/@salesforce/plugin-deploy-retrieve/schemas/project-deploy-start.json +46 -0
- package/node_modules/@salesforce/plugin-deploy-retrieve/schemas/project-deploy-validate.json +46 -0
- package/node_modules/@salesforce/plugin-trust/README.md +6 -6
- package/node_modules/@salesforce/plugin-trust/lib/shared/installationVerification.js +4 -2
- package/node_modules/@salesforce/plugin-trust/lib/shared/installationVerification.js.map +1 -1
- package/node_modules/@salesforce/plugin-trust/oclif.manifest.json +1 -1
- package/node_modules/@salesforce/plugin-trust/package.json +3 -3
- package/node_modules/@salesforce/source-deploy-retrieve/lib/src/client/index.d.ts +1 -1
- package/node_modules/@salesforce/source-deploy-retrieve/lib/src/client/index.js.map +1 -1
- package/node_modules/@salesforce/source-deploy-retrieve/lib/src/client/types.d.ts +7 -0
- package/node_modules/@salesforce/source-deploy-retrieve/lib/src/client/types.js.map +1 -1
- package/node_modules/@salesforce/source-deploy-retrieve/lib/src/convert/convertContext/profileMetadataFinalizer.js +17 -6
- package/node_modules/@salesforce/source-deploy-retrieve/lib/src/convert/convertContext/profileMetadataFinalizer.js.map +1 -1
- package/node_modules/@salesforce/source-deploy-retrieve/lib/src/index.d.ts +1 -1
- package/node_modules/@salesforce/source-deploy-retrieve/lib/src/index.js.map +1 -1
- package/node_modules/@salesforce/source-deploy-retrieve/lib/src/registry/metadataRegistry.json +19 -1
- package/node_modules/@salesforce/source-deploy-retrieve/package.json +2 -2
- package/oclif.manifest.json +1 -1
- package/package.json +9 -9
|
@@ -1,17 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"commands": {
|
|
3
|
-
"project:
|
|
3
|
+
"project:convert:mdapi": {
|
|
4
4
|
"aliases": [
|
|
5
|
-
"force:
|
|
5
|
+
"force:mdapi:convert"
|
|
6
6
|
],
|
|
7
7
|
"args": {},
|
|
8
8
|
"deprecateAliases": true,
|
|
9
|
-
"description": "
|
|
9
|
+
"description": "To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the metadata format to the source format using this command.\n\nTo convert files from the source format back to the metadata format, run \"sf project convert source\".\n\nTo convert multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
|
|
10
10
|
"examples": [
|
|
11
|
-
"
|
|
12
|
-
"
|
|
13
|
-
"Run the tests that aren’t in any managed packages as part of the deletion; if the delete succeeds, and the org has source-tracking enabled, update the source tracking information:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source",
|
|
14
|
-
"Delete the Apex source files in a directory and the corresponding components from your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes"
|
|
11
|
+
"Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata",
|
|
12
|
+
"Similar to previous example, but writes converted files to the specified output directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir"
|
|
15
13
|
],
|
|
16
14
|
"flags": {
|
|
17
15
|
"json": {
|
|
@@ -50,150 +48,80 @@
|
|
|
50
48
|
"multiple": false,
|
|
51
49
|
"type": "option"
|
|
52
50
|
},
|
|
53
|
-
"
|
|
51
|
+
"root-dir": {
|
|
54
52
|
"aliases": [
|
|
55
|
-
"
|
|
56
|
-
"u"
|
|
53
|
+
"rootdir"
|
|
57
54
|
],
|
|
58
|
-
"char": "
|
|
55
|
+
"char": "r",
|
|
59
56
|
"deprecateAliases": true,
|
|
60
|
-
"name": "
|
|
61
|
-
"noCacheDefault": true,
|
|
57
|
+
"name": "root-dir",
|
|
62
58
|
"required": true,
|
|
63
|
-
"summary": "
|
|
64
|
-
"hasDynamicHelp":
|
|
59
|
+
"summary": "Root directory that contains the Metadata API–formatted metadata.",
|
|
60
|
+
"hasDynamicHelp": false,
|
|
65
61
|
"multiple": false,
|
|
66
62
|
"type": "option"
|
|
67
63
|
},
|
|
68
|
-
"
|
|
64
|
+
"output-dir": {
|
|
69
65
|
"aliases": [
|
|
70
|
-
"
|
|
66
|
+
"outputdir"
|
|
71
67
|
],
|
|
72
|
-
"char": "
|
|
68
|
+
"char": "d",
|
|
73
69
|
"deprecateAliases": true,
|
|
74
|
-
"
|
|
75
|
-
"
|
|
76
|
-
"summary": "Validate delete command but don't delete anything from the org or the local project.",
|
|
77
|
-
"allowNo": false,
|
|
78
|
-
"type": "boolean"
|
|
79
|
-
},
|
|
80
|
-
"wait": {
|
|
81
|
-
"char": "w",
|
|
82
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
|
|
83
|
-
"name": "wait",
|
|
84
|
-
"summary": "Number of minutes to wait for the command to finish.",
|
|
85
|
-
"hasDynamicHelp": true,
|
|
86
|
-
"multiple": false,
|
|
87
|
-
"type": "option"
|
|
88
|
-
},
|
|
89
|
-
"tests": {
|
|
90
|
-
"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\"",
|
|
91
|
-
"helpGroup": "Test",
|
|
92
|
-
"name": "tests",
|
|
93
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
70
|
+
"name": "output-dir",
|
|
71
|
+
"summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
|
|
94
72
|
"hasDynamicHelp": false,
|
|
95
|
-
"multiple":
|
|
73
|
+
"multiple": false,
|
|
96
74
|
"type": "option"
|
|
97
75
|
},
|
|
98
|
-
"
|
|
99
|
-
"
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
"
|
|
103
|
-
"deprecateAliases": true,
|
|
104
|
-
"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- RunRelevantTests (Beta) — Runs only tests that are relevant to the files being deployed. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies. For fine-grained control, you can also annotate test classes so that they always run in certain conditions. See \"@IsTest Annotation\" in the \"Apex Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_annotation_isTest.htm). Each class and trigger in the deployment package must be covered by the executed tests for a minimum of 75% code coverage. This coverage is computed for each class and triggers individually and is different than the overall coverage percentage.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see \"Running Tests in a Deployment\" (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
|
|
105
|
-
"helpGroup": "Test",
|
|
106
|
-
"name": "test-level",
|
|
107
|
-
"summary": "Deployment Apex testing level.",
|
|
76
|
+
"manifest": {
|
|
77
|
+
"char": "x",
|
|
78
|
+
"description": "If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
79
|
+
"name": "manifest",
|
|
80
|
+
"summary": "File path to manifest (package.xml) of metadata types to convert.",
|
|
108
81
|
"hasDynamicHelp": false,
|
|
109
82
|
"multiple": false,
|
|
110
|
-
"options": [
|
|
111
|
-
"NoTestRun",
|
|
112
|
-
"RunSpecifiedTests",
|
|
113
|
-
"RunLocalTests",
|
|
114
|
-
"RunAllTestsInOrg",
|
|
115
|
-
"RunRelevantTests"
|
|
116
|
-
],
|
|
117
83
|
"type": "option"
|
|
118
84
|
},
|
|
119
|
-
"
|
|
85
|
+
"metadata-dir": {
|
|
120
86
|
"aliases": [
|
|
121
|
-
"
|
|
87
|
+
"metadatapath"
|
|
122
88
|
],
|
|
123
|
-
"char": "
|
|
89
|
+
"char": "p",
|
|
124
90
|
"deprecateAliases": true,
|
|
125
|
-
"
|
|
126
|
-
"
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
"
|
|
132
|
-
"description": "If you specify this flag, don’t specify --source-dir.",
|
|
133
|
-
"name": "metadata",
|
|
134
|
-
"summary": "Metadata components to delete.",
|
|
91
|
+
"description": "The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this flag, don’t specify --manifest or --metadata. If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes.",
|
|
92
|
+
"exclusive": [
|
|
93
|
+
"manifest",
|
|
94
|
+
"metadata"
|
|
95
|
+
],
|
|
96
|
+
"name": "metadata-dir",
|
|
97
|
+
"summary": "Root of directory or zip file of metadata formatted files to convert.",
|
|
135
98
|
"delimiter": ",",
|
|
136
99
|
"hasDynamicHelp": false,
|
|
137
100
|
"multiple": true,
|
|
138
101
|
"type": "option"
|
|
139
102
|
},
|
|
140
|
-
"
|
|
141
|
-
"
|
|
142
|
-
|
|
103
|
+
"metadata": {
|
|
104
|
+
"char": "m",
|
|
105
|
+
"exclusive": [
|
|
106
|
+
"manifest",
|
|
107
|
+
"metadatapath"
|
|
143
108
|
],
|
|
144
|
-
"
|
|
145
|
-
"
|
|
146
|
-
"description": "The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this flag, don’t specify --metadata.",
|
|
147
|
-
"name": "source-dir",
|
|
148
|
-
"summary": "Source file paths to delete.",
|
|
109
|
+
"name": "metadata",
|
|
110
|
+
"summary": "Metadata component names to convert.",
|
|
149
111
|
"delimiter": ",",
|
|
150
112
|
"hasDynamicHelp": false,
|
|
151
113
|
"multiple": true,
|
|
152
114
|
"type": "option"
|
|
153
|
-
},
|
|
154
|
-
"track-source": {
|
|
155
|
-
"aliases": [
|
|
156
|
-
"tracksource"
|
|
157
|
-
],
|
|
158
|
-
"char": "t",
|
|
159
|
-
"deprecateAliases": true,
|
|
160
|
-
"exclusive": [
|
|
161
|
-
"check-only"
|
|
162
|
-
],
|
|
163
|
-
"name": "track-source",
|
|
164
|
-
"summary": "If the delete succeeds, update the source tracking information.",
|
|
165
|
-
"allowNo": false,
|
|
166
|
-
"type": "boolean"
|
|
167
|
-
},
|
|
168
|
-
"force-overwrite": {
|
|
169
|
-
"aliases": [
|
|
170
|
-
"forceoverwrite"
|
|
171
|
-
],
|
|
172
|
-
"char": "f",
|
|
173
|
-
"dependsOn": [
|
|
174
|
-
"track-source"
|
|
175
|
-
],
|
|
176
|
-
"deprecateAliases": true,
|
|
177
|
-
"name": "force-overwrite",
|
|
178
|
-
"summary": "Ignore conflict warnings and overwrite changes to the org.",
|
|
179
|
-
"allowNo": false,
|
|
180
|
-
"type": "boolean"
|
|
181
|
-
},
|
|
182
|
-
"verbose": {
|
|
183
|
-
"name": "verbose",
|
|
184
|
-
"summary": "Verbose output of the delete result.",
|
|
185
|
-
"allowNo": false,
|
|
186
|
-
"type": "boolean"
|
|
187
115
|
}
|
|
188
116
|
},
|
|
189
|
-
"hasDynamicHelp":
|
|
117
|
+
"hasDynamicHelp": false,
|
|
190
118
|
"hiddenAliases": [],
|
|
191
|
-
"id": "project:
|
|
119
|
+
"id": "project:convert:mdapi",
|
|
192
120
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
193
121
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
194
122
|
"pluginType": "core",
|
|
195
123
|
"strict": true,
|
|
196
|
-
"summary": "
|
|
124
|
+
"summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
|
|
197
125
|
"enableJsonFlag": true,
|
|
198
126
|
"requiresProject": true,
|
|
199
127
|
"isESM": true,
|
|
@@ -201,35 +129,34 @@
|
|
|
201
129
|
"lib",
|
|
202
130
|
"commands",
|
|
203
131
|
"project",
|
|
204
|
-
"
|
|
205
|
-
"
|
|
132
|
+
"convert",
|
|
133
|
+
"mdapi.js"
|
|
206
134
|
],
|
|
207
135
|
"aliasPermutations": [
|
|
208
|
-
"force:
|
|
209
|
-
"
|
|
210
|
-
"
|
|
211
|
-
"force:
|
|
212
|
-
"
|
|
213
|
-
"
|
|
136
|
+
"force:mdapi:convert",
|
|
137
|
+
"mdapi:force:convert",
|
|
138
|
+
"mdapi:convert:force",
|
|
139
|
+
"force:convert:mdapi",
|
|
140
|
+
"convert:force:mdapi",
|
|
141
|
+
"convert:mdapi:force"
|
|
214
142
|
],
|
|
215
143
|
"permutations": [
|
|
216
|
-
"project:
|
|
217
|
-
"
|
|
218
|
-
"
|
|
219
|
-
"project:
|
|
220
|
-
"
|
|
221
|
-
"
|
|
144
|
+
"project:convert:mdapi",
|
|
145
|
+
"convert:project:mdapi",
|
|
146
|
+
"convert:mdapi:project",
|
|
147
|
+
"project:mdapi:convert",
|
|
148
|
+
"mdapi:project:convert",
|
|
149
|
+
"mdapi:convert:project"
|
|
222
150
|
]
|
|
223
151
|
},
|
|
224
|
-
"project:
|
|
225
|
-
"aliases": [
|
|
226
|
-
"force:source:tracking:clear"
|
|
227
|
-
],
|
|
152
|
+
"project:convert:source-behavior": {
|
|
153
|
+
"aliases": [],
|
|
228
154
|
"args": {},
|
|
229
|
-
"
|
|
230
|
-
"description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nDeletes all local source tracking information. When you next run 'project deploy preview', Salesforce CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts.",
|
|
155
|
+
"description": "Specifically, this command updates the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file and then converts the associated local source files in your project as needed.\n\nFor example, run this command with the \"--behavior decomposePermissionSetBeta\" flag to start decomposing permission sets when you deploy or retrieve them. Decomposing means breaking up the monolithic metadata API format XML file that corresponds to a metadata component into smaller XML files and directories based on its subtypes. Permission sets are not decomposed by default; you must opt-in to start decomposing them by using this command. When the command finishes, your \"sfdx-project.json\" file is updated to always decompose permission sets, and the existing permission set files in your local package directories are converted into the new decomposed format. You run this command only once for a given behavior change.\n\nFor more information about the possible values for the --behavior flag, see the \"sourceBehaviorOptions\" section in the https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.",
|
|
231
156
|
"examples": [
|
|
232
|
-
"
|
|
157
|
+
"Update your Salesforce DX project to decompose custom permission sets:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta",
|
|
158
|
+
"Display what the command would do, but don't change any existing files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run",
|
|
159
|
+
"Keep the temporary directory that contains the interim metadata API formatted files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir"
|
|
233
160
|
],
|
|
234
161
|
"flags": {
|
|
235
162
|
"json": {
|
|
@@ -247,62 +174,55 @@
|
|
|
247
174
|
"multiple": false,
|
|
248
175
|
"type": "option"
|
|
249
176
|
},
|
|
250
|
-
"
|
|
251
|
-
"
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
"
|
|
255
|
-
"description": "Override the api version used for api requests made by this command",
|
|
256
|
-
"name": "api-version",
|
|
177
|
+
"behavior": {
|
|
178
|
+
"char": "b",
|
|
179
|
+
"name": "behavior",
|
|
180
|
+
"required": true,
|
|
181
|
+
"summary": "Behavior to enable; the values correspond to the possible values of the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file.",
|
|
257
182
|
"hasDynamicHelp": false,
|
|
258
183
|
"multiple": false,
|
|
184
|
+
"options": [
|
|
185
|
+
"decomposeCustomLabelsBeta2",
|
|
186
|
+
"decomposeCustomLabelsBeta",
|
|
187
|
+
"decomposePermissionSetBeta",
|
|
188
|
+
"decomposePermissionSetBeta2",
|
|
189
|
+
"decomposeSharingRulesBeta",
|
|
190
|
+
"decomposeWorkflowBeta",
|
|
191
|
+
"decomposeExternalServiceRegistrationBeta"
|
|
192
|
+
],
|
|
259
193
|
"type": "option"
|
|
260
194
|
},
|
|
261
|
-
"
|
|
262
|
-
"
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
"
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
"
|
|
269
|
-
"
|
|
195
|
+
"dry-run": {
|
|
196
|
+
"name": "dry-run",
|
|
197
|
+
"summary": "Display what the command would do, but don't make any actual changes.",
|
|
198
|
+
"allowNo": false,
|
|
199
|
+
"type": "boolean"
|
|
200
|
+
},
|
|
201
|
+
"preserve-temp-dir": {
|
|
202
|
+
"name": "preserve-temp-dir",
|
|
203
|
+
"summary": "Don't delete the metadata API format temporary directory that this command creates. Useful for debugging.",
|
|
204
|
+
"allowNo": false,
|
|
205
|
+
"type": "boolean"
|
|
270
206
|
},
|
|
271
207
|
"target-org": {
|
|
272
|
-
"aliases": [
|
|
273
|
-
"targetusername",
|
|
274
|
-
"u"
|
|
275
|
-
],
|
|
276
208
|
"char": "o",
|
|
277
|
-
"deprecateAliases": true,
|
|
278
209
|
"name": "target-org",
|
|
279
210
|
"noCacheDefault": true,
|
|
280
|
-
"
|
|
281
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
211
|
+
"summary": "Username or alias of the target org.",
|
|
282
212
|
"hasDynamicHelp": true,
|
|
283
213
|
"multiple": false,
|
|
284
214
|
"type": "option"
|
|
285
|
-
},
|
|
286
|
-
"no-prompt": {
|
|
287
|
-
"aliases": [
|
|
288
|
-
"noprompt"
|
|
289
|
-
],
|
|
290
|
-
"char": "p",
|
|
291
|
-
"deprecateAliases": true,
|
|
292
|
-
"name": "no-prompt",
|
|
293
|
-
"summary": "Don't prompt for source tracking override confirmation.",
|
|
294
|
-
"allowNo": false,
|
|
295
|
-
"type": "boolean"
|
|
296
215
|
}
|
|
297
216
|
},
|
|
298
217
|
"hasDynamicHelp": true,
|
|
299
218
|
"hiddenAliases": [],
|
|
300
|
-
"id": "project:
|
|
219
|
+
"id": "project:convert:source-behavior",
|
|
301
220
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
302
221
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
303
222
|
"pluginType": "core",
|
|
223
|
+
"state": "beta",
|
|
304
224
|
"strict": true,
|
|
305
|
-
"summary": "
|
|
225
|
+
"summary": "Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.",
|
|
306
226
|
"enableJsonFlag": true,
|
|
307
227
|
"requiresProject": true,
|
|
308
228
|
"isESM": true,
|
|
@@ -310,54 +230,29 @@
|
|
|
310
230
|
"lib",
|
|
311
231
|
"commands",
|
|
312
232
|
"project",
|
|
313
|
-
"
|
|
314
|
-
"
|
|
315
|
-
],
|
|
316
|
-
"aliasPermutations": [
|
|
317
|
-
"force:source:tracking:clear",
|
|
318
|
-
"source:force:tracking:clear",
|
|
319
|
-
"source:tracking:force:clear",
|
|
320
|
-
"source:tracking:clear:force",
|
|
321
|
-
"force:tracking:source:clear",
|
|
322
|
-
"tracking:force:source:clear",
|
|
323
|
-
"tracking:source:force:clear",
|
|
324
|
-
"tracking:source:clear:force",
|
|
325
|
-
"force:tracking:clear:source",
|
|
326
|
-
"tracking:force:clear:source",
|
|
327
|
-
"tracking:clear:force:source",
|
|
328
|
-
"tracking:clear:source:force",
|
|
329
|
-
"force:source:clear:tracking",
|
|
330
|
-
"source:force:clear:tracking",
|
|
331
|
-
"source:clear:force:tracking",
|
|
332
|
-
"source:clear:tracking:force",
|
|
333
|
-
"force:clear:source:tracking",
|
|
334
|
-
"clear:force:source:tracking",
|
|
335
|
-
"clear:source:force:tracking",
|
|
336
|
-
"clear:source:tracking:force",
|
|
337
|
-
"force:clear:tracking:source",
|
|
338
|
-
"clear:force:tracking:source",
|
|
339
|
-
"clear:tracking:force:source",
|
|
340
|
-
"clear:tracking:source:force"
|
|
233
|
+
"convert",
|
|
234
|
+
"source-behavior.js"
|
|
341
235
|
],
|
|
236
|
+
"aliasPermutations": [],
|
|
342
237
|
"permutations": [
|
|
343
|
-
"project:
|
|
344
|
-
"
|
|
345
|
-
"
|
|
346
|
-
"project:
|
|
347
|
-
"
|
|
348
|
-
"
|
|
238
|
+
"project:convert:source-behavior",
|
|
239
|
+
"convert:project:source-behavior",
|
|
240
|
+
"convert:source-behavior:project",
|
|
241
|
+
"project:source-behavior:convert",
|
|
242
|
+
"source-behavior:project:convert",
|
|
243
|
+
"source-behavior:convert:project"
|
|
349
244
|
]
|
|
350
245
|
},
|
|
351
|
-
"project:
|
|
246
|
+
"project:convert:source": {
|
|
352
247
|
"aliases": [
|
|
353
|
-
"
|
|
248
|
+
"force:source:convert"
|
|
354
249
|
],
|
|
355
250
|
"args": {},
|
|
356
251
|
"deprecateAliases": true,
|
|
357
|
-
"description": "
|
|
252
|
+
"description": "To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using \"<%= config.bin %> project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"<%= config.bin %> project convert mdapi\".\n\nTo specify a package name that includes spaces, enclose the name in single quotes.\n\nTo convert multiple components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
|
|
358
253
|
"examples": [
|
|
359
|
-
"
|
|
360
|
-
"
|
|
254
|
+
"Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source",
|
|
255
|
+
"Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'"
|
|
361
256
|
],
|
|
362
257
|
"flags": {
|
|
363
258
|
"json": {
|
|
@@ -375,103 +270,153 @@
|
|
|
375
270
|
"multiple": false,
|
|
376
271
|
"type": "option"
|
|
377
272
|
},
|
|
378
|
-
"
|
|
379
|
-
"
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
"
|
|
273
|
+
"api-version": {
|
|
274
|
+
"aliases": [
|
|
275
|
+
"apiversion"
|
|
276
|
+
],
|
|
277
|
+
"deprecateAliases": true,
|
|
278
|
+
"description": "Override the api version used for api requests made by this command",
|
|
279
|
+
"name": "api-version",
|
|
280
|
+
"summary": "API Version to use in the generated project's manifest. By default, will use the version from sfdx-project.json",
|
|
281
|
+
"hasDynamicHelp": false,
|
|
282
|
+
"multiple": false,
|
|
283
|
+
"type": "option"
|
|
284
|
+
},
|
|
285
|
+
"loglevel": {
|
|
286
|
+
"deprecated": {
|
|
287
|
+
"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 `SF_LOG_LEVEL` environment variable."
|
|
288
|
+
},
|
|
289
|
+
"hidden": true,
|
|
290
|
+
"name": "loglevel",
|
|
291
|
+
"hasDynamicHelp": false,
|
|
292
|
+
"multiple": false,
|
|
293
|
+
"type": "option"
|
|
294
|
+
},
|
|
295
|
+
"root-dir": {
|
|
296
|
+
"aliases": [
|
|
297
|
+
"rootdir"
|
|
298
|
+
],
|
|
299
|
+
"char": "r",
|
|
300
|
+
"deprecateAliases": true,
|
|
301
|
+
"name": "root-dir",
|
|
302
|
+
"summary": "Source directory other than the default package to convert.",
|
|
303
|
+
"hasDynamicHelp": false,
|
|
304
|
+
"multiple": false,
|
|
305
|
+
"type": "option"
|
|
306
|
+
},
|
|
307
|
+
"output-dir": {
|
|
308
|
+
"aliases": [
|
|
309
|
+
"outputdir"
|
|
310
|
+
],
|
|
311
|
+
"char": "d",
|
|
312
|
+
"deprecateAliases": true,
|
|
313
|
+
"name": "output-dir",
|
|
314
|
+
"summary": "Output directory to store the Metadata API–formatted files in.",
|
|
315
|
+
"default": "metadataPackage_>timestamp<",
|
|
383
316
|
"hasDynamicHelp": true,
|
|
384
317
|
"multiple": false,
|
|
385
318
|
"type": "option"
|
|
386
319
|
},
|
|
387
|
-
"
|
|
388
|
-
"
|
|
389
|
-
|
|
390
|
-
"wait"
|
|
320
|
+
"package-name": {
|
|
321
|
+
"aliases": [
|
|
322
|
+
"packagename"
|
|
391
323
|
],
|
|
392
|
-
"
|
|
393
|
-
"
|
|
394
|
-
"
|
|
395
|
-
"
|
|
324
|
+
"char": "n",
|
|
325
|
+
"deprecateAliases": true,
|
|
326
|
+
"name": "package-name",
|
|
327
|
+
"summary": "Name of the package to associate with the metadata-formatted files.",
|
|
328
|
+
"hasDynamicHelp": false,
|
|
329
|
+
"multiple": false,
|
|
330
|
+
"type": "option"
|
|
396
331
|
},
|
|
397
|
-
"
|
|
398
|
-
"char": "
|
|
399
|
-
"description": "
|
|
400
|
-
"name": "
|
|
401
|
-
"summary": "
|
|
332
|
+
"manifest": {
|
|
333
|
+
"char": "x",
|
|
334
|
+
"description": "If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
335
|
+
"name": "manifest",
|
|
336
|
+
"summary": "Path to the manifest (package.xml) file that specifies the metadata types to convert.",
|
|
402
337
|
"hasDynamicHelp": false,
|
|
403
338
|
"multiple": false,
|
|
404
339
|
"type": "option"
|
|
405
340
|
},
|
|
406
|
-
"
|
|
407
|
-
"
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
"
|
|
411
|
-
"
|
|
412
|
-
"
|
|
341
|
+
"source-dir": {
|
|
342
|
+
"aliases": [
|
|
343
|
+
"sourcepath"
|
|
344
|
+
],
|
|
345
|
+
"char": "p",
|
|
346
|
+
"deprecateAliases": true,
|
|
347
|
+
"description": "The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this flag, don’t specify --manifest or --metadata.",
|
|
348
|
+
"exclusive": [
|
|
349
|
+
"manifest",
|
|
350
|
+
"metadata"
|
|
351
|
+
],
|
|
352
|
+
"name": "source-dir",
|
|
353
|
+
"summary": "Paths to the local source files to convert.",
|
|
354
|
+
"delimiter": ",",
|
|
355
|
+
"hasDynamicHelp": false,
|
|
356
|
+
"multiple": true,
|
|
357
|
+
"type": "option"
|
|
413
358
|
},
|
|
414
|
-
"
|
|
415
|
-
"char": "
|
|
416
|
-
"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\".",
|
|
359
|
+
"metadata": {
|
|
360
|
+
"char": "m",
|
|
417
361
|
"exclusive": [
|
|
418
|
-
"
|
|
362
|
+
"manifest",
|
|
363
|
+
"sourcepath"
|
|
419
364
|
],
|
|
420
|
-
"name": "
|
|
421
|
-
"summary": "
|
|
422
|
-
"
|
|
423
|
-
"
|
|
424
|
-
"multiple":
|
|
365
|
+
"name": "metadata",
|
|
366
|
+
"summary": "Metadata component names to convert.",
|
|
367
|
+
"delimiter": ",",
|
|
368
|
+
"hasDynamicHelp": false,
|
|
369
|
+
"multiple": true,
|
|
425
370
|
"type": "option"
|
|
426
371
|
}
|
|
427
372
|
},
|
|
428
373
|
"hasDynamicHelp": true,
|
|
429
374
|
"hiddenAliases": [],
|
|
430
|
-
"id": "project:
|
|
375
|
+
"id": "project:convert:source",
|
|
431
376
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
432
377
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
433
378
|
"pluginType": "core",
|
|
434
379
|
"strict": true,
|
|
435
|
-
"summary": "
|
|
380
|
+
"summary": "Convert source-formatted files into metadata that you can deploy using Metadata API.",
|
|
436
381
|
"enableJsonFlag": true,
|
|
382
|
+
"requiresProject": true,
|
|
437
383
|
"isESM": true,
|
|
438
384
|
"relativePath": [
|
|
439
385
|
"lib",
|
|
440
386
|
"commands",
|
|
441
387
|
"project",
|
|
442
|
-
"
|
|
443
|
-
"
|
|
388
|
+
"convert",
|
|
389
|
+
"source.js"
|
|
444
390
|
],
|
|
445
391
|
"aliasPermutations": [
|
|
446
|
-
"
|
|
447
|
-
"
|
|
448
|
-
"
|
|
449
|
-
"
|
|
450
|
-
"
|
|
451
|
-
"
|
|
392
|
+
"force:source:convert",
|
|
393
|
+
"source:force:convert",
|
|
394
|
+
"source:convert:force",
|
|
395
|
+
"force:convert:source",
|
|
396
|
+
"convert:force:source",
|
|
397
|
+
"convert:source:force"
|
|
452
398
|
],
|
|
453
399
|
"permutations": [
|
|
454
|
-
"project:
|
|
455
|
-
"
|
|
456
|
-
"
|
|
457
|
-
"project:
|
|
458
|
-
"
|
|
459
|
-
"
|
|
400
|
+
"project:convert:source",
|
|
401
|
+
"convert:project:source",
|
|
402
|
+
"convert:source:project",
|
|
403
|
+
"project:source:convert",
|
|
404
|
+
"source:project:convert",
|
|
405
|
+
"source:convert:project"
|
|
460
406
|
]
|
|
461
407
|
},
|
|
462
|
-
"project:
|
|
408
|
+
"project:delete:source": {
|
|
463
409
|
"aliases": [
|
|
464
|
-
"
|
|
410
|
+
"force:source:delete"
|
|
465
411
|
],
|
|
466
412
|
"args": {},
|
|
467
413
|
"deprecateAliases": true,
|
|
468
|
-
"description": "
|
|
414
|
+
"description": "Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, \"<%= config.bin %> project deploy start\".\n\nWhen you run this command, both the local source file and the metadata component in the org are deleted.\n\nTo delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
|
|
469
415
|
"examples": [
|
|
470
|
-
"
|
|
471
|
-
"
|
|
472
|
-
"
|
|
473
|
-
"
|
|
474
|
-
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
416
|
+
"Delete all local Apex source files and all Apex classes from the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch",
|
|
417
|
+
"Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata \"Profile: My Profile\" --no-prompt",
|
|
418
|
+
"Run the tests that aren’t in any managed packages as part of the deletion; if the delete succeeds, and the org has source-tracking enabled, update the source tracking information:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source",
|
|
419
|
+
"Delete the Apex source files in a directory and the corresponding components from your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes"
|
|
475
420
|
],
|
|
476
421
|
"flags": {
|
|
477
422
|
"json": {
|
|
@@ -489,54 +434,34 @@
|
|
|
489
434
|
"multiple": false,
|
|
490
435
|
"type": "option"
|
|
491
436
|
},
|
|
492
|
-
"
|
|
493
|
-
"
|
|
494
|
-
|
|
495
|
-
"name": "ignore-conflicts",
|
|
496
|
-
"summary": "Don't display conflicts in preview of the deployment.",
|
|
497
|
-
"allowNo": false,
|
|
498
|
-
"type": "boolean"
|
|
499
|
-
},
|
|
500
|
-
"manifest": {
|
|
501
|
-
"char": "x",
|
|
502
|
-
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
503
|
-
"exclusive": [
|
|
504
|
-
"source-dir",
|
|
505
|
-
"metadata"
|
|
437
|
+
"api-version": {
|
|
438
|
+
"aliases": [
|
|
439
|
+
"apiversion"
|
|
506
440
|
],
|
|
507
|
-
"
|
|
508
|
-
"
|
|
441
|
+
"deprecateAliases": true,
|
|
442
|
+
"description": "Override the api version used for api requests made by this command",
|
|
443
|
+
"name": "api-version",
|
|
509
444
|
"hasDynamicHelp": false,
|
|
510
445
|
"multiple": false,
|
|
511
446
|
"type": "option"
|
|
512
447
|
},
|
|
513
|
-
"
|
|
514
|
-
"
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
"name": "metadata",
|
|
520
|
-
"summary": "Metadata component names to preview.",
|
|
521
|
-
"hasDynamicHelp": false,
|
|
522
|
-
"multiple": true,
|
|
523
|
-
"type": "option"
|
|
524
|
-
},
|
|
525
|
-
"source-dir": {
|
|
526
|
-
"char": "d",
|
|
527
|
-
"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.",
|
|
528
|
-
"exclusive": [
|
|
529
|
-
"manifest",
|
|
530
|
-
"metadata"
|
|
531
|
-
],
|
|
532
|
-
"name": "source-dir",
|
|
533
|
-
"summary": "Path to the local source files to preview.",
|
|
448
|
+
"loglevel": {
|
|
449
|
+
"deprecated": {
|
|
450
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SF_LOG_LEVEL` environment variable."
|
|
451
|
+
},
|
|
452
|
+
"hidden": true,
|
|
453
|
+
"name": "loglevel",
|
|
534
454
|
"hasDynamicHelp": false,
|
|
535
|
-
"multiple":
|
|
455
|
+
"multiple": false,
|
|
536
456
|
"type": "option"
|
|
537
457
|
},
|
|
538
458
|
"target-org": {
|
|
459
|
+
"aliases": [
|
|
460
|
+
"targetusername",
|
|
461
|
+
"u"
|
|
462
|
+
],
|
|
539
463
|
"char": "o",
|
|
464
|
+
"deprecateAliases": true,
|
|
540
465
|
"name": "target-org",
|
|
541
466
|
"noCacheDefault": true,
|
|
542
467
|
"required": true,
|
|
@@ -545,21 +470,135 @@
|
|
|
545
470
|
"multiple": false,
|
|
546
471
|
"type": "option"
|
|
547
472
|
},
|
|
548
|
-
"
|
|
549
|
-
"
|
|
550
|
-
|
|
473
|
+
"check-only": {
|
|
474
|
+
"aliases": [
|
|
475
|
+
"checkonly"
|
|
476
|
+
],
|
|
477
|
+
"char": "c",
|
|
478
|
+
"deprecateAliases": true,
|
|
479
|
+
"description": "IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nValidates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.\n\nIf you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only flag to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.\n\nIf your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.\n\nNote: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.\n\n 1. For a deletion with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to delete the Master-Detail field, or the deletion fails. During the deletion, detail records are permanently deleted from the Recycle Bin and cannot be recovered.\n\n 2. For a deletion that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deletion to succeed. However, a successful deletion permanently deletes any detail records in the Recycle Bin.",
|
|
480
|
+
"name": "check-only",
|
|
481
|
+
"summary": "Validate delete command but don't delete anything from the org or the local project.",
|
|
482
|
+
"allowNo": false,
|
|
483
|
+
"type": "boolean"
|
|
484
|
+
},
|
|
485
|
+
"wait": {
|
|
486
|
+
"char": "w",
|
|
487
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
|
|
488
|
+
"name": "wait",
|
|
489
|
+
"summary": "Number of minutes to wait for the command to finish.",
|
|
490
|
+
"hasDynamicHelp": true,
|
|
491
|
+
"multiple": false,
|
|
492
|
+
"type": "option"
|
|
493
|
+
},
|
|
494
|
+
"tests": {
|
|
495
|
+
"description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
|
|
496
|
+
"helpGroup": "Test",
|
|
497
|
+
"name": "tests",
|
|
498
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
499
|
+
"hasDynamicHelp": false,
|
|
500
|
+
"multiple": true,
|
|
501
|
+
"type": "option"
|
|
502
|
+
},
|
|
503
|
+
"test-level": {
|
|
504
|
+
"aliases": [
|
|
505
|
+
"testlevel"
|
|
506
|
+
],
|
|
507
|
+
"char": "l",
|
|
508
|
+
"deprecateAliases": true,
|
|
509
|
+
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\n- RunRelevantTests (Beta) — Runs only tests that are relevant to the files being deployed. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies. For fine-grained control, you can also annotate test classes so that they always run in certain conditions. See \"@IsTest Annotation\" in the \"Apex Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_annotation_isTest.htm). Each class and trigger in the deployment package must be covered by the executed tests for a minimum of 75% code coverage. This coverage is computed for each class and triggers individually and is different than the overall coverage percentage.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see \"Running Tests in a Deployment\" (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
|
|
510
|
+
"helpGroup": "Test",
|
|
511
|
+
"name": "test-level",
|
|
512
|
+
"summary": "Deployment Apex testing level.",
|
|
513
|
+
"hasDynamicHelp": false,
|
|
514
|
+
"multiple": false,
|
|
515
|
+
"options": [
|
|
516
|
+
"NoTestRun",
|
|
517
|
+
"RunSpecifiedTests",
|
|
518
|
+
"RunLocalTests",
|
|
519
|
+
"RunAllTestsInOrg",
|
|
520
|
+
"RunRelevantTests"
|
|
521
|
+
],
|
|
522
|
+
"type": "option"
|
|
523
|
+
},
|
|
524
|
+
"no-prompt": {
|
|
525
|
+
"aliases": [
|
|
526
|
+
"noprompt"
|
|
527
|
+
],
|
|
528
|
+
"char": "r",
|
|
529
|
+
"deprecateAliases": true,
|
|
530
|
+
"name": "no-prompt",
|
|
531
|
+
"summary": "Don't prompt for delete confirmation.",
|
|
532
|
+
"allowNo": false,
|
|
533
|
+
"type": "boolean"
|
|
534
|
+
},
|
|
535
|
+
"metadata": {
|
|
536
|
+
"char": "m",
|
|
537
|
+
"description": "If you specify this flag, don’t specify --source-dir.",
|
|
538
|
+
"name": "metadata",
|
|
539
|
+
"summary": "Metadata components to delete.",
|
|
540
|
+
"delimiter": ",",
|
|
541
|
+
"hasDynamicHelp": false,
|
|
542
|
+
"multiple": true,
|
|
543
|
+
"type": "option"
|
|
544
|
+
},
|
|
545
|
+
"source-dir": {
|
|
546
|
+
"aliases": [
|
|
547
|
+
"sourcepath"
|
|
548
|
+
],
|
|
549
|
+
"char": "p",
|
|
550
|
+
"deprecateAliases": true,
|
|
551
|
+
"description": "The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this flag, don’t specify --metadata.",
|
|
552
|
+
"name": "source-dir",
|
|
553
|
+
"summary": "Source file paths to delete.",
|
|
554
|
+
"delimiter": ",",
|
|
555
|
+
"hasDynamicHelp": false,
|
|
556
|
+
"multiple": true,
|
|
557
|
+
"type": "option"
|
|
558
|
+
},
|
|
559
|
+
"track-source": {
|
|
560
|
+
"aliases": [
|
|
561
|
+
"tracksource"
|
|
562
|
+
],
|
|
563
|
+
"char": "t",
|
|
564
|
+
"deprecateAliases": true,
|
|
565
|
+
"exclusive": [
|
|
566
|
+
"check-only"
|
|
567
|
+
],
|
|
568
|
+
"name": "track-source",
|
|
569
|
+
"summary": "If the delete succeeds, update the source tracking information.",
|
|
570
|
+
"allowNo": false,
|
|
571
|
+
"type": "boolean"
|
|
572
|
+
},
|
|
573
|
+
"force-overwrite": {
|
|
574
|
+
"aliases": [
|
|
575
|
+
"forceoverwrite"
|
|
576
|
+
],
|
|
577
|
+
"char": "f",
|
|
578
|
+
"dependsOn": [
|
|
579
|
+
"track-source"
|
|
580
|
+
],
|
|
581
|
+
"deprecateAliases": true,
|
|
582
|
+
"name": "force-overwrite",
|
|
583
|
+
"summary": "Ignore conflict warnings and overwrite changes to the org.",
|
|
584
|
+
"allowNo": false,
|
|
585
|
+
"type": "boolean"
|
|
586
|
+
},
|
|
587
|
+
"verbose": {
|
|
588
|
+
"name": "verbose",
|
|
589
|
+
"summary": "Verbose output of the delete result.",
|
|
551
590
|
"allowNo": false,
|
|
552
591
|
"type": "boolean"
|
|
553
592
|
}
|
|
554
593
|
},
|
|
555
594
|
"hasDynamicHelp": true,
|
|
556
595
|
"hiddenAliases": [],
|
|
557
|
-
"id": "project:
|
|
596
|
+
"id": "project:delete:source",
|
|
558
597
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
559
598
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
560
599
|
"pluginType": "core",
|
|
561
600
|
"strict": true,
|
|
562
|
-
"summary": "
|
|
601
|
+
"summary": "Delete source from your project and from a non-source-tracked org.",
|
|
563
602
|
"enableJsonFlag": true,
|
|
564
603
|
"requiresProject": true,
|
|
565
604
|
"isESM": true,
|
|
@@ -567,36 +606,35 @@
|
|
|
567
606
|
"lib",
|
|
568
607
|
"commands",
|
|
569
608
|
"project",
|
|
570
|
-
"
|
|
571
|
-
"
|
|
609
|
+
"delete",
|
|
610
|
+
"source.js"
|
|
572
611
|
],
|
|
573
612
|
"aliasPermutations": [
|
|
574
|
-
"
|
|
575
|
-
"
|
|
576
|
-
"
|
|
577
|
-
"
|
|
578
|
-
"
|
|
579
|
-
"
|
|
613
|
+
"force:source:delete",
|
|
614
|
+
"source:force:delete",
|
|
615
|
+
"source:delete:force",
|
|
616
|
+
"force:delete:source",
|
|
617
|
+
"delete:force:source",
|
|
618
|
+
"delete:source:force"
|
|
580
619
|
],
|
|
581
620
|
"permutations": [
|
|
582
|
-
"project:
|
|
583
|
-
"
|
|
584
|
-
"
|
|
585
|
-
"project:
|
|
586
|
-
"
|
|
587
|
-
"
|
|
621
|
+
"project:delete:source",
|
|
622
|
+
"delete:project:source",
|
|
623
|
+
"delete:source:project",
|
|
624
|
+
"project:source:delete",
|
|
625
|
+
"source:project:delete",
|
|
626
|
+
"source:delete:project"
|
|
588
627
|
]
|
|
589
628
|
},
|
|
590
|
-
"project:
|
|
629
|
+
"project:delete:tracking": {
|
|
591
630
|
"aliases": [
|
|
592
|
-
"
|
|
631
|
+
"force:source:tracking:clear"
|
|
593
632
|
],
|
|
594
633
|
"args": {},
|
|
595
634
|
"deprecateAliases": true,
|
|
596
|
-
"description": "
|
|
635
|
+
"description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nDeletes all local source tracking information. When you next run 'project deploy preview', Salesforce CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts.",
|
|
597
636
|
"examples": [
|
|
598
|
-
"
|
|
599
|
-
"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"
|
|
637
|
+
"Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
|
|
600
638
|
],
|
|
601
639
|
"flags": {
|
|
602
640
|
"json": {
|
|
@@ -614,162 +652,117 @@
|
|
|
614
652
|
"multiple": false,
|
|
615
653
|
"type": "option"
|
|
616
654
|
},
|
|
617
|
-
"
|
|
618
|
-
"
|
|
619
|
-
|
|
620
|
-
"wait"
|
|
621
|
-
],
|
|
622
|
-
"name": "async",
|
|
623
|
-
"summary": "Run the command asynchronously.",
|
|
624
|
-
"allowNo": false,
|
|
625
|
-
"type": "boolean"
|
|
626
|
-
},
|
|
627
|
-
"concise": {
|
|
628
|
-
"exclusive": [
|
|
629
|
-
"verbose"
|
|
655
|
+
"api-version": {
|
|
656
|
+
"aliases": [
|
|
657
|
+
"apiversion"
|
|
630
658
|
],
|
|
631
|
-
"
|
|
632
|
-
"
|
|
633
|
-
"
|
|
634
|
-
"
|
|
659
|
+
"deprecateAliases": true,
|
|
660
|
+
"description": "Override the api version used for api requests made by this command",
|
|
661
|
+
"name": "api-version",
|
|
662
|
+
"hasDynamicHelp": false,
|
|
663
|
+
"multiple": false,
|
|
664
|
+
"type": "option"
|
|
635
665
|
},
|
|
636
|
-
"
|
|
637
|
-
"
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
"
|
|
666
|
+
"loglevel": {
|
|
667
|
+
"deprecated": {
|
|
668
|
+
"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 `SF_LOG_LEVEL` environment variable."
|
|
669
|
+
},
|
|
670
|
+
"hidden": true,
|
|
671
|
+
"name": "loglevel",
|
|
641
672
|
"hasDynamicHelp": false,
|
|
642
673
|
"multiple": false,
|
|
643
674
|
"type": "option"
|
|
644
675
|
},
|
|
645
676
|
"target-org": {
|
|
677
|
+
"aliases": [
|
|
678
|
+
"targetusername",
|
|
679
|
+
"u"
|
|
680
|
+
],
|
|
646
681
|
"char": "o",
|
|
682
|
+
"deprecateAliases": true,
|
|
647
683
|
"name": "target-org",
|
|
648
684
|
"noCacheDefault": true,
|
|
649
|
-
"
|
|
685
|
+
"required": true,
|
|
686
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
650
687
|
"hasDynamicHelp": true,
|
|
651
688
|
"multiple": false,
|
|
652
689
|
"type": "option"
|
|
653
690
|
},
|
|
654
|
-
"
|
|
655
|
-
"
|
|
656
|
-
|
|
657
|
-
"name": "use-most-recent",
|
|
658
|
-
"summary": "Use the job ID of the most recently validated deployment.",
|
|
659
|
-
"allowNo": false,
|
|
660
|
-
"type": "boolean"
|
|
661
|
-
},
|
|
662
|
-
"verbose": {
|
|
663
|
-
"exclusive": [
|
|
664
|
-
"concise"
|
|
691
|
+
"no-prompt": {
|
|
692
|
+
"aliases": [
|
|
693
|
+
"noprompt"
|
|
665
694
|
],
|
|
666
|
-
"
|
|
667
|
-
"
|
|
695
|
+
"char": "p",
|
|
696
|
+
"deprecateAliases": true,
|
|
697
|
+
"name": "no-prompt",
|
|
698
|
+
"summary": "Don't prompt for source tracking override confirmation.",
|
|
668
699
|
"allowNo": false,
|
|
669
700
|
"type": "boolean"
|
|
670
|
-
},
|
|
671
|
-
"wait": {
|
|
672
|
-
"char": "w",
|
|
673
|
-
"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\".",
|
|
674
|
-
"exclusive": [
|
|
675
|
-
"async"
|
|
676
|
-
],
|
|
677
|
-
"name": "wait",
|
|
678
|
-
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
679
|
-
"default": "33 minutes",
|
|
680
|
-
"hasDynamicHelp": true,
|
|
681
|
-
"helpValue": "<minutes>",
|
|
682
|
-
"multiple": false,
|
|
683
|
-
"type": "option"
|
|
684
|
-
},
|
|
685
|
-
"api-version": {
|
|
686
|
-
"char": "a",
|
|
687
|
-
"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.",
|
|
688
|
-
"name": "api-version",
|
|
689
|
-
"summary": "Target API version for the deploy.",
|
|
690
|
-
"hasDynamicHelp": false,
|
|
691
|
-
"multiple": false,
|
|
692
|
-
"type": "option"
|
|
693
701
|
}
|
|
694
702
|
},
|
|
695
703
|
"hasDynamicHelp": true,
|
|
696
704
|
"hiddenAliases": [],
|
|
697
|
-
"id": "project:
|
|
705
|
+
"id": "project:delete:tracking",
|
|
698
706
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
699
707
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
700
708
|
"pluginType": "core",
|
|
701
709
|
"strict": true,
|
|
702
|
-
"summary": "
|
|
710
|
+
"summary": "Delete all local source tracking information.",
|
|
703
711
|
"enableJsonFlag": true,
|
|
704
|
-
"
|
|
705
|
-
"header": "ERROR CODES",
|
|
706
|
-
"body": [
|
|
707
|
-
{
|
|
708
|
-
"name": "Succeeded (0)",
|
|
709
|
-
"description": "The deploy succeeded."
|
|
710
|
-
},
|
|
711
|
-
{
|
|
712
|
-
"name": "Canceled (1)",
|
|
713
|
-
"description": "The deploy was canceled."
|
|
714
|
-
},
|
|
715
|
-
{
|
|
716
|
-
"name": "Failed (1)",
|
|
717
|
-
"description": "The deploy failed."
|
|
718
|
-
},
|
|
719
|
-
{
|
|
720
|
-
"name": "SucceededPartial (68)",
|
|
721
|
-
"description": "The deploy partially succeeded."
|
|
722
|
-
},
|
|
723
|
-
{
|
|
724
|
-
"name": "InProgress (69)",
|
|
725
|
-
"description": "The deploy is in progress."
|
|
726
|
-
},
|
|
727
|
-
{
|
|
728
|
-
"name": "Pending (69)",
|
|
729
|
-
"description": "The deploy is pending."
|
|
730
|
-
},
|
|
731
|
-
{
|
|
732
|
-
"name": "Canceling (69)",
|
|
733
|
-
"description": "The deploy is being canceled."
|
|
734
|
-
}
|
|
735
|
-
]
|
|
736
|
-
},
|
|
712
|
+
"requiresProject": true,
|
|
737
713
|
"isESM": true,
|
|
738
714
|
"relativePath": [
|
|
739
715
|
"lib",
|
|
740
716
|
"commands",
|
|
741
717
|
"project",
|
|
742
|
-
"
|
|
743
|
-
"
|
|
718
|
+
"delete",
|
|
719
|
+
"tracking.js"
|
|
744
720
|
],
|
|
745
721
|
"aliasPermutations": [
|
|
746
|
-
"
|
|
747
|
-
"
|
|
748
|
-
"
|
|
749
|
-
"
|
|
750
|
-
"
|
|
751
|
-
"
|
|
722
|
+
"force:source:tracking:clear",
|
|
723
|
+
"source:force:tracking:clear",
|
|
724
|
+
"source:tracking:force:clear",
|
|
725
|
+
"source:tracking:clear:force",
|
|
726
|
+
"force:tracking:source:clear",
|
|
727
|
+
"tracking:force:source:clear",
|
|
728
|
+
"tracking:source:force:clear",
|
|
729
|
+
"tracking:source:clear:force",
|
|
730
|
+
"force:tracking:clear:source",
|
|
731
|
+
"tracking:force:clear:source",
|
|
732
|
+
"tracking:clear:force:source",
|
|
733
|
+
"tracking:clear:source:force",
|
|
734
|
+
"force:source:clear:tracking",
|
|
735
|
+
"source:force:clear:tracking",
|
|
736
|
+
"source:clear:force:tracking",
|
|
737
|
+
"source:clear:tracking:force",
|
|
738
|
+
"force:clear:source:tracking",
|
|
739
|
+
"clear:force:source:tracking",
|
|
740
|
+
"clear:source:force:tracking",
|
|
741
|
+
"clear:source:tracking:force",
|
|
742
|
+
"force:clear:tracking:source",
|
|
743
|
+
"clear:force:tracking:source",
|
|
744
|
+
"clear:tracking:force:source",
|
|
745
|
+
"clear:tracking:source:force"
|
|
752
746
|
],
|
|
753
747
|
"permutations": [
|
|
754
|
-
"project:
|
|
755
|
-
"
|
|
756
|
-
"
|
|
757
|
-
"project:
|
|
758
|
-
"
|
|
759
|
-
"
|
|
748
|
+
"project:delete:tracking",
|
|
749
|
+
"delete:project:tracking",
|
|
750
|
+
"delete:tracking:project",
|
|
751
|
+
"project:tracking:delete",
|
|
752
|
+
"tracking:project:delete",
|
|
753
|
+
"tracking:delete:project"
|
|
760
754
|
]
|
|
761
755
|
},
|
|
762
|
-
"project:deploy:
|
|
756
|
+
"project:deploy:cancel": {
|
|
763
757
|
"aliases": [
|
|
764
|
-
"deploy:metadata:
|
|
758
|
+
"deploy:metadata:cancel"
|
|
765
759
|
],
|
|
766
760
|
"args": {},
|
|
767
761
|
"deprecateAliases": true,
|
|
768
|
-
"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.
|
|
762
|
+
"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.",
|
|
769
763
|
"examples": [
|
|
770
|
-
"
|
|
771
|
-
"
|
|
772
|
-
"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"
|
|
764
|
+
"Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
765
|
+
"Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
773
766
|
],
|
|
774
767
|
"flags": {
|
|
775
768
|
"json": {
|
|
@@ -796,74 +789,41 @@
|
|
|
796
789
|
"multiple": false,
|
|
797
790
|
"type": "option"
|
|
798
791
|
},
|
|
792
|
+
"async": {
|
|
793
|
+
"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\".",
|
|
794
|
+
"exclusive": [
|
|
795
|
+
"wait"
|
|
796
|
+
],
|
|
797
|
+
"name": "async",
|
|
798
|
+
"summary": "Run the command asynchronously.",
|
|
799
|
+
"allowNo": false,
|
|
800
|
+
"type": "boolean"
|
|
801
|
+
},
|
|
799
802
|
"job-id": {
|
|
800
803
|
"char": "i",
|
|
801
804
|
"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.",
|
|
802
805
|
"name": "job-id",
|
|
803
|
-
"summary": "Job ID of the deploy operation you want to
|
|
806
|
+
"summary": "Job ID of the deploy operation you want to cancel.",
|
|
804
807
|
"hasDynamicHelp": false,
|
|
805
808
|
"multiple": false,
|
|
806
809
|
"type": "option"
|
|
807
810
|
},
|
|
808
811
|
"use-most-recent": {
|
|
809
812
|
"char": "r",
|
|
810
|
-
"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
|
|
813
|
+
"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.",
|
|
811
814
|
"name": "use-most-recent",
|
|
812
815
|
"summary": "Use the job ID of the most recent deploy operation.",
|
|
813
816
|
"allowNo": false,
|
|
814
817
|
"type": "boolean"
|
|
815
818
|
},
|
|
816
|
-
"coverage-formatters": {
|
|
817
|
-
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
818
|
-
"helpGroup": "Test",
|
|
819
|
-
"name": "coverage-formatters",
|
|
820
|
-
"summary": "Format of the code coverage results.",
|
|
821
|
-
"hasDynamicHelp": false,
|
|
822
|
-
"multiple": true,
|
|
823
|
-
"options": [
|
|
824
|
-
"clover",
|
|
825
|
-
"cobertura",
|
|
826
|
-
"html-spa",
|
|
827
|
-
"html",
|
|
828
|
-
"json",
|
|
829
|
-
"json-summary",
|
|
830
|
-
"lcovonly",
|
|
831
|
-
"none",
|
|
832
|
-
"teamcity",
|
|
833
|
-
"text",
|
|
834
|
-
"text-summary"
|
|
835
|
-
],
|
|
836
|
-
"type": "option"
|
|
837
|
-
},
|
|
838
|
-
"junit": {
|
|
839
|
-
"helpGroup": "Test",
|
|
840
|
-
"name": "junit",
|
|
841
|
-
"summary": "Output JUnit test results.",
|
|
842
|
-
"allowNo": false,
|
|
843
|
-
"type": "boolean"
|
|
844
|
-
},
|
|
845
|
-
"results-dir": {
|
|
846
|
-
"helpGroup": "Test",
|
|
847
|
-
"name": "results-dir",
|
|
848
|
-
"relationships": [
|
|
849
|
-
{
|
|
850
|
-
"type": "some",
|
|
851
|
-
"flags": [
|
|
852
|
-
"coverage-formatters",
|
|
853
|
-
"junit"
|
|
854
|
-
]
|
|
855
|
-
}
|
|
856
|
-
],
|
|
857
|
-
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
858
|
-
"hasDynamicHelp": false,
|
|
859
|
-
"multiple": false,
|
|
860
|
-
"type": "option"
|
|
861
|
-
},
|
|
862
819
|
"wait": {
|
|
863
820
|
"char": "w",
|
|
864
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you
|
|
821
|
+
"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\".",
|
|
822
|
+
"exclusive": [
|
|
823
|
+
"async"
|
|
824
|
+
],
|
|
865
825
|
"name": "wait",
|
|
866
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
826
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
867
827
|
"hasDynamicHelp": true,
|
|
868
828
|
"helpValue": "<minutes>",
|
|
869
829
|
"multiple": false,
|
|
@@ -872,12 +832,12 @@
|
|
|
872
832
|
},
|
|
873
833
|
"hasDynamicHelp": true,
|
|
874
834
|
"hiddenAliases": [],
|
|
875
|
-
"id": "project:deploy:
|
|
835
|
+
"id": "project:deploy:cancel",
|
|
876
836
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
877
837
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
878
838
|
"pluginType": "core",
|
|
879
839
|
"strict": true,
|
|
880
|
-
"summary": "
|
|
840
|
+
"summary": "Cancel a deploy operation.",
|
|
881
841
|
"enableJsonFlag": true,
|
|
882
842
|
"isESM": true,
|
|
883
843
|
"relativePath": [
|
|
@@ -885,35 +845,38 @@
|
|
|
885
845
|
"commands",
|
|
886
846
|
"project",
|
|
887
847
|
"deploy",
|
|
888
|
-
"
|
|
848
|
+
"cancel.js"
|
|
889
849
|
],
|
|
890
850
|
"aliasPermutations": [
|
|
891
|
-
"deploy:metadata:
|
|
892
|
-
"metadata:deploy:
|
|
893
|
-
"metadata:
|
|
894
|
-
"deploy:
|
|
895
|
-
"
|
|
896
|
-
"
|
|
851
|
+
"deploy:metadata:cancel",
|
|
852
|
+
"metadata:deploy:cancel",
|
|
853
|
+
"metadata:cancel:deploy",
|
|
854
|
+
"deploy:cancel:metadata",
|
|
855
|
+
"cancel:deploy:metadata",
|
|
856
|
+
"cancel:metadata:deploy"
|
|
897
857
|
],
|
|
898
858
|
"permutations": [
|
|
899
|
-
"project:deploy:
|
|
900
|
-
"deploy:project:
|
|
901
|
-
"deploy:
|
|
902
|
-
"project:
|
|
903
|
-
"
|
|
904
|
-
"
|
|
859
|
+
"project:deploy:cancel",
|
|
860
|
+
"deploy:project:cancel",
|
|
861
|
+
"deploy:cancel:project",
|
|
862
|
+
"project:cancel:deploy",
|
|
863
|
+
"cancel:project:deploy",
|
|
864
|
+
"cancel:deploy:project"
|
|
905
865
|
]
|
|
906
866
|
},
|
|
907
|
-
"project:deploy:
|
|
867
|
+
"project:deploy:preview": {
|
|
908
868
|
"aliases": [
|
|
909
|
-
"deploy:metadata:
|
|
869
|
+
"deploy:metadata:preview"
|
|
910
870
|
],
|
|
911
871
|
"args": {},
|
|
912
872
|
"deprecateAliases": true,
|
|
913
|
-
"description": "
|
|
873
|
+
"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.",
|
|
914
874
|
"examples": [
|
|
915
|
-
"
|
|
916
|
-
"
|
|
875
|
+
"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.",
|
|
876
|
+
"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",
|
|
877
|
+
"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",
|
|
878
|
+
"Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
879
|
+
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
917
880
|
],
|
|
918
881
|
"flags": {
|
|
919
882
|
"json": {
|
|
@@ -931,196 +894,114 @@
|
|
|
931
894
|
"multiple": false,
|
|
932
895
|
"type": "option"
|
|
933
896
|
},
|
|
934
|
-
"
|
|
935
|
-
"
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
"
|
|
939
|
-
"summary": "Show concise output of the deploy operation result.",
|
|
897
|
+
"ignore-conflicts": {
|
|
898
|
+
"char": "c",
|
|
899
|
+
"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.",
|
|
900
|
+
"name": "ignore-conflicts",
|
|
901
|
+
"summary": "Don't display conflicts in preview of the deployment.",
|
|
940
902
|
"allowNo": false,
|
|
941
903
|
"type": "boolean"
|
|
942
904
|
},
|
|
943
|
-
"
|
|
944
|
-
"char": "
|
|
945
|
-
"description": "
|
|
946
|
-
"
|
|
947
|
-
|
|
905
|
+
"manifest": {
|
|
906
|
+
"char": "x",
|
|
907
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
908
|
+
"exclusive": [
|
|
909
|
+
"source-dir",
|
|
910
|
+
"metadata"
|
|
911
|
+
],
|
|
912
|
+
"name": "manifest",
|
|
913
|
+
"summary": "Full file path for manifest (package.xml) of components to preview.",
|
|
948
914
|
"hasDynamicHelp": false,
|
|
949
915
|
"multiple": false,
|
|
950
916
|
"type": "option"
|
|
951
917
|
},
|
|
952
|
-
"
|
|
953
|
-
"char": "
|
|
954
|
-
"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.",
|
|
955
|
-
"name": "use-most-recent",
|
|
956
|
-
"summary": "Use the job ID of the most recent deploy operation.",
|
|
957
|
-
"allowNo": false,
|
|
958
|
-
"type": "boolean"
|
|
959
|
-
},
|
|
960
|
-
"verbose": {
|
|
918
|
+
"metadata": {
|
|
919
|
+
"char": "m",
|
|
961
920
|
"exclusive": [
|
|
962
|
-
"
|
|
921
|
+
"manifest",
|
|
922
|
+
"source-dir"
|
|
963
923
|
],
|
|
964
|
-
"name": "
|
|
965
|
-
"summary": "
|
|
966
|
-
"allowNo": false,
|
|
967
|
-
"type": "boolean"
|
|
968
|
-
},
|
|
969
|
-
"wait": {
|
|
970
|
-
"char": "w",
|
|
971
|
-
"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\".",
|
|
972
|
-
"name": "wait",
|
|
973
|
-
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
974
|
-
"hasDynamicHelp": true,
|
|
975
|
-
"helpValue": "<minutes>",
|
|
976
|
-
"multiple": false,
|
|
977
|
-
"type": "option"
|
|
978
|
-
},
|
|
979
|
-
"coverage-formatters": {
|
|
980
|
-
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
981
|
-
"helpGroup": "Test",
|
|
982
|
-
"name": "coverage-formatters",
|
|
983
|
-
"summary": "Format of the code coverage results.",
|
|
924
|
+
"name": "metadata",
|
|
925
|
+
"summary": "Metadata component names to preview.",
|
|
984
926
|
"hasDynamicHelp": false,
|
|
985
927
|
"multiple": true,
|
|
986
|
-
"options": [
|
|
987
|
-
"clover",
|
|
988
|
-
"cobertura",
|
|
989
|
-
"html-spa",
|
|
990
|
-
"html",
|
|
991
|
-
"json",
|
|
992
|
-
"json-summary",
|
|
993
|
-
"lcovonly",
|
|
994
|
-
"none",
|
|
995
|
-
"teamcity",
|
|
996
|
-
"text",
|
|
997
|
-
"text-summary"
|
|
998
|
-
],
|
|
999
928
|
"type": "option"
|
|
1000
929
|
},
|
|
1001
|
-
"
|
|
1002
|
-
"
|
|
1003
|
-
"
|
|
1004
|
-
"
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
},
|
|
1008
|
-
"results-dir": {
|
|
1009
|
-
"helpGroup": "Test",
|
|
1010
|
-
"name": "results-dir",
|
|
1011
|
-
"relationships": [
|
|
1012
|
-
{
|
|
1013
|
-
"type": "some",
|
|
1014
|
-
"flags": [
|
|
1015
|
-
"coverage-formatters",
|
|
1016
|
-
"junit"
|
|
1017
|
-
]
|
|
1018
|
-
}
|
|
930
|
+
"source-dir": {
|
|
931
|
+
"char": "d",
|
|
932
|
+
"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.",
|
|
933
|
+
"exclusive": [
|
|
934
|
+
"manifest",
|
|
935
|
+
"metadata"
|
|
1019
936
|
],
|
|
1020
|
-
"
|
|
937
|
+
"name": "source-dir",
|
|
938
|
+
"summary": "Path to the local source files to preview.",
|
|
1021
939
|
"hasDynamicHelp": false,
|
|
940
|
+
"multiple": true,
|
|
941
|
+
"type": "option"
|
|
942
|
+
},
|
|
943
|
+
"target-org": {
|
|
944
|
+
"char": "o",
|
|
945
|
+
"name": "target-org",
|
|
946
|
+
"noCacheDefault": true,
|
|
947
|
+
"required": true,
|
|
948
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
949
|
+
"hasDynamicHelp": true,
|
|
1022
950
|
"multiple": false,
|
|
1023
951
|
"type": "option"
|
|
952
|
+
},
|
|
953
|
+
"concise": {
|
|
954
|
+
"name": "concise",
|
|
955
|
+
"summary": "Show only the changes that will be deployed; omits files that are forceignored.",
|
|
956
|
+
"allowNo": false,
|
|
957
|
+
"type": "boolean"
|
|
1024
958
|
}
|
|
1025
959
|
},
|
|
1026
960
|
"hasDynamicHelp": true,
|
|
1027
961
|
"hiddenAliases": [],
|
|
1028
|
-
"id": "project:deploy:
|
|
962
|
+
"id": "project:deploy:preview",
|
|
1029
963
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1030
964
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1031
965
|
"pluginType": "core",
|
|
1032
966
|
"strict": true,
|
|
1033
|
-
"summary": "
|
|
967
|
+
"summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
|
|
1034
968
|
"enableJsonFlag": true,
|
|
1035
|
-
"
|
|
1036
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1037
|
-
"body": [
|
|
1038
|
-
{
|
|
1039
|
-
"name": "SF_USE_PROGRESS_BAR",
|
|
1040
|
-
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1041
|
-
}
|
|
1042
|
-
]
|
|
1043
|
-
},
|
|
1044
|
-
"errorCodes": {
|
|
1045
|
-
"header": "ERROR CODES",
|
|
1046
|
-
"body": [
|
|
1047
|
-
{
|
|
1048
|
-
"name": "Succeeded (0)",
|
|
1049
|
-
"description": "The deploy succeeded."
|
|
1050
|
-
},
|
|
1051
|
-
{
|
|
1052
|
-
"name": "Canceled (1)",
|
|
1053
|
-
"description": "The deploy was canceled."
|
|
1054
|
-
},
|
|
1055
|
-
{
|
|
1056
|
-
"name": "Failed (1)",
|
|
1057
|
-
"description": "The deploy failed."
|
|
1058
|
-
},
|
|
1059
|
-
{
|
|
1060
|
-
"name": "SucceededPartial (68)",
|
|
1061
|
-
"description": "The deploy partially succeeded."
|
|
1062
|
-
},
|
|
1063
|
-
{
|
|
1064
|
-
"name": "InProgress (69)",
|
|
1065
|
-
"description": "The deploy is in progress."
|
|
1066
|
-
},
|
|
1067
|
-
{
|
|
1068
|
-
"name": "Pending (69)",
|
|
1069
|
-
"description": "The deploy is pending."
|
|
1070
|
-
},
|
|
1071
|
-
{
|
|
1072
|
-
"name": "Canceling (69)",
|
|
1073
|
-
"description": "The deploy is being canceled."
|
|
1074
|
-
}
|
|
1075
|
-
]
|
|
1076
|
-
},
|
|
969
|
+
"requiresProject": true,
|
|
1077
970
|
"isESM": true,
|
|
1078
971
|
"relativePath": [
|
|
1079
972
|
"lib",
|
|
1080
973
|
"commands",
|
|
1081
974
|
"project",
|
|
1082
975
|
"deploy",
|
|
1083
|
-
"
|
|
976
|
+
"preview.js"
|
|
1084
977
|
],
|
|
1085
978
|
"aliasPermutations": [
|
|
1086
|
-
"deploy:metadata:
|
|
1087
|
-
"metadata:deploy:
|
|
1088
|
-
"metadata:
|
|
1089
|
-
"deploy:
|
|
1090
|
-
"
|
|
1091
|
-
"
|
|
979
|
+
"deploy:metadata:preview",
|
|
980
|
+
"metadata:deploy:preview",
|
|
981
|
+
"metadata:preview:deploy",
|
|
982
|
+
"deploy:preview:metadata",
|
|
983
|
+
"preview:deploy:metadata",
|
|
984
|
+
"preview:metadata:deploy"
|
|
1092
985
|
],
|
|
1093
986
|
"permutations": [
|
|
1094
|
-
"project:deploy:
|
|
1095
|
-
"deploy:project:
|
|
1096
|
-
"deploy:
|
|
1097
|
-
"project:
|
|
1098
|
-
"
|
|
1099
|
-
"
|
|
987
|
+
"project:deploy:preview",
|
|
988
|
+
"deploy:project:preview",
|
|
989
|
+
"deploy:preview:project",
|
|
990
|
+
"project:preview:deploy",
|
|
991
|
+
"preview:project:deploy",
|
|
992
|
+
"preview:deploy:project"
|
|
1100
993
|
]
|
|
1101
994
|
},
|
|
1102
|
-
"project:deploy:
|
|
995
|
+
"project:deploy:quick": {
|
|
1103
996
|
"aliases": [
|
|
1104
|
-
"deploy:metadata"
|
|
997
|
+
"deploy:metadata:quick"
|
|
1105
998
|
],
|
|
1106
999
|
"args": {},
|
|
1107
1000
|
"deprecateAliases": true,
|
|
1108
|
-
"description": "
|
|
1001
|
+
"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.",
|
|
1109
1002
|
"examples": [
|
|
1110
|
-
"
|
|
1111
|
-
"
|
|
1112
|
-
"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",
|
|
1113
|
-
"Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
1114
|
-
"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",
|
|
1115
|
-
"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",
|
|
1116
|
-
"Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
|
|
1117
|
-
"Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
|
|
1118
|
-
"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",
|
|
1119
|
-
"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\"",
|
|
1120
|
-
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1121
|
-
"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",
|
|
1122
|
-
"Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
|
|
1123
|
-
"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"
|
|
1003
|
+
"Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1004
|
+
"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"
|
|
1124
1005
|
],
|
|
1125
1006
|
"flags": {
|
|
1126
1007
|
"json": {
|
|
@@ -1138,17 +1019,8 @@
|
|
|
1138
1019
|
"multiple": false,
|
|
1139
1020
|
"type": "option"
|
|
1140
1021
|
},
|
|
1141
|
-
"api-version": {
|
|
1142
|
-
"char": "a",
|
|
1143
|
-
"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.",
|
|
1144
|
-
"name": "api-version",
|
|
1145
|
-
"summary": "Target API version for the deploy.",
|
|
1146
|
-
"hasDynamicHelp": false,
|
|
1147
|
-
"multiple": false,
|
|
1148
|
-
"type": "option"
|
|
1149
|
-
},
|
|
1150
1022
|
"async": {
|
|
1151
|
-
"description": "The command immediately returns the
|
|
1023
|
+
"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\".",
|
|
1152
1024
|
"exclusive": [
|
|
1153
1025
|
"wait"
|
|
1154
1026
|
],
|
|
@@ -1166,202 +1038,186 @@
|
|
|
1166
1038
|
"allowNo": false,
|
|
1167
1039
|
"type": "boolean"
|
|
1168
1040
|
},
|
|
1169
|
-
"
|
|
1170
|
-
"
|
|
1171
|
-
"
|
|
1172
|
-
"
|
|
1173
|
-
"
|
|
1041
|
+
"job-id": {
|
|
1042
|
+
"char": "i",
|
|
1043
|
+
"description": "The job ID is valid for 10 days from when you started the validation.",
|
|
1044
|
+
"name": "job-id",
|
|
1045
|
+
"summary": "Job ID of the deployment you want to quick deploy.",
|
|
1046
|
+
"hasDynamicHelp": false,
|
|
1047
|
+
"multiple": false,
|
|
1048
|
+
"type": "option"
|
|
1174
1049
|
},
|
|
1175
|
-
"
|
|
1176
|
-
"char": "
|
|
1177
|
-
"
|
|
1178
|
-
"
|
|
1179
|
-
"summary": "
|
|
1180
|
-
"
|
|
1181
|
-
"
|
|
1050
|
+
"target-org": {
|
|
1051
|
+
"char": "o",
|
|
1052
|
+
"name": "target-org",
|
|
1053
|
+
"noCacheDefault": true,
|
|
1054
|
+
"summary": "Username or alias of the target org.",
|
|
1055
|
+
"hasDynamicHelp": true,
|
|
1056
|
+
"multiple": false,
|
|
1057
|
+
"type": "option"
|
|
1182
1058
|
},
|
|
1183
|
-
"
|
|
1059
|
+
"use-most-recent": {
|
|
1184
1060
|
"char": "r",
|
|
1185
|
-
"description": "
|
|
1186
|
-
"name": "
|
|
1187
|
-
"summary": "
|
|
1061
|
+
"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.",
|
|
1062
|
+
"name": "use-most-recent",
|
|
1063
|
+
"summary": "Use the job ID of the most recently validated deployment.",
|
|
1188
1064
|
"allowNo": false,
|
|
1189
1065
|
"type": "boolean"
|
|
1190
1066
|
},
|
|
1191
|
-
"
|
|
1192
|
-
"
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
"
|
|
1067
|
+
"verbose": {
|
|
1068
|
+
"exclusive": [
|
|
1069
|
+
"concise"
|
|
1070
|
+
],
|
|
1071
|
+
"name": "verbose",
|
|
1072
|
+
"summary": "Show verbose output of the deploy result.",
|
|
1196
1073
|
"allowNo": false,
|
|
1197
1074
|
"type": "boolean"
|
|
1198
1075
|
},
|
|
1199
|
-
"
|
|
1200
|
-
"char": "
|
|
1201
|
-
"description": "
|
|
1076
|
+
"wait": {
|
|
1077
|
+
"char": "w",
|
|
1078
|
+
"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\".",
|
|
1202
1079
|
"exclusive": [
|
|
1203
|
-
"
|
|
1204
|
-
"metadata",
|
|
1205
|
-
"metadata-dir"
|
|
1080
|
+
"async"
|
|
1206
1081
|
],
|
|
1207
|
-
"
|
|
1208
|
-
"
|
|
1209
|
-
"
|
|
1210
|
-
"hasDynamicHelp":
|
|
1082
|
+
"name": "wait",
|
|
1083
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1084
|
+
"default": "33 minutes",
|
|
1085
|
+
"hasDynamicHelp": true,
|
|
1086
|
+
"helpValue": "<minutes>",
|
|
1211
1087
|
"multiple": false,
|
|
1212
1088
|
"type": "option"
|
|
1213
1089
|
},
|
|
1214
|
-
"
|
|
1215
|
-
"char": "
|
|
1216
|
-
"
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
"metadata-dir"
|
|
1220
|
-
],
|
|
1221
|
-
"helpGroup": "Source Format",
|
|
1222
|
-
"name": "metadata",
|
|
1223
|
-
"summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
|
|
1224
|
-
"hasDynamicHelp": false,
|
|
1225
|
-
"multiple": true,
|
|
1226
|
-
"type": "option"
|
|
1227
|
-
},
|
|
1228
|
-
"metadata-dir": {
|
|
1229
|
-
"exclusive": [
|
|
1230
|
-
"manifest",
|
|
1231
|
-
"source-dir",
|
|
1232
|
-
"metadata"
|
|
1233
|
-
],
|
|
1234
|
-
"helpGroup": "Metadata API Format",
|
|
1235
|
-
"name": "metadata-dir",
|
|
1236
|
-
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1090
|
+
"api-version": {
|
|
1091
|
+
"char": "a",
|
|
1092
|
+
"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.",
|
|
1093
|
+
"name": "api-version",
|
|
1094
|
+
"summary": "Target API version for the deploy.",
|
|
1237
1095
|
"hasDynamicHelp": false,
|
|
1238
1096
|
"multiple": false,
|
|
1239
1097
|
"type": "option"
|
|
1240
|
-
}
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1098
|
+
}
|
|
1099
|
+
},
|
|
1100
|
+
"hasDynamicHelp": true,
|
|
1101
|
+
"hiddenAliases": [],
|
|
1102
|
+
"id": "project:deploy:quick",
|
|
1103
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1104
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1105
|
+
"pluginType": "core",
|
|
1106
|
+
"strict": true,
|
|
1107
|
+
"summary": "Quickly deploy a validated deployment to an org.",
|
|
1108
|
+
"enableJsonFlag": true,
|
|
1109
|
+
"errorCodes": {
|
|
1110
|
+
"header": "ERROR CODES",
|
|
1111
|
+
"body": [
|
|
1112
|
+
{
|
|
1113
|
+
"name": "Succeeded (0)",
|
|
1114
|
+
"description": "The deploy succeeded."
|
|
1115
|
+
},
|
|
1116
|
+
{
|
|
1117
|
+
"name": "Canceled (1)",
|
|
1118
|
+
"description": "The deploy was canceled."
|
|
1119
|
+
},
|
|
1120
|
+
{
|
|
1121
|
+
"name": "Failed (1)",
|
|
1122
|
+
"description": "The deploy failed."
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
"name": "SucceededPartial (68)",
|
|
1126
|
+
"description": "The deploy partially succeeded."
|
|
1127
|
+
},
|
|
1128
|
+
{
|
|
1129
|
+
"name": "InProgress (69)",
|
|
1130
|
+
"description": "The deploy is in progress."
|
|
1131
|
+
},
|
|
1132
|
+
{
|
|
1133
|
+
"name": "Pending (69)",
|
|
1134
|
+
"description": "The deploy is pending."
|
|
1135
|
+
},
|
|
1136
|
+
{
|
|
1137
|
+
"name": "Canceling (69)",
|
|
1138
|
+
"description": "The deploy is being canceled."
|
|
1139
|
+
}
|
|
1140
|
+
]
|
|
1141
|
+
},
|
|
1142
|
+
"isESM": true,
|
|
1143
|
+
"relativePath": [
|
|
1144
|
+
"lib",
|
|
1145
|
+
"commands",
|
|
1146
|
+
"project",
|
|
1147
|
+
"deploy",
|
|
1148
|
+
"quick.js"
|
|
1149
|
+
],
|
|
1150
|
+
"aliasPermutations": [
|
|
1151
|
+
"deploy:metadata:quick",
|
|
1152
|
+
"metadata:deploy:quick",
|
|
1153
|
+
"metadata:quick:deploy",
|
|
1154
|
+
"deploy:quick:metadata",
|
|
1155
|
+
"quick:deploy:metadata",
|
|
1156
|
+
"quick:metadata:deploy"
|
|
1157
|
+
],
|
|
1158
|
+
"permutations": [
|
|
1159
|
+
"project:deploy:quick",
|
|
1160
|
+
"deploy:project:quick",
|
|
1161
|
+
"deploy:quick:project",
|
|
1162
|
+
"project:quick:deploy",
|
|
1163
|
+
"quick:project:deploy",
|
|
1164
|
+
"quick:deploy:project"
|
|
1165
|
+
]
|
|
1166
|
+
},
|
|
1167
|
+
"project:deploy:report": {
|
|
1168
|
+
"aliases": [
|
|
1169
|
+
"deploy:metadata:report"
|
|
1170
|
+
],
|
|
1171
|
+
"args": {},
|
|
1172
|
+
"deprecateAliases": true,
|
|
1173
|
+
"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.",
|
|
1174
|
+
"examples": [
|
|
1175
|
+
"Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1176
|
+
"Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
|
|
1177
|
+
"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"
|
|
1178
|
+
],
|
|
1179
|
+
"flags": {
|
|
1180
|
+
"json": {
|
|
1181
|
+
"description": "Format output as json.",
|
|
1182
|
+
"helpGroup": "GLOBAL",
|
|
1183
|
+
"name": "json",
|
|
1248
1184
|
"allowNo": false,
|
|
1249
1185
|
"type": "boolean"
|
|
1250
1186
|
},
|
|
1251
|
-
"
|
|
1252
|
-
"
|
|
1253
|
-
"
|
|
1254
|
-
"
|
|
1255
|
-
"manifest",
|
|
1256
|
-
"metadata",
|
|
1257
|
-
"metadata-dir"
|
|
1258
|
-
],
|
|
1259
|
-
"helpGroup": "Source Format",
|
|
1260
|
-
"name": "source-dir",
|
|
1261
|
-
"summary": "Path to the local source files to deploy.",
|
|
1187
|
+
"flags-dir": {
|
|
1188
|
+
"helpGroup": "GLOBAL",
|
|
1189
|
+
"name": "flags-dir",
|
|
1190
|
+
"summary": "Import flag values from a directory.",
|
|
1262
1191
|
"hasDynamicHelp": false,
|
|
1263
|
-
"multiple":
|
|
1192
|
+
"multiple": false,
|
|
1264
1193
|
"type": "option"
|
|
1265
1194
|
},
|
|
1266
1195
|
"target-org": {
|
|
1267
1196
|
"char": "o",
|
|
1268
1197
|
"name": "target-org",
|
|
1269
1198
|
"noCacheDefault": true,
|
|
1270
|
-
"
|
|
1271
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1199
|
+
"summary": "Username or alias of the target org.",
|
|
1272
1200
|
"hasDynamicHelp": true,
|
|
1273
1201
|
"multiple": false,
|
|
1274
1202
|
"type": "option"
|
|
1275
1203
|
},
|
|
1276
|
-
"
|
|
1277
|
-
"char": "
|
|
1278
|
-
"description": "
|
|
1279
|
-
"
|
|
1280
|
-
"
|
|
1281
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1282
|
-
"hasDynamicHelp": false,
|
|
1283
|
-
"multiple": true,
|
|
1284
|
-
"type": "option"
|
|
1285
|
-
},
|
|
1286
|
-
"test-level": {
|
|
1287
|
-
"char": "l",
|
|
1288
|
-
"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- RunRelevantTests (Beta) — Runs only tests that are relevant to the files being deployed. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies. For fine-grained control, you can also annotate test classes so that they always run in certain conditions. See \"@IsTest Annotation\" in the \"Apex Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_annotation_isTest.htm). Each class and trigger in the deployment package must be covered by the executed tests for a minimum of 75% code coverage. This coverage is computed for each class and triggers individually and is different than the overall coverage percentage.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see \"Running Tests in a Deployment\" (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
|
|
1289
|
-
"helpGroup": "Test",
|
|
1290
|
-
"name": "test-level",
|
|
1291
|
-
"summary": "Deployment Apex testing level.",
|
|
1204
|
+
"job-id": {
|
|
1205
|
+
"char": "i",
|
|
1206
|
+
"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.",
|
|
1207
|
+
"name": "job-id",
|
|
1208
|
+
"summary": "Job ID of the deploy operation you want to check the status of.",
|
|
1292
1209
|
"hasDynamicHelp": false,
|
|
1293
1210
|
"multiple": false,
|
|
1294
|
-
"options": [
|
|
1295
|
-
"NoTestRun",
|
|
1296
|
-
"RunSpecifiedTests",
|
|
1297
|
-
"RunLocalTests",
|
|
1298
|
-
"RunAllTestsInOrg",
|
|
1299
|
-
"RunRelevantTests"
|
|
1300
|
-
],
|
|
1301
|
-
"type": "option"
|
|
1302
|
-
},
|
|
1303
|
-
"verbose": {
|
|
1304
|
-
"exclusive": [
|
|
1305
|
-
"concise"
|
|
1306
|
-
],
|
|
1307
|
-
"name": "verbose",
|
|
1308
|
-
"summary": "Show verbose output of the deploy result.",
|
|
1309
|
-
"allowNo": false,
|
|
1310
|
-
"type": "boolean"
|
|
1311
|
-
},
|
|
1312
|
-
"wait": {
|
|
1313
|
-
"char": "w",
|
|
1314
|
-
"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\".",
|
|
1315
|
-
"exclusive": [
|
|
1316
|
-
"async"
|
|
1317
|
-
],
|
|
1318
|
-
"name": "wait",
|
|
1319
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1320
|
-
"hasDynamicHelp": true,
|
|
1321
|
-
"helpValue": "<minutes>",
|
|
1322
|
-
"multiple": false,
|
|
1323
1211
|
"type": "option"
|
|
1324
1212
|
},
|
|
1325
|
-
"
|
|
1326
|
-
"
|
|
1327
|
-
"
|
|
1328
|
-
"
|
|
1329
|
-
|
|
1330
|
-
"type": "some",
|
|
1331
|
-
"flags": [
|
|
1332
|
-
"pre-destructive-changes",
|
|
1333
|
-
"manifest",
|
|
1334
|
-
"metadata-dir",
|
|
1335
|
-
"post-destructive-changes"
|
|
1336
|
-
]
|
|
1337
|
-
}
|
|
1338
|
-
],
|
|
1339
|
-
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1213
|
+
"use-most-recent": {
|
|
1214
|
+
"char": "r",
|
|
1215
|
+
"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.",
|
|
1216
|
+
"name": "use-most-recent",
|
|
1217
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1340
1218
|
"allowNo": false,
|
|
1341
1219
|
"type": "boolean"
|
|
1342
1220
|
},
|
|
1343
|
-
"pre-destructive-changes": {
|
|
1344
|
-
"dependsOn": [
|
|
1345
|
-
"manifest"
|
|
1346
|
-
],
|
|
1347
|
-
"helpGroup": "Delete",
|
|
1348
|
-
"name": "pre-destructive-changes",
|
|
1349
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
|
|
1350
|
-
"hasDynamicHelp": false,
|
|
1351
|
-
"multiple": false,
|
|
1352
|
-
"type": "option"
|
|
1353
|
-
},
|
|
1354
|
-
"post-destructive-changes": {
|
|
1355
|
-
"dependsOn": [
|
|
1356
|
-
"manifest"
|
|
1357
|
-
],
|
|
1358
|
-
"helpGroup": "Delete",
|
|
1359
|
-
"name": "post-destructive-changes",
|
|
1360
|
-
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1361
|
-
"hasDynamicHelp": false,
|
|
1362
|
-
"multiple": false,
|
|
1363
|
-
"type": "option"
|
|
1364
|
-
},
|
|
1365
1221
|
"coverage-formatters": {
|
|
1366
1222
|
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1367
1223
|
"helpGroup": "Test",
|
|
@@ -1407,110 +1263,62 @@
|
|
|
1407
1263
|
"hasDynamicHelp": false,
|
|
1408
1264
|
"multiple": false,
|
|
1409
1265
|
"type": "option"
|
|
1266
|
+
},
|
|
1267
|
+
"wait": {
|
|
1268
|
+
"char": "w",
|
|
1269
|
+
"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\".",
|
|
1270
|
+
"name": "wait",
|
|
1271
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1272
|
+
"hasDynamicHelp": true,
|
|
1273
|
+
"helpValue": "<minutes>",
|
|
1274
|
+
"multiple": false,
|
|
1275
|
+
"type": "option"
|
|
1410
1276
|
}
|
|
1411
1277
|
},
|
|
1412
1278
|
"hasDynamicHelp": true,
|
|
1413
1279
|
"hiddenAliases": [],
|
|
1414
|
-
"id": "project:deploy:
|
|
1280
|
+
"id": "project:deploy:report",
|
|
1415
1281
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1416
1282
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1417
1283
|
"pluginType": "core",
|
|
1418
1284
|
"strict": true,
|
|
1419
|
-
"summary": "
|
|
1285
|
+
"summary": "Check or poll for the status of a deploy operation.",
|
|
1420
1286
|
"enableJsonFlag": true,
|
|
1421
|
-
"configurationVariablesSection": {
|
|
1422
|
-
"header": "CONFIGURATION VARIABLES",
|
|
1423
|
-
"body": [
|
|
1424
|
-
{
|
|
1425
|
-
"name": "target-org",
|
|
1426
|
-
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1427
|
-
},
|
|
1428
|
-
{
|
|
1429
|
-
"name": "org-api-version",
|
|
1430
|
-
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1431
|
-
}
|
|
1432
|
-
]
|
|
1433
|
-
},
|
|
1434
|
-
"envVariablesSection": {
|
|
1435
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1436
|
-
"body": [
|
|
1437
|
-
{
|
|
1438
|
-
"name": "SF_TARGET_ORG",
|
|
1439
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1440
|
-
},
|
|
1441
|
-
{
|
|
1442
|
-
"name": "SF_USE_PROGRESS_BAR",
|
|
1443
|
-
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1444
|
-
}
|
|
1445
|
-
]
|
|
1446
|
-
},
|
|
1447
|
-
"errorCodes": {
|
|
1448
|
-
"header": "ERROR CODES",
|
|
1449
|
-
"body": [
|
|
1450
|
-
{
|
|
1451
|
-
"name": "Succeeded (0)",
|
|
1452
|
-
"description": "The deploy succeeded."
|
|
1453
|
-
},
|
|
1454
|
-
{
|
|
1455
|
-
"name": "Canceled (1)",
|
|
1456
|
-
"description": "The deploy was canceled."
|
|
1457
|
-
},
|
|
1458
|
-
{
|
|
1459
|
-
"name": "Failed (1)",
|
|
1460
|
-
"description": "The deploy failed."
|
|
1461
|
-
},
|
|
1462
|
-
{
|
|
1463
|
-
"name": "SucceededPartial (68)",
|
|
1464
|
-
"description": "The deploy partially succeeded."
|
|
1465
|
-
},
|
|
1466
|
-
{
|
|
1467
|
-
"name": "InProgress (69)",
|
|
1468
|
-
"description": "The deploy is in progress."
|
|
1469
|
-
},
|
|
1470
|
-
{
|
|
1471
|
-
"name": "Pending (69)",
|
|
1472
|
-
"description": "The deploy is pending."
|
|
1473
|
-
},
|
|
1474
|
-
{
|
|
1475
|
-
"name": "Canceling (69)",
|
|
1476
|
-
"description": "The deploy is being canceled."
|
|
1477
|
-
}
|
|
1478
|
-
]
|
|
1479
|
-
},
|
|
1480
1287
|
"isESM": true,
|
|
1481
1288
|
"relativePath": [
|
|
1482
1289
|
"lib",
|
|
1483
1290
|
"commands",
|
|
1484
1291
|
"project",
|
|
1485
1292
|
"deploy",
|
|
1486
|
-
"
|
|
1293
|
+
"report.js"
|
|
1487
1294
|
],
|
|
1488
1295
|
"aliasPermutations": [
|
|
1489
|
-
"deploy:metadata",
|
|
1490
|
-
"metadata:deploy"
|
|
1296
|
+
"deploy:metadata:report",
|
|
1297
|
+
"metadata:deploy:report",
|
|
1298
|
+
"metadata:report:deploy",
|
|
1299
|
+
"deploy:report:metadata",
|
|
1300
|
+
"report:deploy:metadata",
|
|
1301
|
+
"report:metadata:deploy"
|
|
1491
1302
|
],
|
|
1492
1303
|
"permutations": [
|
|
1493
|
-
"project:deploy:
|
|
1494
|
-
"deploy:project:
|
|
1495
|
-
"deploy:
|
|
1496
|
-
"project:
|
|
1497
|
-
"
|
|
1498
|
-
"
|
|
1304
|
+
"project:deploy:report",
|
|
1305
|
+
"deploy:project:report",
|
|
1306
|
+
"deploy:report:project",
|
|
1307
|
+
"project:report:deploy",
|
|
1308
|
+
"report:project:deploy",
|
|
1309
|
+
"report:deploy:project"
|
|
1499
1310
|
]
|
|
1500
1311
|
},
|
|
1501
|
-
"project:deploy:
|
|
1312
|
+
"project:deploy:resume": {
|
|
1502
1313
|
"aliases": [
|
|
1503
|
-
"deploy:metadata:
|
|
1314
|
+
"deploy:metadata:resume"
|
|
1504
1315
|
],
|
|
1505
1316
|
"args": {},
|
|
1506
1317
|
"deprecateAliases": true,
|
|
1507
|
-
"description": "Use this command to
|
|
1318
|
+
"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.",
|
|
1508
1319
|
"examples": [
|
|
1509
|
-
"
|
|
1510
|
-
"
|
|
1511
|
-
"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",
|
|
1512
|
-
"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",
|
|
1513
|
-
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
1320
|
+
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1321
|
+
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1514
1322
|
],
|
|
1515
1323
|
"flags": {
|
|
1516
1324
|
"json": {
|
|
@@ -1528,127 +1336,44 @@
|
|
|
1528
1336
|
"multiple": false,
|
|
1529
1337
|
"type": "option"
|
|
1530
1338
|
},
|
|
1531
|
-
"api-version": {
|
|
1532
|
-
"char": "a",
|
|
1533
|
-
"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.",
|
|
1534
|
-
"name": "api-version",
|
|
1535
|
-
"summary": "Target API version for the validation.",
|
|
1536
|
-
"hasDynamicHelp": false,
|
|
1537
|
-
"multiple": false,
|
|
1538
|
-
"type": "option"
|
|
1539
|
-
},
|
|
1540
|
-
"async": {
|
|
1541
|
-
"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\".",
|
|
1542
|
-
"name": "async",
|
|
1543
|
-
"summary": "Run the command asynchronously.",
|
|
1544
|
-
"allowNo": false,
|
|
1545
|
-
"type": "boolean"
|
|
1546
|
-
},
|
|
1547
1339
|
"concise": {
|
|
1548
1340
|
"exclusive": [
|
|
1549
1341
|
"verbose"
|
|
1550
1342
|
],
|
|
1551
1343
|
"name": "concise",
|
|
1552
|
-
"summary": "Show concise output of the
|
|
1344
|
+
"summary": "Show concise output of the deploy operation result.",
|
|
1553
1345
|
"allowNo": false,
|
|
1554
1346
|
"type": "boolean"
|
|
1555
1347
|
},
|
|
1556
|
-
"
|
|
1557
|
-
"char": "
|
|
1558
|
-
"description": "
|
|
1559
|
-
"
|
|
1560
|
-
"
|
|
1561
|
-
"summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
|
|
1562
|
-
"hasDynamicHelp": false,
|
|
1563
|
-
"multiple": false,
|
|
1564
|
-
"type": "option"
|
|
1565
|
-
},
|
|
1566
|
-
"metadata": {
|
|
1567
|
-
"char": "m",
|
|
1568
|
-
"helpGroup": "Source Format",
|
|
1569
|
-
"name": "metadata",
|
|
1570
|
-
"summary": "Metadata component names to validate for deployment.",
|
|
1571
|
-
"hasDynamicHelp": false,
|
|
1572
|
-
"multiple": true,
|
|
1573
|
-
"type": "option"
|
|
1574
|
-
},
|
|
1575
|
-
"source-dir": {
|
|
1576
|
-
"char": "d",
|
|
1577
|
-
"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.",
|
|
1578
|
-
"helpGroup": "Source Format",
|
|
1579
|
-
"name": "source-dir",
|
|
1580
|
-
"summary": "Path to the local source files to validate for deployment.",
|
|
1581
|
-
"hasDynamicHelp": false,
|
|
1582
|
-
"multiple": true,
|
|
1583
|
-
"type": "option"
|
|
1584
|
-
},
|
|
1585
|
-
"metadata-dir": {
|
|
1586
|
-
"helpGroup": "Metadata API Format",
|
|
1587
|
-
"name": "metadata-dir",
|
|
1588
|
-
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1348
|
+
"job-id": {
|
|
1349
|
+
"char": "i",
|
|
1350
|
+
"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.",
|
|
1351
|
+
"name": "job-id",
|
|
1352
|
+
"summary": "Job ID of the deploy operation you want to resume.",
|
|
1589
1353
|
"hasDynamicHelp": false,
|
|
1590
1354
|
"multiple": false,
|
|
1591
1355
|
"type": "option"
|
|
1592
1356
|
},
|
|
1593
|
-
"
|
|
1594
|
-
"
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
"
|
|
1598
|
-
"name": "single-package",
|
|
1599
|
-
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1357
|
+
"use-most-recent": {
|
|
1358
|
+
"char": "r",
|
|
1359
|
+
"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.",
|
|
1360
|
+
"name": "use-most-recent",
|
|
1361
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1600
1362
|
"allowNo": false,
|
|
1601
1363
|
"type": "boolean"
|
|
1602
1364
|
},
|
|
1603
|
-
"target-org": {
|
|
1604
|
-
"char": "o",
|
|
1605
|
-
"name": "target-org",
|
|
1606
|
-
"noCacheDefault": true,
|
|
1607
|
-
"required": true,
|
|
1608
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1609
|
-
"hasDynamicHelp": true,
|
|
1610
|
-
"multiple": false,
|
|
1611
|
-
"type": "option"
|
|
1612
|
-
},
|
|
1613
|
-
"tests": {
|
|
1614
|
-
"char": "t",
|
|
1615
|
-
"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\"",
|
|
1616
|
-
"helpGroup": "Test",
|
|
1617
|
-
"name": "tests",
|
|
1618
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1619
|
-
"hasDynamicHelp": false,
|
|
1620
|
-
"multiple": true,
|
|
1621
|
-
"type": "option"
|
|
1622
|
-
},
|
|
1623
|
-
"test-level": {
|
|
1624
|
-
"char": "l",
|
|
1625
|
-
"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.\n\n- RunRelevantTests (Beta) — Runs only tests that are relevant to the files being deployed. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies. For fine-grained control, you can also annotate test classes so that they always run in certain conditions. See \"@IsTest Annotation\" in the \"Apex Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_annotation_isTest.htm). Each class and trigger in the deployment package must be covered by the executed tests for a minimum of 75% code coverage. This coverage is computed for each class and triggers individually and is different than the overall coverage percentage.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see \"Running Tests in a Deployment\" (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
|
|
1626
|
-
"helpGroup": "Test",
|
|
1627
|
-
"name": "test-level",
|
|
1628
|
-
"summary": "Deployment Apex testing level.",
|
|
1629
|
-
"default": "RunLocalTests",
|
|
1630
|
-
"hasDynamicHelp": false,
|
|
1631
|
-
"multiple": false,
|
|
1632
|
-
"options": [
|
|
1633
|
-
"RunAllTestsInOrg",
|
|
1634
|
-
"RunLocalTests",
|
|
1635
|
-
"RunSpecifiedTests",
|
|
1636
|
-
"RunRelevantTests"
|
|
1637
|
-
],
|
|
1638
|
-
"type": "option"
|
|
1639
|
-
},
|
|
1640
1365
|
"verbose": {
|
|
1641
1366
|
"exclusive": [
|
|
1642
1367
|
"concise"
|
|
1643
1368
|
],
|
|
1644
1369
|
"name": "verbose",
|
|
1645
|
-
"summary": "Show verbose output of the
|
|
1370
|
+
"summary": "Show verbose output of the deploy operation result.",
|
|
1646
1371
|
"allowNo": false,
|
|
1647
1372
|
"type": "boolean"
|
|
1648
1373
|
},
|
|
1649
1374
|
"wait": {
|
|
1650
1375
|
"char": "w",
|
|
1651
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you
|
|
1376
|
+
"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\".",
|
|
1652
1377
|
"name": "wait",
|
|
1653
1378
|
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1654
1379
|
"hasDynamicHelp": true,
|
|
@@ -1656,14 +1381,6 @@
|
|
|
1656
1381
|
"multiple": false,
|
|
1657
1382
|
"type": "option"
|
|
1658
1383
|
},
|
|
1659
|
-
"ignore-warnings": {
|
|
1660
|
-
"char": "g",
|
|
1661
|
-
"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.",
|
|
1662
|
-
"name": "ignore-warnings",
|
|
1663
|
-
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1664
|
-
"allowNo": false,
|
|
1665
|
-
"type": "boolean"
|
|
1666
|
-
},
|
|
1667
1384
|
"coverage-formatters": {
|
|
1668
1385
|
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1669
1386
|
"helpGroup": "Test",
|
|
@@ -1709,78 +1426,20 @@
|
|
|
1709
1426
|
"hasDynamicHelp": false,
|
|
1710
1427
|
"multiple": false,
|
|
1711
1428
|
"type": "option"
|
|
1712
|
-
},
|
|
1713
|
-
"purge-on-delete": {
|
|
1714
|
-
"dependsOn": [
|
|
1715
|
-
"manifest"
|
|
1716
|
-
],
|
|
1717
|
-
"helpGroup": "Delete",
|
|
1718
|
-
"name": "purge-on-delete",
|
|
1719
|
-
"relationships": [
|
|
1720
|
-
{
|
|
1721
|
-
"type": "some",
|
|
1722
|
-
"flags": [
|
|
1723
|
-
"pre-destructive-changes",
|
|
1724
|
-
"post-destructive-changes"
|
|
1725
|
-
]
|
|
1726
|
-
}
|
|
1727
|
-
],
|
|
1728
|
-
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1729
|
-
"allowNo": false,
|
|
1730
|
-
"type": "boolean"
|
|
1731
|
-
},
|
|
1732
|
-
"pre-destructive-changes": {
|
|
1733
|
-
"dependsOn": [
|
|
1734
|
-
"manifest"
|
|
1735
|
-
],
|
|
1736
|
-
"helpGroup": "Delete",
|
|
1737
|
-
"name": "pre-destructive-changes",
|
|
1738
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
1739
|
-
"hasDynamicHelp": false,
|
|
1740
|
-
"multiple": false,
|
|
1741
|
-
"type": "option"
|
|
1742
|
-
},
|
|
1743
|
-
"post-destructive-changes": {
|
|
1744
|
-
"dependsOn": [
|
|
1745
|
-
"manifest"
|
|
1746
|
-
],
|
|
1747
|
-
"helpGroup": "Delete",
|
|
1748
|
-
"name": "post-destructive-changes",
|
|
1749
|
-
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1750
|
-
"hasDynamicHelp": false,
|
|
1751
|
-
"multiple": false,
|
|
1752
|
-
"type": "option"
|
|
1753
1429
|
}
|
|
1754
1430
|
},
|
|
1755
1431
|
"hasDynamicHelp": true,
|
|
1756
1432
|
"hiddenAliases": [],
|
|
1757
|
-
"id": "project:deploy:
|
|
1433
|
+
"id": "project:deploy:resume",
|
|
1758
1434
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1759
1435
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1760
1436
|
"pluginType": "core",
|
|
1761
1437
|
"strict": true,
|
|
1762
|
-
"summary": "
|
|
1438
|
+
"summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
|
|
1763
1439
|
"enableJsonFlag": true,
|
|
1764
|
-
"
|
|
1765
|
-
"header": "
|
|
1440
|
+
"envVariablesSection": {
|
|
1441
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1766
1442
|
"body": [
|
|
1767
|
-
{
|
|
1768
|
-
"name": "target-org",
|
|
1769
|
-
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1770
|
-
},
|
|
1771
|
-
{
|
|
1772
|
-
"name": "org-api-version",
|
|
1773
|
-
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1774
|
-
}
|
|
1775
|
-
]
|
|
1776
|
-
},
|
|
1777
|
-
"envVariablesSection": {
|
|
1778
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1779
|
-
"body": [
|
|
1780
|
-
{
|
|
1781
|
-
"name": "SF_TARGET_ORG",
|
|
1782
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1783
|
-
},
|
|
1784
1443
|
{
|
|
1785
1444
|
"name": "SF_USE_PROGRESS_BAR",
|
|
1786
1445
|
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
@@ -1826,35 +1485,47 @@
|
|
|
1826
1485
|
"commands",
|
|
1827
1486
|
"project",
|
|
1828
1487
|
"deploy",
|
|
1829
|
-
"
|
|
1488
|
+
"resume.js"
|
|
1830
1489
|
],
|
|
1831
1490
|
"aliasPermutations": [
|
|
1832
|
-
"deploy:metadata:
|
|
1833
|
-
"metadata:deploy:
|
|
1834
|
-
"metadata:
|
|
1835
|
-
"deploy:
|
|
1836
|
-
"
|
|
1837
|
-
"
|
|
1491
|
+
"deploy:metadata:resume",
|
|
1492
|
+
"metadata:deploy:resume",
|
|
1493
|
+
"metadata:resume:deploy",
|
|
1494
|
+
"deploy:resume:metadata",
|
|
1495
|
+
"resume:deploy:metadata",
|
|
1496
|
+
"resume:metadata:deploy"
|
|
1838
1497
|
],
|
|
1839
1498
|
"permutations": [
|
|
1840
|
-
"project:deploy:
|
|
1841
|
-
"deploy:project:
|
|
1842
|
-
"deploy:
|
|
1843
|
-
"project:
|
|
1844
|
-
"
|
|
1845
|
-
"
|
|
1499
|
+
"project:deploy:resume",
|
|
1500
|
+
"deploy:project:resume",
|
|
1501
|
+
"deploy:resume:project",
|
|
1502
|
+
"project:resume:deploy",
|
|
1503
|
+
"resume:project:deploy",
|
|
1504
|
+
"resume:deploy:project"
|
|
1846
1505
|
]
|
|
1847
1506
|
},
|
|
1848
|
-
"project:
|
|
1507
|
+
"project:deploy:start": {
|
|
1849
1508
|
"aliases": [
|
|
1850
|
-
"
|
|
1509
|
+
"deploy:metadata"
|
|
1851
1510
|
],
|
|
1852
1511
|
"args": {},
|
|
1853
1512
|
"deprecateAliases": true,
|
|
1854
|
-
"description": "
|
|
1513
|
+
"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.",
|
|
1855
1514
|
"examples": [
|
|
1856
|
-
"
|
|
1857
|
-
"
|
|
1515
|
+
"Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1516
|
+
"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",
|
|
1517
|
+
"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",
|
|
1518
|
+
"Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
1519
|
+
"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",
|
|
1520
|
+
"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",
|
|
1521
|
+
"Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
|
|
1522
|
+
"Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
|
|
1523
|
+
"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",
|
|
1524
|
+
"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\"",
|
|
1525
|
+
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1526
|
+
"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",
|
|
1527
|
+
"Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
|
|
1528
|
+
"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"
|
|
1858
1529
|
],
|
|
1859
1530
|
"flags": {
|
|
1860
1531
|
"json": {
|
|
@@ -1873,394 +1544,378 @@
|
|
|
1873
1544
|
"type": "option"
|
|
1874
1545
|
},
|
|
1875
1546
|
"api-version": {
|
|
1876
|
-
"
|
|
1877
|
-
|
|
1878
|
-
],
|
|
1879
|
-
"deprecateAliases": true,
|
|
1880
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1547
|
+
"char": "a",
|
|
1548
|
+
"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.",
|
|
1881
1549
|
"name": "api-version",
|
|
1550
|
+
"summary": "Target API version for the deploy.",
|
|
1882
1551
|
"hasDynamicHelp": false,
|
|
1883
1552
|
"multiple": false,
|
|
1884
1553
|
"type": "option"
|
|
1885
1554
|
},
|
|
1886
|
-
"
|
|
1887
|
-
"
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
"name": "
|
|
1892
|
-
"
|
|
1893
|
-
"
|
|
1894
|
-
"type": "
|
|
1555
|
+
"async": {
|
|
1556
|
+
"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\".",
|
|
1557
|
+
"exclusive": [
|
|
1558
|
+
"wait"
|
|
1559
|
+
],
|
|
1560
|
+
"name": "async",
|
|
1561
|
+
"summary": "Run the command asynchronously.",
|
|
1562
|
+
"allowNo": false,
|
|
1563
|
+
"type": "boolean"
|
|
1895
1564
|
},
|
|
1896
|
-
"
|
|
1897
|
-
"
|
|
1898
|
-
"
|
|
1565
|
+
"concise": {
|
|
1566
|
+
"exclusive": [
|
|
1567
|
+
"verbose"
|
|
1899
1568
|
],
|
|
1569
|
+
"name": "concise",
|
|
1570
|
+
"summary": "Show concise output of the deploy result.",
|
|
1571
|
+
"allowNo": false,
|
|
1572
|
+
"type": "boolean"
|
|
1573
|
+
},
|
|
1574
|
+
"dry-run": {
|
|
1575
|
+
"name": "dry-run",
|
|
1576
|
+
"summary": "Validate deploy and run Apex tests but don’t save to the org.",
|
|
1577
|
+
"allowNo": false,
|
|
1578
|
+
"type": "boolean"
|
|
1579
|
+
},
|
|
1580
|
+
"ignore-conflicts": {
|
|
1581
|
+
"char": "c",
|
|
1582
|
+
"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.",
|
|
1583
|
+
"name": "ignore-conflicts",
|
|
1584
|
+
"summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
|
|
1585
|
+
"allowNo": false,
|
|
1586
|
+
"type": "boolean"
|
|
1587
|
+
},
|
|
1588
|
+
"ignore-errors": {
|
|
1900
1589
|
"char": "r",
|
|
1901
|
-
"
|
|
1902
|
-
"name": "
|
|
1903
|
-
"
|
|
1904
|
-
"
|
|
1905
|
-
"
|
|
1906
|
-
"multiple": false,
|
|
1907
|
-
"type": "option"
|
|
1590
|
+
"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.",
|
|
1591
|
+
"name": "ignore-errors",
|
|
1592
|
+
"summary": "Ignore any errors and don’t roll back deployment.",
|
|
1593
|
+
"allowNo": false,
|
|
1594
|
+
"type": "boolean"
|
|
1908
1595
|
},
|
|
1909
|
-
"
|
|
1910
|
-
"
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
"
|
|
1914
|
-
"
|
|
1915
|
-
"
|
|
1916
|
-
"summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
|
|
1917
|
-
"hasDynamicHelp": false,
|
|
1918
|
-
"multiple": false,
|
|
1919
|
-
"type": "option"
|
|
1596
|
+
"ignore-warnings": {
|
|
1597
|
+
"char": "g",
|
|
1598
|
+
"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.",
|
|
1599
|
+
"name": "ignore-warnings",
|
|
1600
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1601
|
+
"allowNo": false,
|
|
1602
|
+
"type": "boolean"
|
|
1920
1603
|
},
|
|
1921
1604
|
"manifest": {
|
|
1922
1605
|
"char": "x",
|
|
1923
|
-
"description": "If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1606
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1607
|
+
"exclusive": [
|
|
1608
|
+
"source-dir",
|
|
1609
|
+
"metadata",
|
|
1610
|
+
"metadata-dir"
|
|
1611
|
+
],
|
|
1612
|
+
"helpGroup": "Source Format",
|
|
1924
1613
|
"name": "manifest",
|
|
1925
|
-
"summary": "
|
|
1614
|
+
"summary": "Full file path for manifest (package.xml) of components to deploy.",
|
|
1926
1615
|
"hasDynamicHelp": false,
|
|
1927
1616
|
"multiple": false,
|
|
1928
1617
|
"type": "option"
|
|
1929
1618
|
},
|
|
1930
|
-
"metadata
|
|
1931
|
-
"
|
|
1932
|
-
"metadatapath"
|
|
1933
|
-
],
|
|
1934
|
-
"char": "p",
|
|
1935
|
-
"deprecateAliases": true,
|
|
1936
|
-
"description": "The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this flag, don’t specify --manifest or --metadata. If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes.",
|
|
1619
|
+
"metadata": {
|
|
1620
|
+
"char": "m",
|
|
1937
1621
|
"exclusive": [
|
|
1938
1622
|
"manifest",
|
|
1939
|
-
"
|
|
1623
|
+
"source-dir",
|
|
1624
|
+
"metadata-dir"
|
|
1940
1625
|
],
|
|
1941
|
-
"
|
|
1942
|
-
"
|
|
1943
|
-
"
|
|
1626
|
+
"helpGroup": "Source Format",
|
|
1627
|
+
"name": "metadata",
|
|
1628
|
+
"summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
|
|
1944
1629
|
"hasDynamicHelp": false,
|
|
1945
1630
|
"multiple": true,
|
|
1946
1631
|
"type": "option"
|
|
1947
1632
|
},
|
|
1948
|
-
"metadata": {
|
|
1949
|
-
"char": "m",
|
|
1633
|
+
"metadata-dir": {
|
|
1950
1634
|
"exclusive": [
|
|
1951
1635
|
"manifest",
|
|
1952
|
-
"
|
|
1636
|
+
"source-dir",
|
|
1637
|
+
"metadata"
|
|
1953
1638
|
],
|
|
1954
|
-
"
|
|
1955
|
-
"
|
|
1956
|
-
"
|
|
1639
|
+
"helpGroup": "Metadata API Format",
|
|
1640
|
+
"name": "metadata-dir",
|
|
1641
|
+
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1957
1642
|
"hasDynamicHelp": false,
|
|
1958
|
-
"multiple":
|
|
1643
|
+
"multiple": false,
|
|
1959
1644
|
"type": "option"
|
|
1960
|
-
}
|
|
1961
|
-
|
|
1962
|
-
|
|
1963
|
-
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
|
|
1967
|
-
|
|
1968
|
-
"strict": true,
|
|
1969
|
-
"summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
|
|
1970
|
-
"enableJsonFlag": true,
|
|
1971
|
-
"requiresProject": true,
|
|
1972
|
-
"isESM": true,
|
|
1973
|
-
"relativePath": [
|
|
1974
|
-
"lib",
|
|
1975
|
-
"commands",
|
|
1976
|
-
"project",
|
|
1977
|
-
"convert",
|
|
1978
|
-
"mdapi.js"
|
|
1979
|
-
],
|
|
1980
|
-
"aliasPermutations": [
|
|
1981
|
-
"force:mdapi:convert",
|
|
1982
|
-
"mdapi:force:convert",
|
|
1983
|
-
"mdapi:convert:force",
|
|
1984
|
-
"force:convert:mdapi",
|
|
1985
|
-
"convert:force:mdapi",
|
|
1986
|
-
"convert:mdapi:force"
|
|
1987
|
-
],
|
|
1988
|
-
"permutations": [
|
|
1989
|
-
"project:convert:mdapi",
|
|
1990
|
-
"convert:project:mdapi",
|
|
1991
|
-
"convert:mdapi:project",
|
|
1992
|
-
"project:mdapi:convert",
|
|
1993
|
-
"mdapi:project:convert",
|
|
1994
|
-
"mdapi:convert:project"
|
|
1995
|
-
]
|
|
1996
|
-
},
|
|
1997
|
-
"project:convert:source-behavior": {
|
|
1998
|
-
"aliases": [],
|
|
1999
|
-
"args": {},
|
|
2000
|
-
"description": "Specifically, this command updates the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file and then converts the associated local source files in your project as needed.\n\nFor example, run this command with the \"--behavior decomposePermissionSetBeta\" flag to start decomposing permission sets when you deploy or retrieve them. Decomposing means breaking up the monolithic metadata API format XML file that corresponds to a metadata component into smaller XML files and directories based on its subtypes. Permission sets are not decomposed by default; you must opt-in to start decomposing them by using this command. When the command finishes, your \"sfdx-project.json\" file is updated to always decompose permission sets, and the existing permission set files in your local package directories are converted into the new decomposed format. You run this command only once for a given behavior change.\n\nFor more information about the possible values for the --behavior flag, see the \"sourceBehaviorOptions\" section in the https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.",
|
|
2001
|
-
"examples": [
|
|
2002
|
-
"Update your Salesforce DX project to decompose custom permission sets:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta",
|
|
2003
|
-
"Display what the command would do, but don't change any existing files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run",
|
|
2004
|
-
"Keep the temporary directory that contains the interim metadata API formatted files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir"
|
|
2005
|
-
],
|
|
2006
|
-
"flags": {
|
|
2007
|
-
"json": {
|
|
2008
|
-
"description": "Format output as json.",
|
|
2009
|
-
"helpGroup": "GLOBAL",
|
|
2010
|
-
"name": "json",
|
|
1645
|
+
},
|
|
1646
|
+
"single-package": {
|
|
1647
|
+
"dependsOn": [
|
|
1648
|
+
"metadata-dir"
|
|
1649
|
+
],
|
|
1650
|
+
"helpGroup": "Metadata API Format",
|
|
1651
|
+
"name": "single-package",
|
|
1652
|
+
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
2011
1653
|
"allowNo": false,
|
|
2012
1654
|
"type": "boolean"
|
|
2013
1655
|
},
|
|
2014
|
-
"
|
|
2015
|
-
"
|
|
2016
|
-
"
|
|
2017
|
-
"
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
|
-
|
|
2021
|
-
},
|
|
2022
|
-
"behavior": {
|
|
2023
|
-
"char": "b",
|
|
2024
|
-
"name": "behavior",
|
|
2025
|
-
"required": true,
|
|
2026
|
-
"summary": "Behavior to enable; the values correspond to the possible values of the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file.",
|
|
2027
|
-
"hasDynamicHelp": false,
|
|
2028
|
-
"multiple": false,
|
|
2029
|
-
"options": [
|
|
2030
|
-
"decomposeCustomLabelsBeta2",
|
|
2031
|
-
"decomposeCustomLabelsBeta",
|
|
2032
|
-
"decomposePermissionSetBeta",
|
|
2033
|
-
"decomposePermissionSetBeta2",
|
|
2034
|
-
"decomposeSharingRulesBeta",
|
|
2035
|
-
"decomposeWorkflowBeta",
|
|
2036
|
-
"decomposeExternalServiceRegistrationBeta"
|
|
1656
|
+
"source-dir": {
|
|
1657
|
+
"char": "d",
|
|
1658
|
+
"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.",
|
|
1659
|
+
"exclusive": [
|
|
1660
|
+
"manifest",
|
|
1661
|
+
"metadata",
|
|
1662
|
+
"metadata-dir"
|
|
2037
1663
|
],
|
|
1664
|
+
"helpGroup": "Source Format",
|
|
1665
|
+
"name": "source-dir",
|
|
1666
|
+
"summary": "Path to the local source files to deploy.",
|
|
1667
|
+
"hasDynamicHelp": false,
|
|
1668
|
+
"multiple": true,
|
|
2038
1669
|
"type": "option"
|
|
2039
1670
|
},
|
|
2040
|
-
"dry-run": {
|
|
2041
|
-
"name": "dry-run",
|
|
2042
|
-
"summary": "Display what the command would do, but don't make any actual changes.",
|
|
2043
|
-
"allowNo": false,
|
|
2044
|
-
"type": "boolean"
|
|
2045
|
-
},
|
|
2046
|
-
"preserve-temp-dir": {
|
|
2047
|
-
"name": "preserve-temp-dir",
|
|
2048
|
-
"summary": "Don't delete the metadata API format temporary directory that this command creates. Useful for debugging.",
|
|
2049
|
-
"allowNo": false,
|
|
2050
|
-
"type": "boolean"
|
|
2051
|
-
},
|
|
2052
1671
|
"target-org": {
|
|
2053
1672
|
"char": "o",
|
|
2054
1673
|
"name": "target-org",
|
|
2055
1674
|
"noCacheDefault": true,
|
|
2056
|
-
"
|
|
1675
|
+
"required": true,
|
|
1676
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2057
1677
|
"hasDynamicHelp": true,
|
|
2058
1678
|
"multiple": false,
|
|
2059
1679
|
"type": "option"
|
|
2060
|
-
}
|
|
2061
|
-
},
|
|
2062
|
-
"hasDynamicHelp": true,
|
|
2063
|
-
"hiddenAliases": [],
|
|
2064
|
-
"id": "project:convert:source-behavior",
|
|
2065
|
-
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2066
|
-
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2067
|
-
"pluginType": "core",
|
|
2068
|
-
"state": "beta",
|
|
2069
|
-
"strict": true,
|
|
2070
|
-
"summary": "Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.",
|
|
2071
|
-
"enableJsonFlag": true,
|
|
2072
|
-
"requiresProject": true,
|
|
2073
|
-
"isESM": true,
|
|
2074
|
-
"relativePath": [
|
|
2075
|
-
"lib",
|
|
2076
|
-
"commands",
|
|
2077
|
-
"project",
|
|
2078
|
-
"convert",
|
|
2079
|
-
"source-behavior.js"
|
|
2080
|
-
],
|
|
2081
|
-
"aliasPermutations": [],
|
|
2082
|
-
"permutations": [
|
|
2083
|
-
"project:convert:source-behavior",
|
|
2084
|
-
"convert:project:source-behavior",
|
|
2085
|
-
"convert:source-behavior:project",
|
|
2086
|
-
"project:source-behavior:convert",
|
|
2087
|
-
"source-behavior:project:convert",
|
|
2088
|
-
"source-behavior:convert:project"
|
|
2089
|
-
]
|
|
2090
|
-
},
|
|
2091
|
-
"project:convert:source": {
|
|
2092
|
-
"aliases": [
|
|
2093
|
-
"force:source:convert"
|
|
2094
|
-
],
|
|
2095
|
-
"args": {},
|
|
2096
|
-
"deprecateAliases": true,
|
|
2097
|
-
"description": "To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using \"<%= config.bin %> project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"<%= config.bin %> project convert mdapi\".\n\nTo specify a package name that includes spaces, enclose the name in single quotes.\n\nTo convert multiple components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
|
|
2098
|
-
"examples": [
|
|
2099
|
-
"Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source",
|
|
2100
|
-
"Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'"
|
|
2101
|
-
],
|
|
2102
|
-
"flags": {
|
|
2103
|
-
"json": {
|
|
2104
|
-
"description": "Format output as json.",
|
|
2105
|
-
"helpGroup": "GLOBAL",
|
|
2106
|
-
"name": "json",
|
|
2107
|
-
"allowNo": false,
|
|
2108
|
-
"type": "boolean"
|
|
2109
|
-
},
|
|
2110
|
-
"flags-dir": {
|
|
2111
|
-
"helpGroup": "GLOBAL",
|
|
2112
|
-
"name": "flags-dir",
|
|
2113
|
-
"summary": "Import flag values from a directory.",
|
|
2114
|
-
"hasDynamicHelp": false,
|
|
2115
|
-
"multiple": false,
|
|
2116
|
-
"type": "option"
|
|
2117
1680
|
},
|
|
2118
|
-
"
|
|
2119
|
-
"
|
|
2120
|
-
|
|
2121
|
-
|
|
2122
|
-
"
|
|
2123
|
-
"
|
|
2124
|
-
"name": "api-version",
|
|
2125
|
-
"summary": "API Version to use in the generated project's manifest. By default, will use the version from sfdx-project.json",
|
|
1681
|
+
"tests": {
|
|
1682
|
+
"char": "t",
|
|
1683
|
+
"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\"",
|
|
1684
|
+
"helpGroup": "Test",
|
|
1685
|
+
"name": "tests",
|
|
1686
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2126
1687
|
"hasDynamicHelp": false,
|
|
2127
|
-
"multiple":
|
|
1688
|
+
"multiple": true,
|
|
2128
1689
|
"type": "option"
|
|
2129
1690
|
},
|
|
2130
|
-
"
|
|
2131
|
-
"
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
"
|
|
2135
|
-
"
|
|
1691
|
+
"test-level": {
|
|
1692
|
+
"char": "l",
|
|
1693
|
+
"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- RunRelevantTests (Beta) — Runs only tests that are relevant to the files being deployed. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies. For fine-grained control, you can also annotate test classes so that they always run in certain conditions. See \"@IsTest Annotation\" in the \"Apex Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_annotation_isTest.htm). Each class and trigger in the deployment package must be covered by the executed tests for a minimum of 75% code coverage. This coverage is computed for each class and triggers individually and is different than the overall coverage percentage.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see \"Running Tests in a Deployment\" (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
|
|
1694
|
+
"helpGroup": "Test",
|
|
1695
|
+
"name": "test-level",
|
|
1696
|
+
"summary": "Deployment Apex testing level.",
|
|
2136
1697
|
"hasDynamicHelp": false,
|
|
2137
1698
|
"multiple": false,
|
|
1699
|
+
"options": [
|
|
1700
|
+
"NoTestRun",
|
|
1701
|
+
"RunSpecifiedTests",
|
|
1702
|
+
"RunLocalTests",
|
|
1703
|
+
"RunAllTestsInOrg",
|
|
1704
|
+
"RunRelevantTests"
|
|
1705
|
+
],
|
|
2138
1706
|
"type": "option"
|
|
2139
1707
|
},
|
|
2140
|
-
"
|
|
2141
|
-
"
|
|
2142
|
-
"
|
|
1708
|
+
"verbose": {
|
|
1709
|
+
"exclusive": [
|
|
1710
|
+
"concise"
|
|
2143
1711
|
],
|
|
2144
|
-
"
|
|
2145
|
-
"
|
|
2146
|
-
"
|
|
2147
|
-
"
|
|
2148
|
-
"hasDynamicHelp": false,
|
|
2149
|
-
"multiple": false,
|
|
2150
|
-
"type": "option"
|
|
1712
|
+
"name": "verbose",
|
|
1713
|
+
"summary": "Show verbose output of the deploy result.",
|
|
1714
|
+
"allowNo": false,
|
|
1715
|
+
"type": "boolean"
|
|
2151
1716
|
},
|
|
2152
|
-
"
|
|
2153
|
-
"
|
|
2154
|
-
|
|
1717
|
+
"wait": {
|
|
1718
|
+
"char": "w",
|
|
1719
|
+
"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\".",
|
|
1720
|
+
"exclusive": [
|
|
1721
|
+
"async"
|
|
2155
1722
|
],
|
|
2156
|
-
"
|
|
2157
|
-
"
|
|
2158
|
-
"name": "output-dir",
|
|
2159
|
-
"summary": "Output directory to store the Metadata API–formatted files in.",
|
|
2160
|
-
"default": "metadataPackage_>timestamp<",
|
|
1723
|
+
"name": "wait",
|
|
1724
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2161
1725
|
"hasDynamicHelp": true,
|
|
1726
|
+
"helpValue": "<minutes>",
|
|
2162
1727
|
"multiple": false,
|
|
2163
1728
|
"type": "option"
|
|
2164
1729
|
},
|
|
2165
|
-
"
|
|
2166
|
-
"
|
|
2167
|
-
|
|
1730
|
+
"purge-on-delete": {
|
|
1731
|
+
"helpGroup": "Delete",
|
|
1732
|
+
"name": "purge-on-delete",
|
|
1733
|
+
"relationships": [
|
|
1734
|
+
{
|
|
1735
|
+
"type": "some",
|
|
1736
|
+
"flags": [
|
|
1737
|
+
"pre-destructive-changes",
|
|
1738
|
+
"manifest",
|
|
1739
|
+
"metadata-dir",
|
|
1740
|
+
"post-destructive-changes"
|
|
1741
|
+
]
|
|
1742
|
+
}
|
|
2168
1743
|
],
|
|
2169
|
-
"
|
|
2170
|
-
"
|
|
2171
|
-
"
|
|
2172
|
-
"summary": "Name of the package to associate with the metadata-formatted files.",
|
|
2173
|
-
"hasDynamicHelp": false,
|
|
2174
|
-
"multiple": false,
|
|
2175
|
-
"type": "option"
|
|
1744
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1745
|
+
"allowNo": false,
|
|
1746
|
+
"type": "boolean"
|
|
2176
1747
|
},
|
|
2177
|
-
"
|
|
2178
|
-
"
|
|
2179
|
-
|
|
2180
|
-
|
|
2181
|
-
"
|
|
1748
|
+
"pre-destructive-changes": {
|
|
1749
|
+
"dependsOn": [
|
|
1750
|
+
"manifest"
|
|
1751
|
+
],
|
|
1752
|
+
"helpGroup": "Delete",
|
|
1753
|
+
"name": "pre-destructive-changes",
|
|
1754
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
|
|
2182
1755
|
"hasDynamicHelp": false,
|
|
2183
1756
|
"multiple": false,
|
|
2184
1757
|
"type": "option"
|
|
2185
1758
|
},
|
|
2186
|
-
"
|
|
2187
|
-
"
|
|
2188
|
-
"
|
|
2189
|
-
],
|
|
2190
|
-
"char": "p",
|
|
2191
|
-
"deprecateAliases": true,
|
|
2192
|
-
"description": "The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this flag, don’t specify --manifest or --metadata.",
|
|
2193
|
-
"exclusive": [
|
|
2194
|
-
"manifest",
|
|
2195
|
-
"metadata"
|
|
1759
|
+
"post-destructive-changes": {
|
|
1760
|
+
"dependsOn": [
|
|
1761
|
+
"manifest"
|
|
2196
1762
|
],
|
|
2197
|
-
"
|
|
2198
|
-
"
|
|
2199
|
-
"
|
|
1763
|
+
"helpGroup": "Delete",
|
|
1764
|
+
"name": "post-destructive-changes",
|
|
1765
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
2200
1766
|
"hasDynamicHelp": false,
|
|
2201
|
-
"multiple":
|
|
1767
|
+
"multiple": false,
|
|
2202
1768
|
"type": "option"
|
|
2203
1769
|
},
|
|
2204
|
-
"
|
|
2205
|
-
"
|
|
2206
|
-
"
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
],
|
|
2210
|
-
"name": "metadata",
|
|
2211
|
-
"summary": "Metadata component names to convert.",
|
|
2212
|
-
"delimiter": ",",
|
|
1770
|
+
"coverage-formatters": {
|
|
1771
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1772
|
+
"helpGroup": "Test",
|
|
1773
|
+
"name": "coverage-formatters",
|
|
1774
|
+
"summary": "Format of the code coverage results.",
|
|
2213
1775
|
"hasDynamicHelp": false,
|
|
2214
1776
|
"multiple": true,
|
|
1777
|
+
"options": [
|
|
1778
|
+
"clover",
|
|
1779
|
+
"cobertura",
|
|
1780
|
+
"html-spa",
|
|
1781
|
+
"html",
|
|
1782
|
+
"json",
|
|
1783
|
+
"json-summary",
|
|
1784
|
+
"lcovonly",
|
|
1785
|
+
"none",
|
|
1786
|
+
"teamcity",
|
|
1787
|
+
"text",
|
|
1788
|
+
"text-summary"
|
|
1789
|
+
],
|
|
2215
1790
|
"type": "option"
|
|
2216
|
-
}
|
|
2217
|
-
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
1791
|
+
},
|
|
1792
|
+
"junit": {
|
|
1793
|
+
"helpGroup": "Test",
|
|
1794
|
+
"name": "junit",
|
|
1795
|
+
"summary": "Output JUnit test results.",
|
|
1796
|
+
"allowNo": false,
|
|
1797
|
+
"type": "boolean"
|
|
1798
|
+
},
|
|
1799
|
+
"results-dir": {
|
|
1800
|
+
"helpGroup": "Test",
|
|
1801
|
+
"name": "results-dir",
|
|
1802
|
+
"relationships": [
|
|
1803
|
+
{
|
|
1804
|
+
"type": "some",
|
|
1805
|
+
"flags": [
|
|
1806
|
+
"coverage-formatters",
|
|
1807
|
+
"junit"
|
|
1808
|
+
]
|
|
1809
|
+
}
|
|
1810
|
+
],
|
|
1811
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
1812
|
+
"hasDynamicHelp": false,
|
|
1813
|
+
"multiple": false,
|
|
1814
|
+
"type": "option"
|
|
1815
|
+
}
|
|
1816
|
+
},
|
|
1817
|
+
"hasDynamicHelp": true,
|
|
1818
|
+
"hiddenAliases": [],
|
|
1819
|
+
"id": "project:deploy:start",
|
|
1820
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1821
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2223
1822
|
"pluginType": "core",
|
|
2224
1823
|
"strict": true,
|
|
2225
|
-
"summary": "
|
|
1824
|
+
"summary": "Deploy metadata to an org from your local project.",
|
|
2226
1825
|
"enableJsonFlag": true,
|
|
2227
|
-
"
|
|
1826
|
+
"configurationVariablesSection": {
|
|
1827
|
+
"header": "CONFIGURATION VARIABLES",
|
|
1828
|
+
"body": [
|
|
1829
|
+
{
|
|
1830
|
+
"name": "target-org",
|
|
1831
|
+
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1832
|
+
},
|
|
1833
|
+
{
|
|
1834
|
+
"name": "org-api-version",
|
|
1835
|
+
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1836
|
+
}
|
|
1837
|
+
]
|
|
1838
|
+
},
|
|
1839
|
+
"envVariablesSection": {
|
|
1840
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1841
|
+
"body": [
|
|
1842
|
+
{
|
|
1843
|
+
"name": "SF_TARGET_ORG",
|
|
1844
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1845
|
+
},
|
|
1846
|
+
{
|
|
1847
|
+
"name": "SF_USE_PROGRESS_BAR",
|
|
1848
|
+
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
1849
|
+
}
|
|
1850
|
+
]
|
|
1851
|
+
},
|
|
1852
|
+
"errorCodes": {
|
|
1853
|
+
"header": "ERROR CODES",
|
|
1854
|
+
"body": [
|
|
1855
|
+
{
|
|
1856
|
+
"name": "Succeeded (0)",
|
|
1857
|
+
"description": "The deploy succeeded."
|
|
1858
|
+
},
|
|
1859
|
+
{
|
|
1860
|
+
"name": "Canceled (1)",
|
|
1861
|
+
"description": "The deploy was canceled."
|
|
1862
|
+
},
|
|
1863
|
+
{
|
|
1864
|
+
"name": "Failed (1)",
|
|
1865
|
+
"description": "The deploy failed."
|
|
1866
|
+
},
|
|
1867
|
+
{
|
|
1868
|
+
"name": "SucceededPartial (68)",
|
|
1869
|
+
"description": "The deploy partially succeeded."
|
|
1870
|
+
},
|
|
1871
|
+
{
|
|
1872
|
+
"name": "InProgress (69)",
|
|
1873
|
+
"description": "The deploy is in progress."
|
|
1874
|
+
},
|
|
1875
|
+
{
|
|
1876
|
+
"name": "Pending (69)",
|
|
1877
|
+
"description": "The deploy is pending."
|
|
1878
|
+
},
|
|
1879
|
+
{
|
|
1880
|
+
"name": "Canceling (69)",
|
|
1881
|
+
"description": "The deploy is being canceled."
|
|
1882
|
+
}
|
|
1883
|
+
]
|
|
1884
|
+
},
|
|
2228
1885
|
"isESM": true,
|
|
2229
1886
|
"relativePath": [
|
|
2230
1887
|
"lib",
|
|
2231
1888
|
"commands",
|
|
2232
1889
|
"project",
|
|
2233
|
-
"
|
|
2234
|
-
"
|
|
1890
|
+
"deploy",
|
|
1891
|
+
"start.js"
|
|
2235
1892
|
],
|
|
2236
1893
|
"aliasPermutations": [
|
|
2237
|
-
"
|
|
2238
|
-
"
|
|
2239
|
-
"source:convert:force",
|
|
2240
|
-
"force:convert:source",
|
|
2241
|
-
"convert:force:source",
|
|
2242
|
-
"convert:source:force"
|
|
1894
|
+
"deploy:metadata",
|
|
1895
|
+
"metadata:deploy"
|
|
2243
1896
|
],
|
|
2244
1897
|
"permutations": [
|
|
2245
|
-
"project:
|
|
2246
|
-
"
|
|
2247
|
-
"
|
|
2248
|
-
"project:
|
|
2249
|
-
"
|
|
2250
|
-
"
|
|
1898
|
+
"project:deploy:start",
|
|
1899
|
+
"deploy:project:start",
|
|
1900
|
+
"deploy:start:project",
|
|
1901
|
+
"project:start:deploy",
|
|
1902
|
+
"start:project:deploy",
|
|
1903
|
+
"start:deploy:project"
|
|
2251
1904
|
]
|
|
2252
1905
|
},
|
|
2253
|
-
"project:
|
|
1906
|
+
"project:deploy:validate": {
|
|
2254
1907
|
"aliases": [
|
|
2255
|
-
"
|
|
1908
|
+
"deploy:metadata:validate"
|
|
2256
1909
|
],
|
|
2257
1910
|
"args": {},
|
|
2258
1911
|
"deprecateAliases": true,
|
|
2259
|
-
"description": "
|
|
1912
|
+
"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.",
|
|
2260
1913
|
"examples": [
|
|
2261
|
-
"
|
|
2262
|
-
"
|
|
2263
|
-
"
|
|
1914
|
+
"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.",
|
|
1915
|
+
"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",
|
|
1916
|
+
"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",
|
|
1917
|
+
"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",
|
|
1918
|
+
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
2264
1919
|
],
|
|
2265
1920
|
"flags": {
|
|
2266
1921
|
"json": {
|
|
@@ -2270,78 +1925,329 @@
|
|
|
2270
1925
|
"allowNo": false,
|
|
2271
1926
|
"type": "boolean"
|
|
2272
1927
|
},
|
|
2273
|
-
"flags-dir": {
|
|
2274
|
-
"helpGroup": "GLOBAL",
|
|
2275
|
-
"name": "flags-dir",
|
|
2276
|
-
"summary": "Import flag values from a directory.",
|
|
1928
|
+
"flags-dir": {
|
|
1929
|
+
"helpGroup": "GLOBAL",
|
|
1930
|
+
"name": "flags-dir",
|
|
1931
|
+
"summary": "Import flag values from a directory.",
|
|
1932
|
+
"hasDynamicHelp": false,
|
|
1933
|
+
"multiple": false,
|
|
1934
|
+
"type": "option"
|
|
1935
|
+
},
|
|
1936
|
+
"api-version": {
|
|
1937
|
+
"char": "a",
|
|
1938
|
+
"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.",
|
|
1939
|
+
"name": "api-version",
|
|
1940
|
+
"summary": "Target API version for the validation.",
|
|
1941
|
+
"hasDynamicHelp": false,
|
|
1942
|
+
"multiple": false,
|
|
1943
|
+
"type": "option"
|
|
1944
|
+
},
|
|
1945
|
+
"async": {
|
|
1946
|
+
"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\".",
|
|
1947
|
+
"name": "async",
|
|
1948
|
+
"summary": "Run the command asynchronously.",
|
|
1949
|
+
"allowNo": false,
|
|
1950
|
+
"type": "boolean"
|
|
1951
|
+
},
|
|
1952
|
+
"concise": {
|
|
1953
|
+
"exclusive": [
|
|
1954
|
+
"verbose"
|
|
1955
|
+
],
|
|
1956
|
+
"name": "concise",
|
|
1957
|
+
"summary": "Show concise output of the validation result.",
|
|
1958
|
+
"allowNo": false,
|
|
1959
|
+
"type": "boolean"
|
|
1960
|
+
},
|
|
1961
|
+
"manifest": {
|
|
1962
|
+
"char": "x",
|
|
1963
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1964
|
+
"helpGroup": "Source Format",
|
|
1965
|
+
"name": "manifest",
|
|
1966
|
+
"summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
|
|
1967
|
+
"hasDynamicHelp": false,
|
|
1968
|
+
"multiple": false,
|
|
1969
|
+
"type": "option"
|
|
1970
|
+
},
|
|
1971
|
+
"metadata": {
|
|
1972
|
+
"char": "m",
|
|
1973
|
+
"helpGroup": "Source Format",
|
|
1974
|
+
"name": "metadata",
|
|
1975
|
+
"summary": "Metadata component names to validate for deployment.",
|
|
1976
|
+
"hasDynamicHelp": false,
|
|
1977
|
+
"multiple": true,
|
|
1978
|
+
"type": "option"
|
|
1979
|
+
},
|
|
1980
|
+
"source-dir": {
|
|
1981
|
+
"char": "d",
|
|
1982
|
+
"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.",
|
|
1983
|
+
"helpGroup": "Source Format",
|
|
1984
|
+
"name": "source-dir",
|
|
1985
|
+
"summary": "Path to the local source files to validate for deployment.",
|
|
1986
|
+
"hasDynamicHelp": false,
|
|
1987
|
+
"multiple": true,
|
|
1988
|
+
"type": "option"
|
|
1989
|
+
},
|
|
1990
|
+
"metadata-dir": {
|
|
1991
|
+
"helpGroup": "Metadata API Format",
|
|
1992
|
+
"name": "metadata-dir",
|
|
1993
|
+
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1994
|
+
"hasDynamicHelp": false,
|
|
1995
|
+
"multiple": false,
|
|
1996
|
+
"type": "option"
|
|
1997
|
+
},
|
|
1998
|
+
"single-package": {
|
|
1999
|
+
"dependsOn": [
|
|
2000
|
+
"metadata-dir"
|
|
2001
|
+
],
|
|
2002
|
+
"helpGroup": "Metadata API Format",
|
|
2003
|
+
"name": "single-package",
|
|
2004
|
+
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
2005
|
+
"allowNo": false,
|
|
2006
|
+
"type": "boolean"
|
|
2007
|
+
},
|
|
2008
|
+
"target-org": {
|
|
2009
|
+
"char": "o",
|
|
2010
|
+
"name": "target-org",
|
|
2011
|
+
"noCacheDefault": true,
|
|
2012
|
+
"required": true,
|
|
2013
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2014
|
+
"hasDynamicHelp": true,
|
|
2015
|
+
"multiple": false,
|
|
2016
|
+
"type": "option"
|
|
2017
|
+
},
|
|
2018
|
+
"tests": {
|
|
2019
|
+
"char": "t",
|
|
2020
|
+
"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\"",
|
|
2021
|
+
"helpGroup": "Test",
|
|
2022
|
+
"name": "tests",
|
|
2023
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2024
|
+
"hasDynamicHelp": false,
|
|
2025
|
+
"multiple": true,
|
|
2026
|
+
"type": "option"
|
|
2027
|
+
},
|
|
2028
|
+
"test-level": {
|
|
2029
|
+
"char": "l",
|
|
2030
|
+
"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.\n\n- RunRelevantTests (Beta) — Runs only tests that are relevant to the files being deployed. Salesforce automatically identifies the relevant tests based on an analysis of the deployment payload and the payload dependencies. For fine-grained control, you can also annotate test classes so that they always run in certain conditions. See \"@IsTest Annotation\" in the \"Apex Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_annotation_isTest.htm). Each class and trigger in the deployment package must be covered by the executed tests for a minimum of 75% code coverage. This coverage is computed for each class and triggers individually and is different than the overall coverage percentage.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see \"Running Tests in a Deployment\" (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
|
|
2031
|
+
"helpGroup": "Test",
|
|
2032
|
+
"name": "test-level",
|
|
2033
|
+
"summary": "Deployment Apex testing level.",
|
|
2034
|
+
"default": "RunLocalTests",
|
|
2035
|
+
"hasDynamicHelp": false,
|
|
2036
|
+
"multiple": false,
|
|
2037
|
+
"options": [
|
|
2038
|
+
"RunAllTestsInOrg",
|
|
2039
|
+
"RunLocalTests",
|
|
2040
|
+
"RunSpecifiedTests",
|
|
2041
|
+
"RunRelevantTests"
|
|
2042
|
+
],
|
|
2043
|
+
"type": "option"
|
|
2044
|
+
},
|
|
2045
|
+
"verbose": {
|
|
2046
|
+
"exclusive": [
|
|
2047
|
+
"concise"
|
|
2048
|
+
],
|
|
2049
|
+
"name": "verbose",
|
|
2050
|
+
"summary": "Show verbose output of the validation result.",
|
|
2051
|
+
"allowNo": false,
|
|
2052
|
+
"type": "boolean"
|
|
2053
|
+
},
|
|
2054
|
+
"wait": {
|
|
2055
|
+
"char": "w",
|
|
2056
|
+
"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\".",
|
|
2057
|
+
"name": "wait",
|
|
2058
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
2059
|
+
"hasDynamicHelp": true,
|
|
2060
|
+
"helpValue": "<minutes>",
|
|
2061
|
+
"multiple": false,
|
|
2062
|
+
"type": "option"
|
|
2063
|
+
},
|
|
2064
|
+
"ignore-warnings": {
|
|
2065
|
+
"char": "g",
|
|
2066
|
+
"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.",
|
|
2067
|
+
"name": "ignore-warnings",
|
|
2068
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
2069
|
+
"allowNo": false,
|
|
2070
|
+
"type": "boolean"
|
|
2071
|
+
},
|
|
2072
|
+
"coverage-formatters": {
|
|
2073
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
2074
|
+
"helpGroup": "Test",
|
|
2075
|
+
"name": "coverage-formatters",
|
|
2076
|
+
"summary": "Format of the code coverage results.",
|
|
2077
|
+
"hasDynamicHelp": false,
|
|
2078
|
+
"multiple": true,
|
|
2079
|
+
"options": [
|
|
2080
|
+
"clover",
|
|
2081
|
+
"cobertura",
|
|
2082
|
+
"html-spa",
|
|
2083
|
+
"html",
|
|
2084
|
+
"json",
|
|
2085
|
+
"json-summary",
|
|
2086
|
+
"lcovonly",
|
|
2087
|
+
"none",
|
|
2088
|
+
"teamcity",
|
|
2089
|
+
"text",
|
|
2090
|
+
"text-summary"
|
|
2091
|
+
],
|
|
2092
|
+
"type": "option"
|
|
2093
|
+
},
|
|
2094
|
+
"junit": {
|
|
2095
|
+
"helpGroup": "Test",
|
|
2096
|
+
"name": "junit",
|
|
2097
|
+
"summary": "Output JUnit test results.",
|
|
2098
|
+
"allowNo": false,
|
|
2099
|
+
"type": "boolean"
|
|
2100
|
+
},
|
|
2101
|
+
"results-dir": {
|
|
2102
|
+
"helpGroup": "Test",
|
|
2103
|
+
"name": "results-dir",
|
|
2104
|
+
"relationships": [
|
|
2105
|
+
{
|
|
2106
|
+
"type": "some",
|
|
2107
|
+
"flags": [
|
|
2108
|
+
"coverage-formatters",
|
|
2109
|
+
"junit"
|
|
2110
|
+
]
|
|
2111
|
+
}
|
|
2112
|
+
],
|
|
2113
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
2114
|
+
"hasDynamicHelp": false,
|
|
2115
|
+
"multiple": false,
|
|
2116
|
+
"type": "option"
|
|
2117
|
+
},
|
|
2118
|
+
"purge-on-delete": {
|
|
2119
|
+
"dependsOn": [
|
|
2120
|
+
"manifest"
|
|
2121
|
+
],
|
|
2122
|
+
"helpGroup": "Delete",
|
|
2123
|
+
"name": "purge-on-delete",
|
|
2124
|
+
"relationships": [
|
|
2125
|
+
{
|
|
2126
|
+
"type": "some",
|
|
2127
|
+
"flags": [
|
|
2128
|
+
"pre-destructive-changes",
|
|
2129
|
+
"post-destructive-changes"
|
|
2130
|
+
]
|
|
2131
|
+
}
|
|
2132
|
+
],
|
|
2133
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
2134
|
+
"allowNo": false,
|
|
2135
|
+
"type": "boolean"
|
|
2136
|
+
},
|
|
2137
|
+
"pre-destructive-changes": {
|
|
2138
|
+
"dependsOn": [
|
|
2139
|
+
"manifest"
|
|
2140
|
+
],
|
|
2141
|
+
"helpGroup": "Delete",
|
|
2142
|
+
"name": "pre-destructive-changes",
|
|
2143
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
2277
2144
|
"hasDynamicHelp": false,
|
|
2278
2145
|
"multiple": false,
|
|
2279
2146
|
"type": "option"
|
|
2280
2147
|
},
|
|
2281
|
-
"
|
|
2282
|
-
"
|
|
2283
|
-
"
|
|
2148
|
+
"post-destructive-changes": {
|
|
2149
|
+
"dependsOn": [
|
|
2150
|
+
"manifest"
|
|
2284
2151
|
],
|
|
2285
|
-
"
|
|
2286
|
-
"
|
|
2287
|
-
"
|
|
2288
|
-
"summary": "File or directory of files that the command checks for foreceignored files.",
|
|
2152
|
+
"helpGroup": "Delete",
|
|
2153
|
+
"name": "post-destructive-changes",
|
|
2154
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
2289
2155
|
"hasDynamicHelp": false,
|
|
2290
2156
|
"multiple": false,
|
|
2291
2157
|
"type": "option"
|
|
2292
2158
|
}
|
|
2293
2159
|
},
|
|
2294
|
-
"hasDynamicHelp":
|
|
2160
|
+
"hasDynamicHelp": true,
|
|
2295
2161
|
"hiddenAliases": [],
|
|
2296
|
-
"id": "project:
|
|
2162
|
+
"id": "project:deploy:validate",
|
|
2297
2163
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2298
2164
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2299
2165
|
"pluginType": "core",
|
|
2300
2166
|
"strict": true,
|
|
2301
|
-
"summary": "
|
|
2167
|
+
"summary": "Validate a metadata deployment without actually executing it.",
|
|
2302
2168
|
"enableJsonFlag": true,
|
|
2303
|
-
"
|
|
2169
|
+
"configurationVariablesSection": {
|
|
2170
|
+
"header": "CONFIGURATION VARIABLES",
|
|
2171
|
+
"body": [
|
|
2172
|
+
{
|
|
2173
|
+
"name": "target-org",
|
|
2174
|
+
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
2175
|
+
},
|
|
2176
|
+
{
|
|
2177
|
+
"name": "org-api-version",
|
|
2178
|
+
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
2179
|
+
}
|
|
2180
|
+
]
|
|
2181
|
+
},
|
|
2182
|
+
"envVariablesSection": {
|
|
2183
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2184
|
+
"body": [
|
|
2185
|
+
{
|
|
2186
|
+
"name": "SF_TARGET_ORG",
|
|
2187
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2188
|
+
},
|
|
2189
|
+
{
|
|
2190
|
+
"name": "SF_USE_PROGRESS_BAR",
|
|
2191
|
+
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
2192
|
+
}
|
|
2193
|
+
]
|
|
2194
|
+
},
|
|
2195
|
+
"errorCodes": {
|
|
2196
|
+
"header": "ERROR CODES",
|
|
2197
|
+
"body": [
|
|
2198
|
+
{
|
|
2199
|
+
"name": "Succeeded (0)",
|
|
2200
|
+
"description": "The deploy succeeded."
|
|
2201
|
+
},
|
|
2202
|
+
{
|
|
2203
|
+
"name": "Canceled (1)",
|
|
2204
|
+
"description": "The deploy was canceled."
|
|
2205
|
+
},
|
|
2206
|
+
{
|
|
2207
|
+
"name": "Failed (1)",
|
|
2208
|
+
"description": "The deploy failed."
|
|
2209
|
+
},
|
|
2210
|
+
{
|
|
2211
|
+
"name": "SucceededPartial (68)",
|
|
2212
|
+
"description": "The deploy partially succeeded."
|
|
2213
|
+
},
|
|
2214
|
+
{
|
|
2215
|
+
"name": "InProgress (69)",
|
|
2216
|
+
"description": "The deploy is in progress."
|
|
2217
|
+
},
|
|
2218
|
+
{
|
|
2219
|
+
"name": "Pending (69)",
|
|
2220
|
+
"description": "The deploy is pending."
|
|
2221
|
+
},
|
|
2222
|
+
{
|
|
2223
|
+
"name": "Canceling (69)",
|
|
2224
|
+
"description": "The deploy is being canceled."
|
|
2225
|
+
}
|
|
2226
|
+
]
|
|
2227
|
+
},
|
|
2304
2228
|
"isESM": true,
|
|
2305
2229
|
"relativePath": [
|
|
2306
2230
|
"lib",
|
|
2307
2231
|
"commands",
|
|
2308
2232
|
"project",
|
|
2309
|
-
"
|
|
2310
|
-
"
|
|
2233
|
+
"deploy",
|
|
2234
|
+
"validate.js"
|
|
2311
2235
|
],
|
|
2312
2236
|
"aliasPermutations": [
|
|
2313
|
-
"
|
|
2314
|
-
"
|
|
2315
|
-
"
|
|
2316
|
-
"
|
|
2317
|
-
"
|
|
2318
|
-
"
|
|
2319
|
-
"ignored:source:force:list",
|
|
2320
|
-
"ignored:source:list:force",
|
|
2321
|
-
"force:ignored:list:source",
|
|
2322
|
-
"ignored:force:list:source",
|
|
2323
|
-
"ignored:list:force:source",
|
|
2324
|
-
"ignored:list:source:force",
|
|
2325
|
-
"force:source:list:ignored",
|
|
2326
|
-
"source:force:list:ignored",
|
|
2327
|
-
"source:list:force:ignored",
|
|
2328
|
-
"source:list:ignored:force",
|
|
2329
|
-
"force:list:source:ignored",
|
|
2330
|
-
"list:force:source:ignored",
|
|
2331
|
-
"list:source:force:ignored",
|
|
2332
|
-
"list:source:ignored:force",
|
|
2333
|
-
"force:list:ignored:source",
|
|
2334
|
-
"list:force:ignored:source",
|
|
2335
|
-
"list:ignored:force:source",
|
|
2336
|
-
"list:ignored:source:force"
|
|
2237
|
+
"deploy:metadata:validate",
|
|
2238
|
+
"metadata:deploy:validate",
|
|
2239
|
+
"metadata:validate:deploy",
|
|
2240
|
+
"deploy:validate:metadata",
|
|
2241
|
+
"validate:deploy:metadata",
|
|
2242
|
+
"validate:metadata:deploy"
|
|
2337
2243
|
],
|
|
2338
2244
|
"permutations": [
|
|
2339
|
-
"project:
|
|
2340
|
-
"
|
|
2341
|
-
"
|
|
2342
|
-
"project:
|
|
2343
|
-
"
|
|
2344
|
-
"
|
|
2245
|
+
"project:deploy:validate",
|
|
2246
|
+
"deploy:project:validate",
|
|
2247
|
+
"deploy:validate:project",
|
|
2248
|
+
"project:validate:deploy",
|
|
2249
|
+
"validate:project:deploy",
|
|
2250
|
+
"validate:deploy:project"
|
|
2345
2251
|
]
|
|
2346
2252
|
},
|
|
2347
2253
|
"project:generate:manifest": {
|
|
@@ -2572,6 +2478,100 @@
|
|
|
2572
2478
|
"manifest:generate:project"
|
|
2573
2479
|
]
|
|
2574
2480
|
},
|
|
2481
|
+
"project:list:ignored": {
|
|
2482
|
+
"aliases": [
|
|
2483
|
+
"force:source:ignored:list"
|
|
2484
|
+
],
|
|
2485
|
+
"args": {},
|
|
2486
|
+
"deprecateAliases": true,
|
|
2487
|
+
"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.",
|
|
2488
|
+
"examples": [
|
|
2489
|
+
"List all the files in all package directories that are ignored:\n<%= config.bin %> <%= command.id %>",
|
|
2490
|
+
"List all the files in a specific directory that are ignored:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
|
|
2491
|
+
"Check if a particular file is ignored:\n<%= config.bin %> <%= command.id %> --source-dir package.xml"
|
|
2492
|
+
],
|
|
2493
|
+
"flags": {
|
|
2494
|
+
"json": {
|
|
2495
|
+
"description": "Format output as json.",
|
|
2496
|
+
"helpGroup": "GLOBAL",
|
|
2497
|
+
"name": "json",
|
|
2498
|
+
"allowNo": false,
|
|
2499
|
+
"type": "boolean"
|
|
2500
|
+
},
|
|
2501
|
+
"flags-dir": {
|
|
2502
|
+
"helpGroup": "GLOBAL",
|
|
2503
|
+
"name": "flags-dir",
|
|
2504
|
+
"summary": "Import flag values from a directory.",
|
|
2505
|
+
"hasDynamicHelp": false,
|
|
2506
|
+
"multiple": false,
|
|
2507
|
+
"type": "option"
|
|
2508
|
+
},
|
|
2509
|
+
"source-dir": {
|
|
2510
|
+
"aliases": [
|
|
2511
|
+
"sourcepath"
|
|
2512
|
+
],
|
|
2513
|
+
"char": "p",
|
|
2514
|
+
"deprecateAliases": true,
|
|
2515
|
+
"name": "source-dir",
|
|
2516
|
+
"summary": "File or directory of files that the command checks for foreceignored files.",
|
|
2517
|
+
"hasDynamicHelp": false,
|
|
2518
|
+
"multiple": false,
|
|
2519
|
+
"type": "option"
|
|
2520
|
+
}
|
|
2521
|
+
},
|
|
2522
|
+
"hasDynamicHelp": false,
|
|
2523
|
+
"hiddenAliases": [],
|
|
2524
|
+
"id": "project:list:ignored",
|
|
2525
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2526
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2527
|
+
"pluginType": "core",
|
|
2528
|
+
"strict": true,
|
|
2529
|
+
"summary": "Check your local project package directories for forceignored files.",
|
|
2530
|
+
"enableJsonFlag": true,
|
|
2531
|
+
"requiresProject": true,
|
|
2532
|
+
"isESM": true,
|
|
2533
|
+
"relativePath": [
|
|
2534
|
+
"lib",
|
|
2535
|
+
"commands",
|
|
2536
|
+
"project",
|
|
2537
|
+
"list",
|
|
2538
|
+
"ignored.js"
|
|
2539
|
+
],
|
|
2540
|
+
"aliasPermutations": [
|
|
2541
|
+
"force:source:ignored:list",
|
|
2542
|
+
"source:force:ignored:list",
|
|
2543
|
+
"source:ignored:force:list",
|
|
2544
|
+
"source:ignored:list:force",
|
|
2545
|
+
"force:ignored:source:list",
|
|
2546
|
+
"ignored:force:source:list",
|
|
2547
|
+
"ignored:source:force:list",
|
|
2548
|
+
"ignored:source:list:force",
|
|
2549
|
+
"force:ignored:list:source",
|
|
2550
|
+
"ignored:force:list:source",
|
|
2551
|
+
"ignored:list:force:source",
|
|
2552
|
+
"ignored:list:source:force",
|
|
2553
|
+
"force:source:list:ignored",
|
|
2554
|
+
"source:force:list:ignored",
|
|
2555
|
+
"source:list:force:ignored",
|
|
2556
|
+
"source:list:ignored:force",
|
|
2557
|
+
"force:list:source:ignored",
|
|
2558
|
+
"list:force:source:ignored",
|
|
2559
|
+
"list:source:force:ignored",
|
|
2560
|
+
"list:source:ignored:force",
|
|
2561
|
+
"force:list:ignored:source",
|
|
2562
|
+
"list:force:ignored:source",
|
|
2563
|
+
"list:ignored:force:source",
|
|
2564
|
+
"list:ignored:source:force"
|
|
2565
|
+
],
|
|
2566
|
+
"permutations": [
|
|
2567
|
+
"project:list:ignored",
|
|
2568
|
+
"list:project:ignored",
|
|
2569
|
+
"list:ignored:project",
|
|
2570
|
+
"project:ignored:list",
|
|
2571
|
+
"ignored:project:list",
|
|
2572
|
+
"ignored:list:project"
|
|
2573
|
+
]
|
|
2574
|
+
},
|
|
2575
2575
|
"project:reset:tracking": {
|
|
2576
2576
|
"aliases": [
|
|
2577
2577
|
"force:source:tracking:reset"
|
|
@@ -3066,5 +3066,5 @@
|
|
|
3066
3066
|
]
|
|
3067
3067
|
}
|
|
3068
3068
|
},
|
|
3069
|
-
"version": "4.2
|
|
3069
|
+
"version": "4.3.2"
|
|
3070
3070
|
}
|