@salesforce/plugin-deploy-retrieve 3.2.7 → 3.2.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -17
- package/lib/commands/project/deploy/cancel.js +2 -2
- package/lib/commands/project/deploy/cancel.js.map +1 -1
- package/lib/commands/project/deploy/quick.js +25 -4
- package/lib/commands/project/deploy/quick.js.map +1 -1
- package/lib/commands/project/deploy/report.js +7 -5
- package/lib/commands/project/deploy/report.js.map +1 -1
- package/lib/commands/project/deploy/resume.js +3 -3
- package/lib/commands/project/deploy/resume.js.map +1 -1
- package/lib/utils/deployCache.d.ts +17 -0
- package/lib/utils/deployCache.js +55 -20
- package/lib/utils/deployCache.js.map +1 -1
- package/messages/cache.md +4 -0
- package/messages/deploy.metadata.quick.md +4 -0
- package/oclif.lock +780 -795
- package/oclif.manifest.json +1106 -1106
- package/package.json +5 -5
package/oclif.manifest.json
CHANGED
|
@@ -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 \"<%= config.bin %> 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 --manifest and --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": {
|
|
@@ -42,153 +40,80 @@
|
|
|
42
40
|
"multiple": false,
|
|
43
41
|
"type": "option"
|
|
44
42
|
},
|
|
45
|
-
"
|
|
43
|
+
"root-dir": {
|
|
46
44
|
"aliases": [
|
|
47
|
-
"
|
|
48
|
-
"u"
|
|
45
|
+
"rootdir"
|
|
49
46
|
],
|
|
50
|
-
"char": "
|
|
47
|
+
"char": "r",
|
|
51
48
|
"deprecateAliases": true,
|
|
52
|
-
"name": "
|
|
53
|
-
"noCacheDefault": true,
|
|
49
|
+
"name": "root-dir",
|
|
54
50
|
"required": true,
|
|
55
|
-
"summary": "
|
|
56
|
-
"hasDynamicHelp":
|
|
51
|
+
"summary": "Root directory that contains the Metadata API–formatted metadata.",
|
|
52
|
+
"hasDynamicHelp": false,
|
|
57
53
|
"multiple": false,
|
|
58
54
|
"type": "option"
|
|
59
55
|
},
|
|
60
|
-
"
|
|
56
|
+
"output-dir": {
|
|
61
57
|
"aliases": [
|
|
62
|
-
"
|
|
58
|
+
"outputdir"
|
|
63
59
|
],
|
|
64
|
-
"char": "
|
|
60
|
+
"char": "d",
|
|
65
61
|
"deprecateAliases": true,
|
|
66
|
-
"
|
|
67
|
-
"
|
|
68
|
-
"summary": "Validate delete command but don't delete anything from the org or the local project.",
|
|
69
|
-
"allowNo": false,
|
|
70
|
-
"type": "boolean"
|
|
71
|
-
},
|
|
72
|
-
"wait": {
|
|
73
|
-
"char": "w",
|
|
74
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
|
|
75
|
-
"name": "wait",
|
|
76
|
-
"summary": "Number of minutes to wait for the command to finish.",
|
|
77
|
-
"default": {
|
|
78
|
-
"quantity": 33,
|
|
79
|
-
"unit": 0
|
|
80
|
-
},
|
|
62
|
+
"name": "output-dir",
|
|
63
|
+
"summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
|
|
81
64
|
"hasDynamicHelp": false,
|
|
82
65
|
"multiple": false,
|
|
83
66
|
"type": "option"
|
|
84
67
|
},
|
|
85
|
-
"
|
|
86
|
-
"
|
|
87
|
-
"
|
|
88
|
-
"name": "
|
|
89
|
-
"summary": "
|
|
90
|
-
"hasDynamicHelp": false,
|
|
91
|
-
"multiple": true,
|
|
92
|
-
"type": "option"
|
|
93
|
-
},
|
|
94
|
-
"test-level": {
|
|
95
|
-
"aliases": [
|
|
96
|
-
"testlevel"
|
|
97
|
-
],
|
|
98
|
-
"char": "l",
|
|
99
|
-
"deprecateAliases": true,
|
|
100
|
-
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
|
|
101
|
-
"helpGroup": "Test",
|
|
102
|
-
"name": "test-level",
|
|
103
|
-
"summary": "Deployment Apex testing level.",
|
|
68
|
+
"manifest": {
|
|
69
|
+
"char": "x",
|
|
70
|
+
"description": "If you specify this parameter, don’t specify --metadata or --source-dir.",
|
|
71
|
+
"name": "manifest",
|
|
72
|
+
"summary": "File path to manifest (package.xml) of metadata types to convert.",
|
|
104
73
|
"hasDynamicHelp": false,
|
|
105
74
|
"multiple": false,
|
|
106
|
-
"options": [
|
|
107
|
-
"NoTestRun",
|
|
108
|
-
"RunSpecifiedTests",
|
|
109
|
-
"RunLocalTests",
|
|
110
|
-
"RunAllTestsInOrg"
|
|
111
|
-
],
|
|
112
75
|
"type": "option"
|
|
113
76
|
},
|
|
114
|
-
"
|
|
77
|
+
"metadata-dir": {
|
|
115
78
|
"aliases": [
|
|
116
|
-
"
|
|
79
|
+
"metadatapath"
|
|
117
80
|
],
|
|
118
|
-
"char": "
|
|
81
|
+
"char": "p",
|
|
119
82
|
"deprecateAliases": true,
|
|
120
|
-
"
|
|
121
|
-
"
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
"
|
|
127
|
-
"description": "If you specify this parameter, don’t specify --source-dir.",
|
|
128
|
-
"name": "metadata",
|
|
129
|
-
"summary": "Metadata components to delete.",
|
|
83
|
+
"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.",
|
|
84
|
+
"exclusive": [
|
|
85
|
+
"manifest",
|
|
86
|
+
"metadata"
|
|
87
|
+
],
|
|
88
|
+
"name": "metadata-dir",
|
|
89
|
+
"summary": "Root of directory or zip file of metadata formatted files to convert.",
|
|
130
90
|
"delimiter": ",",
|
|
131
91
|
"hasDynamicHelp": false,
|
|
132
92
|
"multiple": true,
|
|
133
93
|
"type": "option"
|
|
134
94
|
},
|
|
135
|
-
"
|
|
136
|
-
"
|
|
137
|
-
|
|
95
|
+
"metadata": {
|
|
96
|
+
"char": "m",
|
|
97
|
+
"exclusive": [
|
|
98
|
+
"manifest",
|
|
99
|
+
"metadatapath"
|
|
138
100
|
],
|
|
139
|
-
"
|
|
140
|
-
"
|
|
141
|
-
"description": "The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this parameter, don’t specify --metadata.",
|
|
142
|
-
"name": "source-dir",
|
|
143
|
-
"summary": "Source file paths to delete.",
|
|
101
|
+
"name": "metadata",
|
|
102
|
+
"summary": "Metadata component names to convert.",
|
|
144
103
|
"delimiter": ",",
|
|
145
104
|
"hasDynamicHelp": false,
|
|
146
105
|
"multiple": true,
|
|
147
106
|
"type": "option"
|
|
148
|
-
},
|
|
149
|
-
"track-source": {
|
|
150
|
-
"aliases": [
|
|
151
|
-
"tracksource"
|
|
152
|
-
],
|
|
153
|
-
"char": "t",
|
|
154
|
-
"deprecateAliases": true,
|
|
155
|
-
"exclusive": [
|
|
156
|
-
"check-only"
|
|
157
|
-
],
|
|
158
|
-
"name": "track-source",
|
|
159
|
-
"summary": "If the delete succeeds, update the source tracking information.",
|
|
160
|
-
"allowNo": false,
|
|
161
|
-
"type": "boolean"
|
|
162
|
-
},
|
|
163
|
-
"force-overwrite": {
|
|
164
|
-
"aliases": [
|
|
165
|
-
"forceoverwrite"
|
|
166
|
-
],
|
|
167
|
-
"char": "f",
|
|
168
|
-
"dependsOn": [
|
|
169
|
-
"track-source"
|
|
170
|
-
],
|
|
171
|
-
"deprecateAliases": true,
|
|
172
|
-
"name": "force-overwrite",
|
|
173
|
-
"summary": "Ignore conflict warnings and overwrite changes to the org.",
|
|
174
|
-
"allowNo": false,
|
|
175
|
-
"type": "boolean"
|
|
176
|
-
},
|
|
177
|
-
"verbose": {
|
|
178
|
-
"name": "verbose",
|
|
179
|
-
"summary": "Verbose output of the delete result.",
|
|
180
|
-
"allowNo": false,
|
|
181
|
-
"type": "boolean"
|
|
182
107
|
}
|
|
183
108
|
},
|
|
184
|
-
"hasDynamicHelp":
|
|
109
|
+
"hasDynamicHelp": false,
|
|
185
110
|
"hiddenAliases": [],
|
|
186
|
-
"id": "project:
|
|
111
|
+
"id": "project:convert:mdapi",
|
|
187
112
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
188
113
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
189
114
|
"pluginType": "core",
|
|
190
115
|
"strict": true,
|
|
191
|
-
"summary": "
|
|
116
|
+
"summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
|
|
192
117
|
"enableJsonFlag": true,
|
|
193
118
|
"requiresProject": true,
|
|
194
119
|
"isESM": true,
|
|
@@ -196,35 +121,36 @@
|
|
|
196
121
|
"lib",
|
|
197
122
|
"commands",
|
|
198
123
|
"project",
|
|
199
|
-
"
|
|
200
|
-
"
|
|
124
|
+
"convert",
|
|
125
|
+
"mdapi.js"
|
|
201
126
|
],
|
|
202
127
|
"aliasPermutations": [
|
|
203
|
-
"force:
|
|
204
|
-
"
|
|
205
|
-
"
|
|
206
|
-
"force:
|
|
207
|
-
"
|
|
208
|
-
"
|
|
128
|
+
"force:mdapi:convert",
|
|
129
|
+
"mdapi:force:convert",
|
|
130
|
+
"mdapi:convert:force",
|
|
131
|
+
"force:convert:mdapi",
|
|
132
|
+
"convert:force:mdapi",
|
|
133
|
+
"convert:mdapi:force"
|
|
209
134
|
],
|
|
210
135
|
"permutations": [
|
|
211
|
-
"project:
|
|
212
|
-
"
|
|
213
|
-
"
|
|
214
|
-
"project:
|
|
215
|
-
"
|
|
216
|
-
"
|
|
136
|
+
"project:convert:mdapi",
|
|
137
|
+
"convert:project:mdapi",
|
|
138
|
+
"convert:mdapi:project",
|
|
139
|
+
"project:mdapi:convert",
|
|
140
|
+
"mdapi:project:convert",
|
|
141
|
+
"mdapi:convert:project"
|
|
217
142
|
]
|
|
218
143
|
},
|
|
219
|
-
"project:
|
|
144
|
+
"project:convert:source": {
|
|
220
145
|
"aliases": [
|
|
221
|
-
"force:source:
|
|
146
|
+
"force:source:convert"
|
|
222
147
|
],
|
|
223
148
|
"args": {},
|
|
224
149
|
"deprecateAliases": true,
|
|
225
|
-
"description": "
|
|
150
|
+
"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 --manifest and --source-dir.",
|
|
226
151
|
"examples": [
|
|
227
|
-
"
|
|
152
|
+
"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",
|
|
153
|
+
"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'"
|
|
228
154
|
],
|
|
229
155
|
"flags": {
|
|
230
156
|
"json": {
|
|
@@ -241,6 +167,7 @@
|
|
|
241
167
|
"deprecateAliases": true,
|
|
242
168
|
"description": "Override the api version used for api requests made by this command",
|
|
243
169
|
"name": "api-version",
|
|
170
|
+
"summary": "API Version to use in the generated project's manifest. By default, will use the version from sfdx-project.json",
|
|
244
171
|
"hasDynamicHelp": false,
|
|
245
172
|
"multiple": false,
|
|
246
173
|
"type": "option"
|
|
@@ -255,193 +182,131 @@
|
|
|
255
182
|
"multiple": false,
|
|
256
183
|
"type": "option"
|
|
257
184
|
},
|
|
258
|
-
"
|
|
185
|
+
"root-dir": {
|
|
259
186
|
"aliases": [
|
|
260
|
-
"
|
|
261
|
-
"u"
|
|
187
|
+
"rootdir"
|
|
262
188
|
],
|
|
263
|
-
"char": "
|
|
189
|
+
"char": "r",
|
|
264
190
|
"deprecateAliases": true,
|
|
265
|
-
"name": "
|
|
266
|
-
"
|
|
267
|
-
"
|
|
268
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
269
|
-
"hasDynamicHelp": true,
|
|
191
|
+
"name": "root-dir",
|
|
192
|
+
"summary": "Source directory other than the default package to convert.",
|
|
193
|
+
"hasDynamicHelp": false,
|
|
270
194
|
"multiple": false,
|
|
271
195
|
"type": "option"
|
|
272
196
|
},
|
|
273
|
-
"
|
|
197
|
+
"output-dir": {
|
|
274
198
|
"aliases": [
|
|
275
|
-
"
|
|
199
|
+
"outputdir"
|
|
200
|
+
],
|
|
201
|
+
"char": "d",
|
|
202
|
+
"deprecateAliases": true,
|
|
203
|
+
"name": "output-dir",
|
|
204
|
+
"summary": "Output directory to store the Metadata API–formatted files in.",
|
|
205
|
+
"default": "metadataPackage_1706639901301",
|
|
206
|
+
"hasDynamicHelp": false,
|
|
207
|
+
"multiple": false,
|
|
208
|
+
"type": "option"
|
|
209
|
+
},
|
|
210
|
+
"package-name": {
|
|
211
|
+
"aliases": [
|
|
212
|
+
"packagename"
|
|
213
|
+
],
|
|
214
|
+
"char": "n",
|
|
215
|
+
"deprecateAliases": true,
|
|
216
|
+
"name": "package-name",
|
|
217
|
+
"summary": "Name of the package to associate with the metadata-formatted files.",
|
|
218
|
+
"hasDynamicHelp": false,
|
|
219
|
+
"multiple": false,
|
|
220
|
+
"type": "option"
|
|
221
|
+
},
|
|
222
|
+
"manifest": {
|
|
223
|
+
"char": "x",
|
|
224
|
+
"description": "If you specify this parameter, don’t specify --metadata or --source-dir.",
|
|
225
|
+
"name": "manifest",
|
|
226
|
+
"summary": "Path to the manifest (package.xml) file that specifies the metadata types to convert.",
|
|
227
|
+
"hasDynamicHelp": false,
|
|
228
|
+
"multiple": false,
|
|
229
|
+
"type": "option"
|
|
230
|
+
},
|
|
231
|
+
"source-dir": {
|
|
232
|
+
"aliases": [
|
|
233
|
+
"sourcepath"
|
|
276
234
|
],
|
|
277
235
|
"char": "p",
|
|
278
236
|
"deprecateAliases": true,
|
|
279
|
-
"
|
|
280
|
-
"summary": "Don't prompt for source tracking override confirmation.",
|
|
281
|
-
"allowNo": false,
|
|
282
|
-
"type": "boolean"
|
|
283
|
-
}
|
|
284
|
-
},
|
|
285
|
-
"hasDynamicHelp": true,
|
|
286
|
-
"hiddenAliases": [],
|
|
287
|
-
"id": "project:delete:tracking",
|
|
288
|
-
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
289
|
-
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
290
|
-
"pluginType": "core",
|
|
291
|
-
"strict": true,
|
|
292
|
-
"summary": "Delete all local source tracking information.",
|
|
293
|
-
"enableJsonFlag": true,
|
|
294
|
-
"requiresProject": true,
|
|
295
|
-
"isESM": true,
|
|
296
|
-
"relativePath": [
|
|
297
|
-
"lib",
|
|
298
|
-
"commands",
|
|
299
|
-
"project",
|
|
300
|
-
"delete",
|
|
301
|
-
"tracking.js"
|
|
302
|
-
],
|
|
303
|
-
"aliasPermutations": [
|
|
304
|
-
"force:source:tracking:clear",
|
|
305
|
-
"source:force:tracking:clear",
|
|
306
|
-
"source:tracking:force:clear",
|
|
307
|
-
"source:tracking:clear:force",
|
|
308
|
-
"force:tracking:source:clear",
|
|
309
|
-
"tracking:force:source:clear",
|
|
310
|
-
"tracking:source:force:clear",
|
|
311
|
-
"tracking:source:clear:force",
|
|
312
|
-
"force:tracking:clear:source",
|
|
313
|
-
"tracking:force:clear:source",
|
|
314
|
-
"tracking:clear:force:source",
|
|
315
|
-
"tracking:clear:source:force",
|
|
316
|
-
"force:source:clear:tracking",
|
|
317
|
-
"source:force:clear:tracking",
|
|
318
|
-
"source:clear:force:tracking",
|
|
319
|
-
"source:clear:tracking:force",
|
|
320
|
-
"force:clear:source:tracking",
|
|
321
|
-
"clear:force:source:tracking",
|
|
322
|
-
"clear:source:force:tracking",
|
|
323
|
-
"clear:source:tracking:force",
|
|
324
|
-
"force:clear:tracking:source",
|
|
325
|
-
"clear:force:tracking:source",
|
|
326
|
-
"clear:tracking:force:source",
|
|
327
|
-
"clear:tracking:source:force"
|
|
328
|
-
],
|
|
329
|
-
"permutations": [
|
|
330
|
-
"project:delete:tracking",
|
|
331
|
-
"delete:project:tracking",
|
|
332
|
-
"delete:tracking:project",
|
|
333
|
-
"project:tracking:delete",
|
|
334
|
-
"tracking:project:delete",
|
|
335
|
-
"tracking:delete:project"
|
|
336
|
-
]
|
|
337
|
-
},
|
|
338
|
-
"project:deploy:cancel": {
|
|
339
|
-
"aliases": [
|
|
340
|
-
"deploy:metadata:cancel"
|
|
341
|
-
],
|
|
342
|
-
"args": {},
|
|
343
|
-
"deprecateAliases": true,
|
|
344
|
-
"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.",
|
|
345
|
-
"examples": [
|
|
346
|
-
"Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
347
|
-
"Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
348
|
-
],
|
|
349
|
-
"flags": {
|
|
350
|
-
"json": {
|
|
351
|
-
"description": "Format output as json.",
|
|
352
|
-
"helpGroup": "GLOBAL",
|
|
353
|
-
"name": "json",
|
|
354
|
-
"allowNo": false,
|
|
355
|
-
"type": "boolean"
|
|
356
|
-
},
|
|
357
|
-
"async": {
|
|
358
|
-
"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\".",
|
|
237
|
+
"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 parameter, don’t specify --manifest or --metadata.",
|
|
359
238
|
"exclusive": [
|
|
360
|
-
"
|
|
239
|
+
"manifest",
|
|
240
|
+
"metadata"
|
|
361
241
|
],
|
|
362
|
-
"name": "
|
|
363
|
-
"summary": "
|
|
364
|
-
"
|
|
365
|
-
"type": "boolean"
|
|
366
|
-
},
|
|
367
|
-
"job-id": {
|
|
368
|
-
"char": "i",
|
|
369
|
-
"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.",
|
|
370
|
-
"name": "job-id",
|
|
371
|
-
"summary": "Job ID of the deploy operation you want to cancel.",
|
|
242
|
+
"name": "source-dir",
|
|
243
|
+
"summary": "Paths to the local source files to convert.",
|
|
244
|
+
"delimiter": ",",
|
|
372
245
|
"hasDynamicHelp": false,
|
|
373
|
-
"multiple":
|
|
246
|
+
"multiple": true,
|
|
374
247
|
"type": "option"
|
|
375
248
|
},
|
|
376
|
-
"
|
|
377
|
-
"char": "
|
|
378
|
-
"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.",
|
|
379
|
-
"name": "use-most-recent",
|
|
380
|
-
"summary": "Use the job ID of the most recent deploy operation.",
|
|
381
|
-
"allowNo": false,
|
|
382
|
-
"type": "boolean"
|
|
383
|
-
},
|
|
384
|
-
"wait": {
|
|
385
|
-
"char": "w",
|
|
386
|
-
"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\".",
|
|
249
|
+
"metadata": {
|
|
250
|
+
"char": "m",
|
|
387
251
|
"exclusive": [
|
|
388
|
-
"
|
|
252
|
+
"manifest",
|
|
253
|
+
"sourcepath"
|
|
389
254
|
],
|
|
390
|
-
"name": "
|
|
391
|
-
"summary": "
|
|
255
|
+
"name": "metadata",
|
|
256
|
+
"summary": "Metadata component names to convert.",
|
|
257
|
+
"delimiter": ",",
|
|
392
258
|
"hasDynamicHelp": false,
|
|
393
|
-
"
|
|
394
|
-
"multiple": false,
|
|
259
|
+
"multiple": true,
|
|
395
260
|
"type": "option"
|
|
396
261
|
}
|
|
397
262
|
},
|
|
398
263
|
"hasDynamicHelp": false,
|
|
399
264
|
"hiddenAliases": [],
|
|
400
|
-
"id": "project:
|
|
265
|
+
"id": "project:convert:source",
|
|
401
266
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
402
267
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
403
268
|
"pluginType": "core",
|
|
404
269
|
"strict": true,
|
|
405
|
-
"summary": "
|
|
270
|
+
"summary": "Convert source-formatted files into metadata that you can deploy using Metadata API.",
|
|
406
271
|
"enableJsonFlag": true,
|
|
272
|
+
"requiresProject": true,
|
|
407
273
|
"isESM": true,
|
|
408
274
|
"relativePath": [
|
|
409
275
|
"lib",
|
|
410
276
|
"commands",
|
|
411
277
|
"project",
|
|
412
|
-
"
|
|
413
|
-
"
|
|
278
|
+
"convert",
|
|
279
|
+
"source.js"
|
|
414
280
|
],
|
|
415
281
|
"aliasPermutations": [
|
|
416
|
-
"
|
|
417
|
-
"
|
|
418
|
-
"
|
|
419
|
-
"
|
|
420
|
-
"
|
|
421
|
-
"
|
|
282
|
+
"force:source:convert",
|
|
283
|
+
"source:force:convert",
|
|
284
|
+
"source:convert:force",
|
|
285
|
+
"force:convert:source",
|
|
286
|
+
"convert:force:source",
|
|
287
|
+
"convert:source:force"
|
|
422
288
|
],
|
|
423
289
|
"permutations": [
|
|
424
|
-
"project:
|
|
425
|
-
"
|
|
426
|
-
"
|
|
427
|
-
"project:
|
|
428
|
-
"
|
|
429
|
-
"
|
|
290
|
+
"project:convert:source",
|
|
291
|
+
"convert:project:source",
|
|
292
|
+
"convert:source:project",
|
|
293
|
+
"project:source:convert",
|
|
294
|
+
"source:project:convert",
|
|
295
|
+
"source:convert:project"
|
|
430
296
|
]
|
|
431
297
|
},
|
|
432
|
-
"project:
|
|
298
|
+
"project:delete:source": {
|
|
433
299
|
"aliases": [
|
|
434
|
-
"
|
|
300
|
+
"force:source:delete"
|
|
435
301
|
],
|
|
436
302
|
"args": {},
|
|
437
303
|
"deprecateAliases": true,
|
|
438
|
-
"description": "
|
|
304
|
+
"description": "Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, \"<%= config.bin %> project deploy start\".\n\nWhen you run this command, both the local source file and the metadata component in the org are deleted.\n\nTo delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
439
305
|
"examples": [
|
|
440
|
-
"
|
|
441
|
-
"
|
|
442
|
-
"
|
|
443
|
-
"
|
|
444
|
-
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
306
|
+
"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",
|
|
307
|
+
"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",
|
|
308
|
+
"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",
|
|
309
|
+
"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"
|
|
445
310
|
],
|
|
446
311
|
"flags": {
|
|
447
312
|
"json": {
|
|
@@ -451,91 +316,521 @@
|
|
|
451
316
|
"allowNo": false,
|
|
452
317
|
"type": "boolean"
|
|
453
318
|
},
|
|
454
|
-
"
|
|
455
|
-
"
|
|
456
|
-
|
|
457
|
-
"name": "ignore-conflicts",
|
|
458
|
-
"summary": "Don't display conflicts in preview of the deployment.",
|
|
459
|
-
"allowNo": false,
|
|
460
|
-
"type": "boolean"
|
|
461
|
-
},
|
|
462
|
-
"manifest": {
|
|
463
|
-
"char": "x",
|
|
464
|
-
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
465
|
-
"exclusive": [
|
|
466
|
-
"source-dir",
|
|
467
|
-
"metadata"
|
|
319
|
+
"api-version": {
|
|
320
|
+
"aliases": [
|
|
321
|
+
"apiversion"
|
|
468
322
|
],
|
|
469
|
-
"
|
|
470
|
-
"
|
|
323
|
+
"deprecateAliases": true,
|
|
324
|
+
"description": "Override the api version used for api requests made by this command",
|
|
325
|
+
"name": "api-version",
|
|
471
326
|
"hasDynamicHelp": false,
|
|
472
327
|
"multiple": false,
|
|
473
328
|
"type": "option"
|
|
474
329
|
},
|
|
475
|
-
"
|
|
476
|
-
"
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
"name": "metadata",
|
|
482
|
-
"summary": "Metadata component names to preview.",
|
|
483
|
-
"hasDynamicHelp": false,
|
|
484
|
-
"multiple": true,
|
|
485
|
-
"type": "option"
|
|
486
|
-
},
|
|
487
|
-
"source-dir": {
|
|
488
|
-
"char": "d",
|
|
489
|
-
"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.",
|
|
490
|
-
"exclusive": [
|
|
491
|
-
"manifest",
|
|
492
|
-
"metadata"
|
|
493
|
-
],
|
|
494
|
-
"name": "source-dir",
|
|
495
|
-
"summary": "Path to the local source files to preview.",
|
|
330
|
+
"loglevel": {
|
|
331
|
+
"deprecated": {
|
|
332
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
333
|
+
},
|
|
334
|
+
"hidden": true,
|
|
335
|
+
"name": "loglevel",
|
|
496
336
|
"hasDynamicHelp": false,
|
|
497
|
-
"multiple":
|
|
337
|
+
"multiple": false,
|
|
498
338
|
"type": "option"
|
|
499
339
|
},
|
|
500
340
|
"target-org": {
|
|
341
|
+
"aliases": [
|
|
342
|
+
"targetusername",
|
|
343
|
+
"u"
|
|
344
|
+
],
|
|
501
345
|
"char": "o",
|
|
502
|
-
"
|
|
346
|
+
"deprecateAliases": true,
|
|
503
347
|
"name": "target-org",
|
|
504
348
|
"noCacheDefault": true,
|
|
505
349
|
"required": true,
|
|
506
|
-
"summary": "
|
|
350
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
507
351
|
"hasDynamicHelp": true,
|
|
508
352
|
"multiple": false,
|
|
509
353
|
"type": "option"
|
|
510
354
|
},
|
|
511
|
-
"
|
|
512
|
-
"
|
|
513
|
-
|
|
355
|
+
"check-only": {
|
|
356
|
+
"aliases": [
|
|
357
|
+
"checkonly"
|
|
358
|
+
],
|
|
359
|
+
"char": "c",
|
|
360
|
+
"deprecateAliases": true,
|
|
361
|
+
"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 --chec-konly parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.\n\nIf your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.\n\nNote: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.\n\n 1. For a deletion with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to delete the Master-Detail field, or the deletion fails. During the deletion, detail records are permanently deleted from the Recycle Bin and cannot be recovered.\n\n 2. For a deletion that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deletion to succeed. However, a successful deletion permanently deletes any detail records in the Recycle Bin.",
|
|
362
|
+
"name": "check-only",
|
|
363
|
+
"summary": "Validate delete command but don't delete anything from the org or the local project.",
|
|
514
364
|
"allowNo": false,
|
|
515
365
|
"type": "boolean"
|
|
516
|
-
}
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
"
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
366
|
+
},
|
|
367
|
+
"wait": {
|
|
368
|
+
"char": "w",
|
|
369
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
|
|
370
|
+
"name": "wait",
|
|
371
|
+
"summary": "Number of minutes to wait for the command to finish.",
|
|
372
|
+
"default": {
|
|
373
|
+
"quantity": 33,
|
|
374
|
+
"unit": 0
|
|
375
|
+
},
|
|
376
|
+
"hasDynamicHelp": false,
|
|
377
|
+
"multiple": false,
|
|
378
|
+
"type": "option"
|
|
379
|
+
},
|
|
380
|
+
"tests": {
|
|
381
|
+
"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\"",
|
|
382
|
+
"helpGroup": "Test",
|
|
383
|
+
"name": "tests",
|
|
384
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
385
|
+
"hasDynamicHelp": false,
|
|
386
|
+
"multiple": true,
|
|
387
|
+
"type": "option"
|
|
388
|
+
},
|
|
389
|
+
"test-level": {
|
|
390
|
+
"aliases": [
|
|
391
|
+
"testlevel"
|
|
392
|
+
],
|
|
393
|
+
"char": "l",
|
|
394
|
+
"deprecateAliases": true,
|
|
395
|
+
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
|
|
396
|
+
"helpGroup": "Test",
|
|
397
|
+
"name": "test-level",
|
|
398
|
+
"summary": "Deployment Apex testing level.",
|
|
399
|
+
"hasDynamicHelp": false,
|
|
400
|
+
"multiple": false,
|
|
401
|
+
"options": [
|
|
402
|
+
"NoTestRun",
|
|
403
|
+
"RunSpecifiedTests",
|
|
404
|
+
"RunLocalTests",
|
|
405
|
+
"RunAllTestsInOrg"
|
|
406
|
+
],
|
|
407
|
+
"type": "option"
|
|
408
|
+
},
|
|
409
|
+
"no-prompt": {
|
|
410
|
+
"aliases": [
|
|
411
|
+
"noprompt"
|
|
412
|
+
],
|
|
413
|
+
"char": "r",
|
|
414
|
+
"deprecateAliases": true,
|
|
415
|
+
"name": "no-prompt",
|
|
416
|
+
"summary": "Don't prompt for delete confirmation.",
|
|
417
|
+
"allowNo": false,
|
|
418
|
+
"type": "boolean"
|
|
419
|
+
},
|
|
420
|
+
"metadata": {
|
|
421
|
+
"char": "m",
|
|
422
|
+
"description": "If you specify this parameter, don’t specify --source-dir.",
|
|
423
|
+
"name": "metadata",
|
|
424
|
+
"summary": "Metadata components to delete.",
|
|
425
|
+
"delimiter": ",",
|
|
426
|
+
"hasDynamicHelp": false,
|
|
427
|
+
"multiple": true,
|
|
428
|
+
"type": "option"
|
|
429
|
+
},
|
|
430
|
+
"source-dir": {
|
|
431
|
+
"aliases": [
|
|
432
|
+
"sourcepath"
|
|
433
|
+
],
|
|
434
|
+
"char": "p",
|
|
435
|
+
"deprecateAliases": true,
|
|
436
|
+
"description": "The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this parameter, don’t specify --metadata.",
|
|
437
|
+
"name": "source-dir",
|
|
438
|
+
"summary": "Source file paths to delete.",
|
|
439
|
+
"delimiter": ",",
|
|
440
|
+
"hasDynamicHelp": false,
|
|
441
|
+
"multiple": true,
|
|
442
|
+
"type": "option"
|
|
443
|
+
},
|
|
444
|
+
"track-source": {
|
|
445
|
+
"aliases": [
|
|
446
|
+
"tracksource"
|
|
447
|
+
],
|
|
448
|
+
"char": "t",
|
|
449
|
+
"deprecateAliases": true,
|
|
450
|
+
"exclusive": [
|
|
451
|
+
"check-only"
|
|
452
|
+
],
|
|
453
|
+
"name": "track-source",
|
|
454
|
+
"summary": "If the delete succeeds, update the source tracking information.",
|
|
455
|
+
"allowNo": false,
|
|
456
|
+
"type": "boolean"
|
|
457
|
+
},
|
|
458
|
+
"force-overwrite": {
|
|
459
|
+
"aliases": [
|
|
460
|
+
"forceoverwrite"
|
|
461
|
+
],
|
|
462
|
+
"char": "f",
|
|
463
|
+
"dependsOn": [
|
|
464
|
+
"track-source"
|
|
465
|
+
],
|
|
466
|
+
"deprecateAliases": true,
|
|
467
|
+
"name": "force-overwrite",
|
|
468
|
+
"summary": "Ignore conflict warnings and overwrite changes to the org.",
|
|
469
|
+
"allowNo": false,
|
|
470
|
+
"type": "boolean"
|
|
471
|
+
},
|
|
472
|
+
"verbose": {
|
|
473
|
+
"name": "verbose",
|
|
474
|
+
"summary": "Verbose output of the delete result.",
|
|
475
|
+
"allowNo": false,
|
|
476
|
+
"type": "boolean"
|
|
477
|
+
}
|
|
478
|
+
},
|
|
479
|
+
"hasDynamicHelp": true,
|
|
480
|
+
"hiddenAliases": [],
|
|
481
|
+
"id": "project:delete:source",
|
|
482
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
483
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
484
|
+
"pluginType": "core",
|
|
485
|
+
"strict": true,
|
|
486
|
+
"summary": "Delete source from your project and from a non-source-tracked org.",
|
|
487
|
+
"enableJsonFlag": true,
|
|
488
|
+
"requiresProject": true,
|
|
489
|
+
"isESM": true,
|
|
490
|
+
"relativePath": [
|
|
491
|
+
"lib",
|
|
492
|
+
"commands",
|
|
493
|
+
"project",
|
|
494
|
+
"delete",
|
|
495
|
+
"source.js"
|
|
496
|
+
],
|
|
497
|
+
"aliasPermutations": [
|
|
498
|
+
"force:source:delete",
|
|
499
|
+
"source:force:delete",
|
|
500
|
+
"source:delete:force",
|
|
501
|
+
"force:delete:source",
|
|
502
|
+
"delete:force:source",
|
|
503
|
+
"delete:source:force"
|
|
504
|
+
],
|
|
505
|
+
"permutations": [
|
|
506
|
+
"project:delete:source",
|
|
507
|
+
"delete:project:source",
|
|
508
|
+
"delete:source:project",
|
|
509
|
+
"project:source:delete",
|
|
510
|
+
"source:project:delete",
|
|
511
|
+
"source:delete:project"
|
|
512
|
+
]
|
|
513
|
+
},
|
|
514
|
+
"project:delete:tracking": {
|
|
515
|
+
"aliases": [
|
|
516
|
+
"force:source:tracking:clear"
|
|
517
|
+
],
|
|
518
|
+
"args": {},
|
|
519
|
+
"deprecateAliases": true,
|
|
520
|
+
"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.",
|
|
521
|
+
"examples": [
|
|
522
|
+
"Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
|
|
523
|
+
],
|
|
524
|
+
"flags": {
|
|
525
|
+
"json": {
|
|
526
|
+
"description": "Format output as json.",
|
|
527
|
+
"helpGroup": "GLOBAL",
|
|
528
|
+
"name": "json",
|
|
529
|
+
"allowNo": false,
|
|
530
|
+
"type": "boolean"
|
|
531
|
+
},
|
|
532
|
+
"api-version": {
|
|
533
|
+
"aliases": [
|
|
534
|
+
"apiversion"
|
|
535
|
+
],
|
|
536
|
+
"deprecateAliases": true,
|
|
537
|
+
"description": "Override the api version used for api requests made by this command",
|
|
538
|
+
"name": "api-version",
|
|
539
|
+
"hasDynamicHelp": false,
|
|
540
|
+
"multiple": false,
|
|
541
|
+
"type": "option"
|
|
542
|
+
},
|
|
543
|
+
"loglevel": {
|
|
544
|
+
"deprecated": {
|
|
545
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
546
|
+
},
|
|
547
|
+
"hidden": true,
|
|
548
|
+
"name": "loglevel",
|
|
549
|
+
"hasDynamicHelp": false,
|
|
550
|
+
"multiple": false,
|
|
551
|
+
"type": "option"
|
|
552
|
+
},
|
|
553
|
+
"target-org": {
|
|
554
|
+
"aliases": [
|
|
555
|
+
"targetusername",
|
|
556
|
+
"u"
|
|
557
|
+
],
|
|
558
|
+
"char": "o",
|
|
559
|
+
"deprecateAliases": true,
|
|
560
|
+
"name": "target-org",
|
|
561
|
+
"noCacheDefault": true,
|
|
562
|
+
"required": true,
|
|
563
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
564
|
+
"hasDynamicHelp": true,
|
|
565
|
+
"multiple": false,
|
|
566
|
+
"type": "option"
|
|
567
|
+
},
|
|
568
|
+
"no-prompt": {
|
|
569
|
+
"aliases": [
|
|
570
|
+
"noprompt"
|
|
571
|
+
],
|
|
572
|
+
"char": "p",
|
|
573
|
+
"deprecateAliases": true,
|
|
574
|
+
"name": "no-prompt",
|
|
575
|
+
"summary": "Don't prompt for source tracking override confirmation.",
|
|
576
|
+
"allowNo": false,
|
|
577
|
+
"type": "boolean"
|
|
578
|
+
}
|
|
579
|
+
},
|
|
580
|
+
"hasDynamicHelp": true,
|
|
581
|
+
"hiddenAliases": [],
|
|
582
|
+
"id": "project:delete:tracking",
|
|
583
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
584
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
585
|
+
"pluginType": "core",
|
|
586
|
+
"strict": true,
|
|
587
|
+
"summary": "Delete all local source tracking information.",
|
|
588
|
+
"enableJsonFlag": true,
|
|
589
|
+
"requiresProject": true,
|
|
590
|
+
"isESM": true,
|
|
591
|
+
"relativePath": [
|
|
592
|
+
"lib",
|
|
593
|
+
"commands",
|
|
594
|
+
"project",
|
|
595
|
+
"delete",
|
|
596
|
+
"tracking.js"
|
|
597
|
+
],
|
|
598
|
+
"aliasPermutations": [
|
|
599
|
+
"force:source:tracking:clear",
|
|
600
|
+
"source:force:tracking:clear",
|
|
601
|
+
"source:tracking:force:clear",
|
|
602
|
+
"source:tracking:clear:force",
|
|
603
|
+
"force:tracking:source:clear",
|
|
604
|
+
"tracking:force:source:clear",
|
|
605
|
+
"tracking:source:force:clear",
|
|
606
|
+
"tracking:source:clear:force",
|
|
607
|
+
"force:tracking:clear:source",
|
|
608
|
+
"tracking:force:clear:source",
|
|
609
|
+
"tracking:clear:force:source",
|
|
610
|
+
"tracking:clear:source:force",
|
|
611
|
+
"force:source:clear:tracking",
|
|
612
|
+
"source:force:clear:tracking",
|
|
613
|
+
"source:clear:force:tracking",
|
|
614
|
+
"source:clear:tracking:force",
|
|
615
|
+
"force:clear:source:tracking",
|
|
616
|
+
"clear:force:source:tracking",
|
|
617
|
+
"clear:source:force:tracking",
|
|
618
|
+
"clear:source:tracking:force",
|
|
619
|
+
"force:clear:tracking:source",
|
|
620
|
+
"clear:force:tracking:source",
|
|
621
|
+
"clear:tracking:force:source",
|
|
622
|
+
"clear:tracking:source:force"
|
|
623
|
+
],
|
|
624
|
+
"permutations": [
|
|
625
|
+
"project:delete:tracking",
|
|
626
|
+
"delete:project:tracking",
|
|
627
|
+
"delete:tracking:project",
|
|
628
|
+
"project:tracking:delete",
|
|
629
|
+
"tracking:project:delete",
|
|
630
|
+
"tracking:delete:project"
|
|
631
|
+
]
|
|
632
|
+
},
|
|
633
|
+
"project:deploy:cancel": {
|
|
634
|
+
"aliases": [
|
|
635
|
+
"deploy:metadata:cancel"
|
|
636
|
+
],
|
|
637
|
+
"args": {},
|
|
638
|
+
"deprecateAliases": true,
|
|
639
|
+
"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.",
|
|
640
|
+
"examples": [
|
|
641
|
+
"Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
642
|
+
"Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
643
|
+
],
|
|
644
|
+
"flags": {
|
|
645
|
+
"json": {
|
|
646
|
+
"description": "Format output as json.",
|
|
647
|
+
"helpGroup": "GLOBAL",
|
|
648
|
+
"name": "json",
|
|
649
|
+
"allowNo": false,
|
|
650
|
+
"type": "boolean"
|
|
651
|
+
},
|
|
652
|
+
"async": {
|
|
653
|
+
"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\".",
|
|
654
|
+
"exclusive": [
|
|
655
|
+
"wait"
|
|
656
|
+
],
|
|
657
|
+
"name": "async",
|
|
658
|
+
"summary": "Run the command asynchronously.",
|
|
659
|
+
"allowNo": false,
|
|
660
|
+
"type": "boolean"
|
|
661
|
+
},
|
|
662
|
+
"job-id": {
|
|
663
|
+
"char": "i",
|
|
664
|
+
"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.",
|
|
665
|
+
"name": "job-id",
|
|
666
|
+
"summary": "Job ID of the deploy operation you want to cancel.",
|
|
667
|
+
"hasDynamicHelp": false,
|
|
668
|
+
"multiple": false,
|
|
669
|
+
"type": "option"
|
|
670
|
+
},
|
|
671
|
+
"use-most-recent": {
|
|
672
|
+
"char": "r",
|
|
673
|
+
"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.",
|
|
674
|
+
"name": "use-most-recent",
|
|
675
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
676
|
+
"allowNo": false,
|
|
677
|
+
"type": "boolean"
|
|
678
|
+
},
|
|
679
|
+
"wait": {
|
|
680
|
+
"char": "w",
|
|
681
|
+
"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\".",
|
|
682
|
+
"exclusive": [
|
|
683
|
+
"async"
|
|
684
|
+
],
|
|
685
|
+
"name": "wait",
|
|
686
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
687
|
+
"hasDynamicHelp": false,
|
|
688
|
+
"helpValue": "<minutes>",
|
|
689
|
+
"multiple": false,
|
|
690
|
+
"type": "option"
|
|
691
|
+
}
|
|
692
|
+
},
|
|
693
|
+
"hasDynamicHelp": false,
|
|
694
|
+
"hiddenAliases": [],
|
|
695
|
+
"id": "project:deploy:cancel",
|
|
696
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
697
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
698
|
+
"pluginType": "core",
|
|
699
|
+
"strict": true,
|
|
700
|
+
"summary": "Cancel a deploy operation.",
|
|
701
|
+
"enableJsonFlag": true,
|
|
702
|
+
"isESM": true,
|
|
703
|
+
"relativePath": [
|
|
704
|
+
"lib",
|
|
705
|
+
"commands",
|
|
706
|
+
"project",
|
|
707
|
+
"deploy",
|
|
708
|
+
"cancel.js"
|
|
709
|
+
],
|
|
710
|
+
"aliasPermutations": [
|
|
711
|
+
"deploy:metadata:cancel",
|
|
712
|
+
"metadata:deploy:cancel",
|
|
713
|
+
"metadata:cancel:deploy",
|
|
714
|
+
"deploy:cancel:metadata",
|
|
715
|
+
"cancel:deploy:metadata",
|
|
716
|
+
"cancel:metadata:deploy"
|
|
717
|
+
],
|
|
718
|
+
"permutations": [
|
|
719
|
+
"project:deploy:cancel",
|
|
720
|
+
"deploy:project:cancel",
|
|
721
|
+
"deploy:cancel:project",
|
|
722
|
+
"project:cancel:deploy",
|
|
723
|
+
"cancel:project:deploy",
|
|
724
|
+
"cancel:deploy:project"
|
|
725
|
+
]
|
|
726
|
+
},
|
|
727
|
+
"project:deploy:preview": {
|
|
728
|
+
"aliases": [
|
|
729
|
+
"deploy:metadata:preview"
|
|
730
|
+
],
|
|
731
|
+
"args": {},
|
|
732
|
+
"deprecateAliases": true,
|
|
733
|
+
"description": "You must run this command from within a project.\n\nThe command outputs a table that describes what will happen if you run the \"<%= config.bin %> project deploy start\" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.\n\nIf your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
734
|
+
"examples": [
|
|
735
|
+
"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.",
|
|
736
|
+
"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",
|
|
737
|
+
"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",
|
|
738
|
+
"Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
739
|
+
"Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
740
|
+
],
|
|
741
|
+
"flags": {
|
|
742
|
+
"json": {
|
|
743
|
+
"description": "Format output as json.",
|
|
744
|
+
"helpGroup": "GLOBAL",
|
|
745
|
+
"name": "json",
|
|
746
|
+
"allowNo": false,
|
|
747
|
+
"type": "boolean"
|
|
748
|
+
},
|
|
749
|
+
"ignore-conflicts": {
|
|
750
|
+
"char": "c",
|
|
751
|
+
"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.",
|
|
752
|
+
"name": "ignore-conflicts",
|
|
753
|
+
"summary": "Don't display conflicts in preview of the deployment.",
|
|
754
|
+
"allowNo": false,
|
|
755
|
+
"type": "boolean"
|
|
756
|
+
},
|
|
757
|
+
"manifest": {
|
|
758
|
+
"char": "x",
|
|
759
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
760
|
+
"exclusive": [
|
|
761
|
+
"source-dir",
|
|
762
|
+
"metadata"
|
|
763
|
+
],
|
|
764
|
+
"name": "manifest",
|
|
765
|
+
"summary": "Full file path for manifest (package.xml) of components to preview.",
|
|
766
|
+
"hasDynamicHelp": false,
|
|
767
|
+
"multiple": false,
|
|
768
|
+
"type": "option"
|
|
769
|
+
},
|
|
770
|
+
"metadata": {
|
|
771
|
+
"char": "m",
|
|
772
|
+
"exclusive": [
|
|
773
|
+
"manifest",
|
|
774
|
+
"source-dir"
|
|
775
|
+
],
|
|
776
|
+
"name": "metadata",
|
|
777
|
+
"summary": "Metadata component names to preview.",
|
|
778
|
+
"hasDynamicHelp": false,
|
|
779
|
+
"multiple": true,
|
|
780
|
+
"type": "option"
|
|
781
|
+
},
|
|
782
|
+
"source-dir": {
|
|
783
|
+
"char": "d",
|
|
784
|
+
"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.",
|
|
785
|
+
"exclusive": [
|
|
786
|
+
"manifest",
|
|
787
|
+
"metadata"
|
|
788
|
+
],
|
|
789
|
+
"name": "source-dir",
|
|
790
|
+
"summary": "Path to the local source files to preview.",
|
|
791
|
+
"hasDynamicHelp": false,
|
|
792
|
+
"multiple": true,
|
|
793
|
+
"type": "option"
|
|
794
|
+
},
|
|
795
|
+
"target-org": {
|
|
796
|
+
"char": "o",
|
|
797
|
+
"description": "Overrides your default org.",
|
|
798
|
+
"name": "target-org",
|
|
799
|
+
"noCacheDefault": true,
|
|
800
|
+
"required": true,
|
|
801
|
+
"summary": "Login username or alias for the target org.",
|
|
802
|
+
"hasDynamicHelp": true,
|
|
803
|
+
"multiple": false,
|
|
804
|
+
"type": "option"
|
|
805
|
+
},
|
|
806
|
+
"concise": {
|
|
807
|
+
"name": "concise",
|
|
808
|
+
"summary": "Show only the changes that will be deployed; omits files that are forceignored.",
|
|
809
|
+
"allowNo": false,
|
|
810
|
+
"type": "boolean"
|
|
811
|
+
}
|
|
812
|
+
},
|
|
813
|
+
"hasDynamicHelp": true,
|
|
814
|
+
"hiddenAliases": [],
|
|
815
|
+
"id": "project:deploy:preview",
|
|
816
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
817
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
818
|
+
"pluginType": "core",
|
|
819
|
+
"strict": true,
|
|
820
|
+
"summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
|
|
821
|
+
"enableJsonFlag": true,
|
|
822
|
+
"requiresProject": true,
|
|
823
|
+
"isESM": true,
|
|
824
|
+
"relativePath": [
|
|
825
|
+
"lib",
|
|
826
|
+
"commands",
|
|
827
|
+
"project",
|
|
828
|
+
"deploy",
|
|
829
|
+
"preview.js"
|
|
830
|
+
],
|
|
831
|
+
"aliasPermutations": [
|
|
832
|
+
"deploy:metadata:preview",
|
|
833
|
+
"metadata:deploy:preview",
|
|
539
834
|
"metadata:preview:deploy",
|
|
540
835
|
"deploy:preview:metadata",
|
|
541
836
|
"preview:deploy:metadata",
|
|
@@ -813,254 +1108,59 @@
|
|
|
813
1108
|
},
|
|
814
1109
|
"wait": {
|
|
815
1110
|
"char": "w",
|
|
816
|
-
"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\".",
|
|
817
|
-
"name": "wait",
|
|
818
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
819
|
-
"hasDynamicHelp": false,
|
|
820
|
-
"helpValue": "<minutes>",
|
|
821
|
-
"multiple": false,
|
|
822
|
-
"type": "option"
|
|
823
|
-
}
|
|
824
|
-
},
|
|
825
|
-
"hasDynamicHelp": true,
|
|
826
|
-
"hiddenAliases": [],
|
|
827
|
-
"id": "project:deploy:report",
|
|
828
|
-
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
829
|
-
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
830
|
-
"pluginType": "core",
|
|
831
|
-
"strict": true,
|
|
832
|
-
"summary": "Check or poll for the status of a deploy operation.",
|
|
833
|
-
"enableJsonFlag": true,
|
|
834
|
-
"isESM": true,
|
|
835
|
-
"relativePath": [
|
|
836
|
-
"lib",
|
|
837
|
-
"commands",
|
|
838
|
-
"project",
|
|
839
|
-
"deploy",
|
|
840
|
-
"report.js"
|
|
841
|
-
],
|
|
842
|
-
"aliasPermutations": [
|
|
843
|
-
"deploy:metadata:report",
|
|
844
|
-
"metadata:deploy:report",
|
|
845
|
-
"metadata:report:deploy",
|
|
846
|
-
"deploy:report:metadata",
|
|
847
|
-
"report:deploy:metadata",
|
|
848
|
-
"report:metadata:deploy"
|
|
849
|
-
],
|
|
850
|
-
"permutations": [
|
|
851
|
-
"project:deploy:report",
|
|
852
|
-
"deploy:project:report",
|
|
853
|
-
"deploy:report:project",
|
|
854
|
-
"project:report:deploy",
|
|
855
|
-
"report:project:deploy",
|
|
856
|
-
"report:deploy:project"
|
|
857
|
-
]
|
|
858
|
-
},
|
|
859
|
-
"project:deploy:resume": {
|
|
860
|
-
"aliases": [
|
|
861
|
-
"deploy:metadata:resume"
|
|
862
|
-
],
|
|
863
|
-
"args": {},
|
|
864
|
-
"deprecateAliases": true,
|
|
865
|
-
"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.",
|
|
866
|
-
"examples": [
|
|
867
|
-
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
868
|
-
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
869
|
-
],
|
|
870
|
-
"flags": {
|
|
871
|
-
"json": {
|
|
872
|
-
"description": "Format output as json.",
|
|
873
|
-
"helpGroup": "GLOBAL",
|
|
874
|
-
"name": "json",
|
|
875
|
-
"allowNo": false,
|
|
876
|
-
"type": "boolean"
|
|
877
|
-
},
|
|
878
|
-
"concise": {
|
|
879
|
-
"exclusive": [
|
|
880
|
-
"verbose"
|
|
881
|
-
],
|
|
882
|
-
"name": "concise",
|
|
883
|
-
"summary": "Show concise output of the deploy operation result.",
|
|
884
|
-
"allowNo": false,
|
|
885
|
-
"type": "boolean"
|
|
886
|
-
},
|
|
887
|
-
"job-id": {
|
|
888
|
-
"char": "i",
|
|
889
|
-
"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.",
|
|
890
|
-
"name": "job-id",
|
|
891
|
-
"summary": "Job ID of the deploy operation you want to resume.",
|
|
892
|
-
"hasDynamicHelp": false,
|
|
893
|
-
"multiple": false,
|
|
894
|
-
"type": "option"
|
|
895
|
-
},
|
|
896
|
-
"use-most-recent": {
|
|
897
|
-
"char": "r",
|
|
898
|
-
"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.",
|
|
899
|
-
"name": "use-most-recent",
|
|
900
|
-
"summary": "Use the job ID of the most recent deploy operation.",
|
|
901
|
-
"allowNo": false,
|
|
902
|
-
"type": "boolean"
|
|
903
|
-
},
|
|
904
|
-
"verbose": {
|
|
905
|
-
"exclusive": [
|
|
906
|
-
"concise"
|
|
907
|
-
],
|
|
908
|
-
"name": "verbose",
|
|
909
|
-
"summary": "Show verbose output of the deploy operation result.",
|
|
910
|
-
"allowNo": false,
|
|
911
|
-
"type": "boolean"
|
|
912
|
-
},
|
|
913
|
-
"wait": {
|
|
914
|
-
"char": "w",
|
|
915
|
-
"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\".",
|
|
916
|
-
"name": "wait",
|
|
917
|
-
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
918
|
-
"hasDynamicHelp": false,
|
|
919
|
-
"helpValue": "<minutes>",
|
|
920
|
-
"multiple": false,
|
|
921
|
-
"type": "option"
|
|
922
|
-
},
|
|
923
|
-
"coverage-formatters": {
|
|
924
|
-
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
925
|
-
"helpGroup": "Test",
|
|
926
|
-
"name": "coverage-formatters",
|
|
927
|
-
"summary": "Format of the code coverage results.",
|
|
928
|
-
"hasDynamicHelp": false,
|
|
929
|
-
"multiple": true,
|
|
930
|
-
"options": [
|
|
931
|
-
"clover",
|
|
932
|
-
"cobertura",
|
|
933
|
-
"html-spa",
|
|
934
|
-
"html",
|
|
935
|
-
"json",
|
|
936
|
-
"json-summary",
|
|
937
|
-
"lcovonly",
|
|
938
|
-
"none",
|
|
939
|
-
"teamcity",
|
|
940
|
-
"text",
|
|
941
|
-
"text-summary"
|
|
942
|
-
],
|
|
943
|
-
"type": "option"
|
|
944
|
-
},
|
|
945
|
-
"junit": {
|
|
946
|
-
"helpGroup": "Test",
|
|
947
|
-
"name": "junit",
|
|
948
|
-
"summary": "Output JUnit test results.",
|
|
949
|
-
"allowNo": false,
|
|
950
|
-
"type": "boolean"
|
|
951
|
-
},
|
|
952
|
-
"results-dir": {
|
|
953
|
-
"helpGroup": "Test",
|
|
954
|
-
"name": "results-dir",
|
|
955
|
-
"relationships": [
|
|
956
|
-
{
|
|
957
|
-
"type": "some",
|
|
958
|
-
"flags": [
|
|
959
|
-
"coverage-formatters",
|
|
960
|
-
"junit"
|
|
961
|
-
]
|
|
962
|
-
}
|
|
963
|
-
],
|
|
964
|
-
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
965
|
-
"hasDynamicHelp": false,
|
|
966
|
-
"multiple": false,
|
|
967
|
-
"type": "option"
|
|
968
|
-
}
|
|
969
|
-
},
|
|
970
|
-
"hasDynamicHelp": false,
|
|
971
|
-
"hiddenAliases": [],
|
|
972
|
-
"id": "project:deploy:resume",
|
|
973
|
-
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
974
|
-
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
975
|
-
"pluginType": "core",
|
|
976
|
-
"strict": true,
|
|
977
|
-
"summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
|
|
978
|
-
"enableJsonFlag": true,
|
|
979
|
-
"envVariablesSection": {
|
|
980
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
981
|
-
"body": [
|
|
982
|
-
{
|
|
983
|
-
"name": "SF_USE_PROGRESS_BAR",
|
|
984
|
-
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
985
|
-
}
|
|
986
|
-
]
|
|
987
|
-
},
|
|
988
|
-
"errorCodes": {
|
|
989
|
-
"header": "ERROR CODES",
|
|
990
|
-
"body": [
|
|
991
|
-
{
|
|
992
|
-
"name": "Succeeded (0)",
|
|
993
|
-
"description": "The deploy succeeded."
|
|
994
|
-
},
|
|
995
|
-
{
|
|
996
|
-
"name": "Canceled (1)",
|
|
997
|
-
"description": "The deploy was canceled."
|
|
998
|
-
},
|
|
999
|
-
{
|
|
1000
|
-
"name": "Failed (1)",
|
|
1001
|
-
"description": "The deploy failed."
|
|
1002
|
-
},
|
|
1003
|
-
{
|
|
1004
|
-
"name": "SucceededPartial (68)",
|
|
1005
|
-
"description": "The deploy partially succeeded."
|
|
1006
|
-
},
|
|
1007
|
-
{
|
|
1008
|
-
"name": "InProgress (69)",
|
|
1009
|
-
"description": "The deploy is in progress."
|
|
1010
|
-
},
|
|
1011
|
-
{
|
|
1012
|
-
"name": "Pending (69)",
|
|
1013
|
-
"description": "The deploy is pending."
|
|
1014
|
-
},
|
|
1015
|
-
{
|
|
1016
|
-
"name": "Canceling (69)",
|
|
1017
|
-
"description": "The deploy is being canceled."
|
|
1018
|
-
}
|
|
1019
|
-
]
|
|
1111
|
+
"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\".",
|
|
1112
|
+
"name": "wait",
|
|
1113
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1114
|
+
"hasDynamicHelp": false,
|
|
1115
|
+
"helpValue": "<minutes>",
|
|
1116
|
+
"multiple": false,
|
|
1117
|
+
"type": "option"
|
|
1118
|
+
}
|
|
1020
1119
|
},
|
|
1120
|
+
"hasDynamicHelp": true,
|
|
1121
|
+
"hiddenAliases": [],
|
|
1122
|
+
"id": "project:deploy:report",
|
|
1123
|
+
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1124
|
+
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1125
|
+
"pluginType": "core",
|
|
1126
|
+
"strict": true,
|
|
1127
|
+
"summary": "Check or poll for the status of a deploy operation.",
|
|
1128
|
+
"enableJsonFlag": true,
|
|
1021
1129
|
"isESM": true,
|
|
1022
1130
|
"relativePath": [
|
|
1023
1131
|
"lib",
|
|
1024
1132
|
"commands",
|
|
1025
1133
|
"project",
|
|
1026
1134
|
"deploy",
|
|
1027
|
-
"
|
|
1135
|
+
"report.js"
|
|
1028
1136
|
],
|
|
1029
1137
|
"aliasPermutations": [
|
|
1030
|
-
"deploy:metadata:
|
|
1031
|
-
"metadata:deploy:
|
|
1032
|
-
"metadata:
|
|
1033
|
-
"deploy:
|
|
1034
|
-
"
|
|
1035
|
-
"
|
|
1138
|
+
"deploy:metadata:report",
|
|
1139
|
+
"metadata:deploy:report",
|
|
1140
|
+
"metadata:report:deploy",
|
|
1141
|
+
"deploy:report:metadata",
|
|
1142
|
+
"report:deploy:metadata",
|
|
1143
|
+
"report:metadata:deploy"
|
|
1036
1144
|
],
|
|
1037
1145
|
"permutations": [
|
|
1038
|
-
"project:deploy:
|
|
1039
|
-
"deploy:project:
|
|
1040
|
-
"deploy:
|
|
1041
|
-
"project:
|
|
1042
|
-
"
|
|
1043
|
-
"
|
|
1146
|
+
"project:deploy:report",
|
|
1147
|
+
"deploy:project:report",
|
|
1148
|
+
"deploy:report:project",
|
|
1149
|
+
"project:report:deploy",
|
|
1150
|
+
"report:project:deploy",
|
|
1151
|
+
"report:deploy:project"
|
|
1044
1152
|
]
|
|
1045
1153
|
},
|
|
1046
|
-
"project:deploy:
|
|
1154
|
+
"project:deploy:resume": {
|
|
1047
1155
|
"aliases": [
|
|
1048
|
-
"deploy:metadata"
|
|
1156
|
+
"deploy:metadata:resume"
|
|
1049
1157
|
],
|
|
1050
1158
|
"args": {},
|
|
1051
1159
|
"deprecateAliases": true,
|
|
1052
|
-
"description": "
|
|
1160
|
+
"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.",
|
|
1053
1161
|
"examples": [
|
|
1054
|
-
"
|
|
1055
|
-
"
|
|
1056
|
-
"Deploy a specific Apex class and the objects whose source is in a directory (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects",
|
|
1057
|
-
"Deploy all Apex classes:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
1058
|
-
"Deploy a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
1059
|
-
"Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\":\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'",
|
|
1060
|
-
"Deploy all custom objects and Apex classes (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
|
|
1061
|
-
"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\"",
|
|
1062
|
-
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1063
|
-
"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"
|
|
1162
|
+
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
1163
|
+
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1064
1164
|
],
|
|
1065
1165
|
"flags": {
|
|
1066
1166
|
"json": {
|
|
@@ -1070,232 +1170,48 @@
|
|
|
1070
1170
|
"allowNo": false,
|
|
1071
1171
|
"type": "boolean"
|
|
1072
1172
|
},
|
|
1073
|
-
"api-version": {
|
|
1074
|
-
"char": "a",
|
|
1075
|
-
"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.",
|
|
1076
|
-
"name": "api-version",
|
|
1077
|
-
"summary": "Target API version for the deploy.",
|
|
1078
|
-
"hasDynamicHelp": false,
|
|
1079
|
-
"multiple": false,
|
|
1080
|
-
"type": "option"
|
|
1081
|
-
},
|
|
1082
|
-
"async": {
|
|
1083
|
-
"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\".",
|
|
1084
|
-
"exclusive": [
|
|
1085
|
-
"wait"
|
|
1086
|
-
],
|
|
1087
|
-
"name": "async",
|
|
1088
|
-
"summary": "Run the command asynchronously.",
|
|
1089
|
-
"allowNo": false,
|
|
1090
|
-
"type": "boolean"
|
|
1091
|
-
},
|
|
1092
1173
|
"concise": {
|
|
1093
1174
|
"exclusive": [
|
|
1094
1175
|
"verbose"
|
|
1095
1176
|
],
|
|
1096
1177
|
"name": "concise",
|
|
1097
|
-
"summary": "Show concise output of the deploy result.",
|
|
1098
|
-
"allowNo": false,
|
|
1099
|
-
"type": "boolean"
|
|
1100
|
-
},
|
|
1101
|
-
"dry-run": {
|
|
1102
|
-
"name": "dry-run",
|
|
1103
|
-
"summary": "Validate deploy and run Apex tests but don’t save to the org.",
|
|
1104
|
-
"allowNo": false,
|
|
1105
|
-
"type": "boolean"
|
|
1106
|
-
},
|
|
1107
|
-
"ignore-conflicts": {
|
|
1108
|
-
"char": "c",
|
|
1109
|
-
"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.",
|
|
1110
|
-
"name": "ignore-conflicts",
|
|
1111
|
-
"summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
|
|
1112
|
-
"allowNo": false,
|
|
1113
|
-
"type": "boolean"
|
|
1114
|
-
},
|
|
1115
|
-
"ignore-errors": {
|
|
1116
|
-
"char": "r",
|
|
1117
|
-
"description": "When deploying to a production org, keep this flag set to false (default value). When set to true, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
|
|
1118
|
-
"name": "ignore-errors",
|
|
1119
|
-
"summary": "Ignore any errors and don’t roll back deployment.",
|
|
1120
|
-
"allowNo": false,
|
|
1121
|
-
"type": "boolean"
|
|
1122
|
-
},
|
|
1123
|
-
"ignore-warnings": {
|
|
1124
|
-
"char": "g",
|
|
1125
|
-
"description": "If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this flag is set to false, success is set to false, and the warning is treated like an error.",
|
|
1126
|
-
"name": "ignore-warnings",
|
|
1127
|
-
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1178
|
+
"summary": "Show concise output of the deploy operation result.",
|
|
1128
1179
|
"allowNo": false,
|
|
1129
1180
|
"type": "boolean"
|
|
1130
1181
|
},
|
|
1131
|
-
"
|
|
1132
|
-
"char": "
|
|
1133
|
-
"description": "
|
|
1134
|
-
"
|
|
1135
|
-
|
|
1136
|
-
"metadata",
|
|
1137
|
-
"metadata-dir"
|
|
1138
|
-
],
|
|
1139
|
-
"helpGroup": "Source Format",
|
|
1140
|
-
"name": "manifest",
|
|
1141
|
-
"summary": "Full file path for manifest (package.xml) of components to deploy.",
|
|
1142
|
-
"hasDynamicHelp": false,
|
|
1143
|
-
"multiple": false,
|
|
1144
|
-
"type": "option"
|
|
1145
|
-
},
|
|
1146
|
-
"metadata": {
|
|
1147
|
-
"char": "m",
|
|
1148
|
-
"exclusive": [
|
|
1149
|
-
"manifest",
|
|
1150
|
-
"source-dir",
|
|
1151
|
-
"metadata-dir"
|
|
1152
|
-
],
|
|
1153
|
-
"helpGroup": "Source Format",
|
|
1154
|
-
"name": "metadata",
|
|
1155
|
-
"summary": "Metadata component names to deploy. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`",
|
|
1156
|
-
"hasDynamicHelp": false,
|
|
1157
|
-
"multiple": true,
|
|
1158
|
-
"type": "option"
|
|
1159
|
-
},
|
|
1160
|
-
"metadata-dir": {
|
|
1161
|
-
"exclusive": [
|
|
1162
|
-
"manifest",
|
|
1163
|
-
"source-dir",
|
|
1164
|
-
"metadata"
|
|
1165
|
-
],
|
|
1166
|
-
"helpGroup": "Metadata API Format",
|
|
1167
|
-
"name": "metadata-dir",
|
|
1168
|
-
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1182
|
+
"job-id": {
|
|
1183
|
+
"char": "i",
|
|
1184
|
+
"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.",
|
|
1185
|
+
"name": "job-id",
|
|
1186
|
+
"summary": "Job ID of the deploy operation you want to resume.",
|
|
1169
1187
|
"hasDynamicHelp": false,
|
|
1170
1188
|
"multiple": false,
|
|
1171
1189
|
"type": "option"
|
|
1172
1190
|
},
|
|
1173
|
-
"
|
|
1174
|
-
"
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
"
|
|
1178
|
-
"name": "single-package",
|
|
1179
|
-
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1191
|
+
"use-most-recent": {
|
|
1192
|
+
"char": "r",
|
|
1193
|
+
"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.",
|
|
1194
|
+
"name": "use-most-recent",
|
|
1195
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
1180
1196
|
"allowNo": false,
|
|
1181
1197
|
"type": "boolean"
|
|
1182
1198
|
},
|
|
1183
|
-
"source-dir": {
|
|
1184
|
-
"char": "d",
|
|
1185
|
-
"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.",
|
|
1186
|
-
"exclusive": [
|
|
1187
|
-
"manifest",
|
|
1188
|
-
"metadata",
|
|
1189
|
-
"metadata-dir"
|
|
1190
|
-
],
|
|
1191
|
-
"helpGroup": "Source Format",
|
|
1192
|
-
"name": "source-dir",
|
|
1193
|
-
"summary": "Path to the local source files to deploy.",
|
|
1194
|
-
"hasDynamicHelp": false,
|
|
1195
|
-
"multiple": true,
|
|
1196
|
-
"type": "option"
|
|
1197
|
-
},
|
|
1198
|
-
"target-org": {
|
|
1199
|
-
"char": "o",
|
|
1200
|
-
"description": "Overrides your default org.",
|
|
1201
|
-
"name": "target-org",
|
|
1202
|
-
"noCacheDefault": true,
|
|
1203
|
-
"required": true,
|
|
1204
|
-
"summary": "Login username or alias for the target org.",
|
|
1205
|
-
"hasDynamicHelp": true,
|
|
1206
|
-
"multiple": false,
|
|
1207
|
-
"type": "option"
|
|
1208
|
-
},
|
|
1209
|
-
"tests": {
|
|
1210
|
-
"char": "t",
|
|
1211
|
-
"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\"",
|
|
1212
|
-
"helpGroup": "Test",
|
|
1213
|
-
"name": "tests",
|
|
1214
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1215
|
-
"hasDynamicHelp": false,
|
|
1216
|
-
"multiple": true,
|
|
1217
|
-
"type": "option"
|
|
1218
|
-
},
|
|
1219
|
-
"test-level": {
|
|
1220
|
-
"char": "l",
|
|
1221
|
-
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\n If you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
|
|
1222
|
-
"helpGroup": "Test",
|
|
1223
|
-
"name": "test-level",
|
|
1224
|
-
"summary": "Deployment Apex testing level.",
|
|
1225
|
-
"hasDynamicHelp": false,
|
|
1226
|
-
"multiple": false,
|
|
1227
|
-
"options": [
|
|
1228
|
-
"NoTestRun",
|
|
1229
|
-
"RunSpecifiedTests",
|
|
1230
|
-
"RunLocalTests",
|
|
1231
|
-
"RunAllTestsInOrg"
|
|
1232
|
-
],
|
|
1233
|
-
"type": "option"
|
|
1234
|
-
},
|
|
1235
1199
|
"verbose": {
|
|
1236
1200
|
"exclusive": [
|
|
1237
1201
|
"concise"
|
|
1238
1202
|
],
|
|
1239
1203
|
"name": "verbose",
|
|
1240
|
-
"summary": "Show verbose output of the deploy result.",
|
|
1241
|
-
"allowNo": false,
|
|
1242
|
-
"type": "boolean"
|
|
1243
|
-
},
|
|
1244
|
-
"wait": {
|
|
1245
|
-
"char": "w",
|
|
1246
|
-
"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\".",
|
|
1247
|
-
"exclusive": [
|
|
1248
|
-
"async"
|
|
1249
|
-
],
|
|
1250
|
-
"name": "wait",
|
|
1251
|
-
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1252
|
-
"default": {
|
|
1253
|
-
"quantity": 33,
|
|
1254
|
-
"unit": 0
|
|
1255
|
-
},
|
|
1256
|
-
"hasDynamicHelp": false,
|
|
1257
|
-
"helpValue": "<minutes>",
|
|
1258
|
-
"multiple": false,
|
|
1259
|
-
"type": "option"
|
|
1260
|
-
},
|
|
1261
|
-
"purge-on-delete": {
|
|
1262
|
-
"dependsOn": [
|
|
1263
|
-
"manifest"
|
|
1264
|
-
],
|
|
1265
|
-
"helpGroup": "Delete",
|
|
1266
|
-
"name": "purge-on-delete",
|
|
1267
|
-
"relationships": [
|
|
1268
|
-
{
|
|
1269
|
-
"type": "some",
|
|
1270
|
-
"flags": [
|
|
1271
|
-
"pre-destructive-changes",
|
|
1272
|
-
"post-destructive-changes"
|
|
1273
|
-
]
|
|
1274
|
-
}
|
|
1275
|
-
],
|
|
1276
|
-
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1204
|
+
"summary": "Show verbose output of the deploy operation result.",
|
|
1277
1205
|
"allowNo": false,
|
|
1278
1206
|
"type": "boolean"
|
|
1279
1207
|
},
|
|
1280
|
-
"
|
|
1281
|
-
"
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
"
|
|
1285
|
-
"name": "pre-destructive-changes",
|
|
1286
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
1287
|
-
"hasDynamicHelp": false,
|
|
1288
|
-
"multiple": false,
|
|
1289
|
-
"type": "option"
|
|
1290
|
-
},
|
|
1291
|
-
"post-destructive-changes": {
|
|
1292
|
-
"dependsOn": [
|
|
1293
|
-
"manifest"
|
|
1294
|
-
],
|
|
1295
|
-
"helpGroup": "Delete",
|
|
1296
|
-
"name": "post-destructive-changes",
|
|
1297
|
-
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1208
|
+
"wait": {
|
|
1209
|
+
"char": "w",
|
|
1210
|
+
"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\".",
|
|
1211
|
+
"name": "wait",
|
|
1212
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1298
1213
|
"hasDynamicHelp": false,
|
|
1214
|
+
"helpValue": "<minutes>",
|
|
1299
1215
|
"multiple": false,
|
|
1300
1216
|
"type": "option"
|
|
1301
1217
|
},
|
|
@@ -1346,35 +1262,18 @@
|
|
|
1346
1262
|
"type": "option"
|
|
1347
1263
|
}
|
|
1348
1264
|
},
|
|
1349
|
-
"hasDynamicHelp":
|
|
1265
|
+
"hasDynamicHelp": false,
|
|
1350
1266
|
"hiddenAliases": [],
|
|
1351
|
-
"id": "project:deploy:
|
|
1267
|
+
"id": "project:deploy:resume",
|
|
1352
1268
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1353
1269
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1354
1270
|
"pluginType": "core",
|
|
1355
1271
|
"strict": true,
|
|
1356
|
-
"summary": "
|
|
1272
|
+
"summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
|
|
1357
1273
|
"enableJsonFlag": true,
|
|
1358
|
-
"configurationVariablesSection": {
|
|
1359
|
-
"header": "CONFIGURATION VARIABLES",
|
|
1360
|
-
"body": [
|
|
1361
|
-
{
|
|
1362
|
-
"name": "target-org",
|
|
1363
|
-
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1364
|
-
},
|
|
1365
|
-
{
|
|
1366
|
-
"name": "org-api-version",
|
|
1367
|
-
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
1368
|
-
}
|
|
1369
|
-
]
|
|
1370
|
-
},
|
|
1371
1274
|
"envVariablesSection": {
|
|
1372
1275
|
"header": "ENVIRONMENT VARIABLES",
|
|
1373
1276
|
"body": [
|
|
1374
|
-
{
|
|
1375
|
-
"name": "SF_TARGET_ORG",
|
|
1376
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1377
|
-
},
|
|
1378
1277
|
{
|
|
1379
1278
|
"name": "SF_USE_PROGRESS_BAR",
|
|
1380
1279
|
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
@@ -1420,33 +1319,43 @@
|
|
|
1420
1319
|
"commands",
|
|
1421
1320
|
"project",
|
|
1422
1321
|
"deploy",
|
|
1423
|
-
"
|
|
1322
|
+
"resume.js"
|
|
1424
1323
|
],
|
|
1425
1324
|
"aliasPermutations": [
|
|
1426
|
-
"deploy:metadata",
|
|
1427
|
-
"metadata:deploy"
|
|
1325
|
+
"deploy:metadata:resume",
|
|
1326
|
+
"metadata:deploy:resume",
|
|
1327
|
+
"metadata:resume:deploy",
|
|
1328
|
+
"deploy:resume:metadata",
|
|
1329
|
+
"resume:deploy:metadata",
|
|
1330
|
+
"resume:metadata:deploy"
|
|
1428
1331
|
],
|
|
1429
1332
|
"permutations": [
|
|
1430
|
-
"project:deploy:
|
|
1431
|
-
"deploy:project:
|
|
1432
|
-
"deploy:
|
|
1433
|
-
"project:
|
|
1434
|
-
"
|
|
1435
|
-
"
|
|
1333
|
+
"project:deploy:resume",
|
|
1334
|
+
"deploy:project:resume",
|
|
1335
|
+
"deploy:resume:project",
|
|
1336
|
+
"project:resume:deploy",
|
|
1337
|
+
"resume:project:deploy",
|
|
1338
|
+
"resume:deploy:project"
|
|
1436
1339
|
]
|
|
1437
1340
|
},
|
|
1438
|
-
"project:deploy:
|
|
1341
|
+
"project:deploy:start": {
|
|
1439
1342
|
"aliases": [
|
|
1440
|
-
"deploy:metadata
|
|
1343
|
+
"deploy:metadata"
|
|
1441
1344
|
],
|
|
1442
1345
|
"args": {},
|
|
1443
1346
|
"deprecateAliases": true,
|
|
1444
|
-
"description": "
|
|
1347
|
+
"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 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 deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
1445
1348
|
"examples": [
|
|
1446
|
-
"
|
|
1447
|
-
"
|
|
1448
|
-
"
|
|
1449
|
-
"
|
|
1349
|
+
"Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1350
|
+
"Deploy the source files in a directory to an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --source-dir path/to/source --target-org my-scratch",
|
|
1351
|
+
"Deploy a specific Apex class and the objects whose source is in a directory (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects",
|
|
1352
|
+
"Deploy all Apex classes:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
|
|
1353
|
+
"Deploy a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
|
|
1354
|
+
"Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\":\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'",
|
|
1355
|
+
"Deploy all custom objects and Apex classes (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
|
|
1356
|
+
"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\"",
|
|
1357
|
+
"Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
|
|
1358
|
+
"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"
|
|
1450
1359
|
],
|
|
1451
1360
|
"flags": {
|
|
1452
1361
|
"json": {
|
|
@@ -1460,13 +1369,16 @@
|
|
|
1460
1369
|
"char": "a",
|
|
1461
1370
|
"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.",
|
|
1462
1371
|
"name": "api-version",
|
|
1463
|
-
"summary": "Target API version for the
|
|
1372
|
+
"summary": "Target API version for the deploy.",
|
|
1464
1373
|
"hasDynamicHelp": false,
|
|
1465
1374
|
"multiple": false,
|
|
1466
1375
|
"type": "option"
|
|
1467
1376
|
},
|
|
1468
1377
|
"async": {
|
|
1469
|
-
"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
|
|
1378
|
+
"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\".",
|
|
1379
|
+
"exclusive": [
|
|
1380
|
+
"wait"
|
|
1381
|
+
],
|
|
1470
1382
|
"name": "async",
|
|
1471
1383
|
"summary": "Run the command asynchronously.",
|
|
1472
1384
|
"allowNo": false,
|
|
@@ -1477,40 +1389,75 @@
|
|
|
1477
1389
|
"verbose"
|
|
1478
1390
|
],
|
|
1479
1391
|
"name": "concise",
|
|
1480
|
-
"summary": "Show concise output of the
|
|
1392
|
+
"summary": "Show concise output of the deploy result.",
|
|
1393
|
+
"allowNo": false,
|
|
1394
|
+
"type": "boolean"
|
|
1395
|
+
},
|
|
1396
|
+
"dry-run": {
|
|
1397
|
+
"name": "dry-run",
|
|
1398
|
+
"summary": "Validate deploy and run Apex tests but don’t save to the org.",
|
|
1399
|
+
"allowNo": false,
|
|
1400
|
+
"type": "boolean"
|
|
1401
|
+
},
|
|
1402
|
+
"ignore-conflicts": {
|
|
1403
|
+
"char": "c",
|
|
1404
|
+
"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.",
|
|
1405
|
+
"name": "ignore-conflicts",
|
|
1406
|
+
"summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
|
|
1407
|
+
"allowNo": false,
|
|
1408
|
+
"type": "boolean"
|
|
1409
|
+
},
|
|
1410
|
+
"ignore-errors": {
|
|
1411
|
+
"char": "r",
|
|
1412
|
+
"description": "When deploying to a production org, keep this flag set to false (default value). When set to true, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
|
|
1413
|
+
"name": "ignore-errors",
|
|
1414
|
+
"summary": "Ignore any errors and don’t roll back deployment.",
|
|
1415
|
+
"allowNo": false,
|
|
1416
|
+
"type": "boolean"
|
|
1417
|
+
},
|
|
1418
|
+
"ignore-warnings": {
|
|
1419
|
+
"char": "g",
|
|
1420
|
+
"description": "If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this flag is set to false, success is set to false, and the warning is treated like an error.",
|
|
1421
|
+
"name": "ignore-warnings",
|
|
1422
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1481
1423
|
"allowNo": false,
|
|
1482
1424
|
"type": "boolean"
|
|
1483
1425
|
},
|
|
1484
1426
|
"manifest": {
|
|
1485
1427
|
"char": "x",
|
|
1486
1428
|
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1429
|
+
"exclusive": [
|
|
1430
|
+
"source-dir",
|
|
1431
|
+
"metadata",
|
|
1432
|
+
"metadata-dir"
|
|
1433
|
+
],
|
|
1487
1434
|
"helpGroup": "Source Format",
|
|
1488
1435
|
"name": "manifest",
|
|
1489
|
-
"summary": "Full file path for manifest (package.xml) of components to
|
|
1436
|
+
"summary": "Full file path for manifest (package.xml) of components to deploy.",
|
|
1490
1437
|
"hasDynamicHelp": false,
|
|
1491
1438
|
"multiple": false,
|
|
1492
1439
|
"type": "option"
|
|
1493
1440
|
},
|
|
1494
1441
|
"metadata": {
|
|
1495
1442
|
"char": "m",
|
|
1443
|
+
"exclusive": [
|
|
1444
|
+
"manifest",
|
|
1445
|
+
"source-dir",
|
|
1446
|
+
"metadata-dir"
|
|
1447
|
+
],
|
|
1496
1448
|
"helpGroup": "Source Format",
|
|
1497
1449
|
"name": "metadata",
|
|
1498
|
-
"summary": "Metadata component names to
|
|
1499
|
-
"hasDynamicHelp": false,
|
|
1500
|
-
"multiple": true,
|
|
1501
|
-
"type": "option"
|
|
1502
|
-
},
|
|
1503
|
-
"source-dir": {
|
|
1504
|
-
"char": "d",
|
|
1505
|
-
"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.",
|
|
1506
|
-
"helpGroup": "Source Format",
|
|
1507
|
-
"name": "source-dir",
|
|
1508
|
-
"summary": "Path to the local source files to validate for deployment.",
|
|
1450
|
+
"summary": "Metadata component names to deploy. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`",
|
|
1509
1451
|
"hasDynamicHelp": false,
|
|
1510
1452
|
"multiple": true,
|
|
1511
1453
|
"type": "option"
|
|
1512
1454
|
},
|
|
1513
1455
|
"metadata-dir": {
|
|
1456
|
+
"exclusive": [
|
|
1457
|
+
"manifest",
|
|
1458
|
+
"source-dir",
|
|
1459
|
+
"metadata"
|
|
1460
|
+
],
|
|
1514
1461
|
"helpGroup": "Metadata API Format",
|
|
1515
1462
|
"name": "metadata-dir",
|
|
1516
1463
|
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
@@ -1528,6 +1475,21 @@
|
|
|
1528
1475
|
"allowNo": false,
|
|
1529
1476
|
"type": "boolean"
|
|
1530
1477
|
},
|
|
1478
|
+
"source-dir": {
|
|
1479
|
+
"char": "d",
|
|
1480
|
+
"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.",
|
|
1481
|
+
"exclusive": [
|
|
1482
|
+
"manifest",
|
|
1483
|
+
"metadata",
|
|
1484
|
+
"metadata-dir"
|
|
1485
|
+
],
|
|
1486
|
+
"helpGroup": "Source Format",
|
|
1487
|
+
"name": "source-dir",
|
|
1488
|
+
"summary": "Path to the local source files to deploy.",
|
|
1489
|
+
"hasDynamicHelp": false,
|
|
1490
|
+
"multiple": true,
|
|
1491
|
+
"type": "option"
|
|
1492
|
+
},
|
|
1531
1493
|
"target-org": {
|
|
1532
1494
|
"char": "o",
|
|
1533
1495
|
"description": "Overrides your default org.",
|
|
@@ -1551,17 +1513,17 @@
|
|
|
1551
1513
|
},
|
|
1552
1514
|
"test-level": {
|
|
1553
1515
|
"char": "l",
|
|
1554
|
-
"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.",
|
|
1516
|
+
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\n If you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
|
|
1555
1517
|
"helpGroup": "Test",
|
|
1556
1518
|
"name": "test-level",
|
|
1557
1519
|
"summary": "Deployment Apex testing level.",
|
|
1558
|
-
"default": "RunLocalTests",
|
|
1559
1520
|
"hasDynamicHelp": false,
|
|
1560
1521
|
"multiple": false,
|
|
1561
1522
|
"options": [
|
|
1562
|
-
"
|
|
1523
|
+
"NoTestRun",
|
|
1524
|
+
"RunSpecifiedTests",
|
|
1563
1525
|
"RunLocalTests",
|
|
1564
|
-
"
|
|
1526
|
+
"RunAllTestsInOrg"
|
|
1565
1527
|
],
|
|
1566
1528
|
"type": "option"
|
|
1567
1529
|
},
|
|
@@ -1570,15 +1532,18 @@
|
|
|
1570
1532
|
"concise"
|
|
1571
1533
|
],
|
|
1572
1534
|
"name": "verbose",
|
|
1573
|
-
"summary": "Show verbose output of the
|
|
1535
|
+
"summary": "Show verbose output of the deploy result.",
|
|
1574
1536
|
"allowNo": false,
|
|
1575
1537
|
"type": "boolean"
|
|
1576
1538
|
},
|
|
1577
1539
|
"wait": {
|
|
1578
1540
|
"char": "w",
|
|
1579
|
-
"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
|
|
1541
|
+
"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\".",
|
|
1542
|
+
"exclusive": [
|
|
1543
|
+
"async"
|
|
1544
|
+
],
|
|
1580
1545
|
"name": "wait",
|
|
1581
|
-
"summary": "Number of minutes to wait for
|
|
1546
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
1582
1547
|
"default": {
|
|
1583
1548
|
"quantity": 33,
|
|
1584
1549
|
"unit": 0
|
|
@@ -1588,14 +1553,47 @@
|
|
|
1588
1553
|
"multiple": false,
|
|
1589
1554
|
"type": "option"
|
|
1590
1555
|
},
|
|
1591
|
-
"
|
|
1592
|
-
"
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
"
|
|
1556
|
+
"purge-on-delete": {
|
|
1557
|
+
"dependsOn": [
|
|
1558
|
+
"manifest"
|
|
1559
|
+
],
|
|
1560
|
+
"helpGroup": "Delete",
|
|
1561
|
+
"name": "purge-on-delete",
|
|
1562
|
+
"relationships": [
|
|
1563
|
+
{
|
|
1564
|
+
"type": "some",
|
|
1565
|
+
"flags": [
|
|
1566
|
+
"pre-destructive-changes",
|
|
1567
|
+
"post-destructive-changes"
|
|
1568
|
+
]
|
|
1569
|
+
}
|
|
1570
|
+
],
|
|
1571
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1596
1572
|
"allowNo": false,
|
|
1597
1573
|
"type": "boolean"
|
|
1598
1574
|
},
|
|
1575
|
+
"pre-destructive-changes": {
|
|
1576
|
+
"dependsOn": [
|
|
1577
|
+
"manifest"
|
|
1578
|
+
],
|
|
1579
|
+
"helpGroup": "Delete",
|
|
1580
|
+
"name": "pre-destructive-changes",
|
|
1581
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
1582
|
+
"hasDynamicHelp": false,
|
|
1583
|
+
"multiple": false,
|
|
1584
|
+
"type": "option"
|
|
1585
|
+
},
|
|
1586
|
+
"post-destructive-changes": {
|
|
1587
|
+
"dependsOn": [
|
|
1588
|
+
"manifest"
|
|
1589
|
+
],
|
|
1590
|
+
"helpGroup": "Delete",
|
|
1591
|
+
"name": "post-destructive-changes",
|
|
1592
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1593
|
+
"hasDynamicHelp": false,
|
|
1594
|
+
"multiple": false,
|
|
1595
|
+
"type": "option"
|
|
1596
|
+
},
|
|
1599
1597
|
"coverage-formatters": {
|
|
1600
1598
|
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1601
1599
|
"helpGroup": "Test",
|
|
@@ -1625,60 +1623,19 @@
|
|
|
1625
1623
|
"allowNo": false,
|
|
1626
1624
|
"type": "boolean"
|
|
1627
1625
|
},
|
|
1628
|
-
"results-dir": {
|
|
1629
|
-
"helpGroup": "Test",
|
|
1630
|
-
"name": "results-dir",
|
|
1631
|
-
"relationships": [
|
|
1632
|
-
{
|
|
1633
|
-
"type": "some",
|
|
1634
|
-
"flags": [
|
|
1635
|
-
"coverage-formatters",
|
|
1636
|
-
"junit"
|
|
1637
|
-
]
|
|
1638
|
-
}
|
|
1639
|
-
],
|
|
1640
|
-
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
1641
|
-
"hasDynamicHelp": false,
|
|
1642
|
-
"multiple": false,
|
|
1643
|
-
"type": "option"
|
|
1644
|
-
},
|
|
1645
|
-
"purge-on-delete": {
|
|
1646
|
-
"dependsOn": [
|
|
1647
|
-
"manifest"
|
|
1648
|
-
],
|
|
1649
|
-
"helpGroup": "Delete",
|
|
1650
|
-
"name": "purge-on-delete",
|
|
1626
|
+
"results-dir": {
|
|
1627
|
+
"helpGroup": "Test",
|
|
1628
|
+
"name": "results-dir",
|
|
1651
1629
|
"relationships": [
|
|
1652
1630
|
{
|
|
1653
1631
|
"type": "some",
|
|
1654
1632
|
"flags": [
|
|
1655
|
-
"
|
|
1656
|
-
"
|
|
1633
|
+
"coverage-formatters",
|
|
1634
|
+
"junit"
|
|
1657
1635
|
]
|
|
1658
1636
|
}
|
|
1659
1637
|
],
|
|
1660
|
-
"summary": "
|
|
1661
|
-
"allowNo": false,
|
|
1662
|
-
"type": "boolean"
|
|
1663
|
-
},
|
|
1664
|
-
"pre-destructive-changes": {
|
|
1665
|
-
"dependsOn": [
|
|
1666
|
-
"manifest"
|
|
1667
|
-
],
|
|
1668
|
-
"helpGroup": "Delete",
|
|
1669
|
-
"name": "pre-destructive-changes",
|
|
1670
|
-
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
1671
|
-
"hasDynamicHelp": false,
|
|
1672
|
-
"multiple": false,
|
|
1673
|
-
"type": "option"
|
|
1674
|
-
},
|
|
1675
|
-
"post-destructive-changes": {
|
|
1676
|
-
"dependsOn": [
|
|
1677
|
-
"manifest"
|
|
1678
|
-
],
|
|
1679
|
-
"helpGroup": "Delete",
|
|
1680
|
-
"name": "post-destructive-changes",
|
|
1681
|
-
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
1638
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
1682
1639
|
"hasDynamicHelp": false,
|
|
1683
1640
|
"multiple": false,
|
|
1684
1641
|
"type": "option"
|
|
@@ -1686,12 +1643,12 @@
|
|
|
1686
1643
|
},
|
|
1687
1644
|
"hasDynamicHelp": true,
|
|
1688
1645
|
"hiddenAliases": [],
|
|
1689
|
-
"id": "project:deploy:
|
|
1646
|
+
"id": "project:deploy:start",
|
|
1690
1647
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1691
1648
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1692
1649
|
"pluginType": "core",
|
|
1693
1650
|
"strict": true,
|
|
1694
|
-
"summary": "
|
|
1651
|
+
"summary": "Deploy metadata to an org from your local project.",
|
|
1695
1652
|
"enableJsonFlag": true,
|
|
1696
1653
|
"configurationVariablesSection": {
|
|
1697
1654
|
"header": "CONFIGURATION VARIABLES",
|
|
@@ -1758,35 +1715,33 @@
|
|
|
1758
1715
|
"commands",
|
|
1759
1716
|
"project",
|
|
1760
1717
|
"deploy",
|
|
1761
|
-
"
|
|
1718
|
+
"start.js"
|
|
1762
1719
|
],
|
|
1763
1720
|
"aliasPermutations": [
|
|
1764
|
-
"deploy:metadata
|
|
1765
|
-
"metadata:deploy
|
|
1766
|
-
"metadata:validate:deploy",
|
|
1767
|
-
"deploy:validate:metadata",
|
|
1768
|
-
"validate:deploy:metadata",
|
|
1769
|
-
"validate:metadata:deploy"
|
|
1721
|
+
"deploy:metadata",
|
|
1722
|
+
"metadata:deploy"
|
|
1770
1723
|
],
|
|
1771
1724
|
"permutations": [
|
|
1772
|
-
"project:deploy:
|
|
1773
|
-
"deploy:project:
|
|
1774
|
-
"deploy:
|
|
1775
|
-
"project:
|
|
1776
|
-
"
|
|
1777
|
-
"
|
|
1725
|
+
"project:deploy:start",
|
|
1726
|
+
"deploy:project:start",
|
|
1727
|
+
"deploy:start:project",
|
|
1728
|
+
"project:start:deploy",
|
|
1729
|
+
"start:project:deploy",
|
|
1730
|
+
"start:deploy:project"
|
|
1778
1731
|
]
|
|
1779
1732
|
},
|
|
1780
|
-
"project:
|
|
1733
|
+
"project:deploy:validate": {
|
|
1781
1734
|
"aliases": [
|
|
1782
|
-
"
|
|
1735
|
+
"deploy:metadata:validate"
|
|
1783
1736
|
],
|
|
1784
1737
|
"args": {},
|
|
1785
1738
|
"deprecateAliases": true,
|
|
1786
|
-
"description": "
|
|
1739
|
+
"description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"<%= config.bin %> project deploy start\", except you're required to run Apex tests, and the command returns a job ID rather than executing the deployment. If the validation succeeds, then you pass this job ID to the \"<%= config.bin %> project deploy quick\" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests. The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nYou must run this command from within a project.\n\nThis command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.\n\nTo validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
|
|
1787
1740
|
"examples": [
|
|
1788
|
-
"
|
|
1789
|
-
"
|
|
1741
|
+
"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.",
|
|
1742
|
+
"Validate the deployment of all source files in a directory to the default org:\n<%= config.bin %> <%= command.id %> --source-dir path/to/source",
|
|
1743
|
+
"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 path/to/source --async --test-level RunAllTestsInOrg --target-org my-prod-org",
|
|
1744
|
+
"Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
|
|
1790
1745
|
],
|
|
1791
1746
|
"flags": {
|
|
1792
1747
|
"json": {
|
|
@@ -1797,279 +1752,324 @@
|
|
|
1797
1752
|
"type": "boolean"
|
|
1798
1753
|
},
|
|
1799
1754
|
"api-version": {
|
|
1800
|
-
"
|
|
1801
|
-
|
|
1802
|
-
],
|
|
1803
|
-
"deprecateAliases": true,
|
|
1804
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1755
|
+
"char": "a",
|
|
1756
|
+
"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.",
|
|
1805
1757
|
"name": "api-version",
|
|
1758
|
+
"summary": "Target API version for the validation.",
|
|
1806
1759
|
"hasDynamicHelp": false,
|
|
1807
1760
|
"multiple": false,
|
|
1808
1761
|
"type": "option"
|
|
1809
1762
|
},
|
|
1810
|
-
"
|
|
1811
|
-
"
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
"
|
|
1815
|
-
"
|
|
1816
|
-
"hasDynamicHelp": false,
|
|
1817
|
-
"multiple": false,
|
|
1818
|
-
"type": "option"
|
|
1763
|
+
"async": {
|
|
1764
|
+
"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\".",
|
|
1765
|
+
"name": "async",
|
|
1766
|
+
"summary": "Run the command asynchronously.",
|
|
1767
|
+
"allowNo": false,
|
|
1768
|
+
"type": "boolean"
|
|
1819
1769
|
},
|
|
1820
|
-
"
|
|
1821
|
-
"
|
|
1822
|
-
"
|
|
1770
|
+
"concise": {
|
|
1771
|
+
"exclusive": [
|
|
1772
|
+
"verbose"
|
|
1823
1773
|
],
|
|
1824
|
-
"
|
|
1825
|
-
"
|
|
1826
|
-
"
|
|
1827
|
-
"
|
|
1828
|
-
|
|
1774
|
+
"name": "concise",
|
|
1775
|
+
"summary": "Show concise output of the validation result.",
|
|
1776
|
+
"allowNo": false,
|
|
1777
|
+
"type": "boolean"
|
|
1778
|
+
},
|
|
1779
|
+
"manifest": {
|
|
1780
|
+
"char": "x",
|
|
1781
|
+
"description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
|
|
1782
|
+
"helpGroup": "Source Format",
|
|
1783
|
+
"name": "manifest",
|
|
1784
|
+
"summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
|
|
1829
1785
|
"hasDynamicHelp": false,
|
|
1830
1786
|
"multiple": false,
|
|
1831
1787
|
"type": "option"
|
|
1832
1788
|
},
|
|
1833
|
-
"
|
|
1834
|
-
"
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
"
|
|
1838
|
-
"deprecateAliases": true,
|
|
1839
|
-
"name": "output-dir",
|
|
1840
|
-
"summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
|
|
1789
|
+
"metadata": {
|
|
1790
|
+
"char": "m",
|
|
1791
|
+
"helpGroup": "Source Format",
|
|
1792
|
+
"name": "metadata",
|
|
1793
|
+
"summary": "Metadata component names to validate for deployment.",
|
|
1841
1794
|
"hasDynamicHelp": false,
|
|
1842
|
-
"multiple":
|
|
1795
|
+
"multiple": true,
|
|
1843
1796
|
"type": "option"
|
|
1844
1797
|
},
|
|
1845
|
-
"
|
|
1846
|
-
"char": "
|
|
1847
|
-
"description": "
|
|
1848
|
-
"
|
|
1849
|
-
"
|
|
1798
|
+
"source-dir": {
|
|
1799
|
+
"char": "d",
|
|
1800
|
+
"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.",
|
|
1801
|
+
"helpGroup": "Source Format",
|
|
1802
|
+
"name": "source-dir",
|
|
1803
|
+
"summary": "Path to the local source files to validate for deployment.",
|
|
1850
1804
|
"hasDynamicHelp": false,
|
|
1851
|
-
"multiple":
|
|
1805
|
+
"multiple": true,
|
|
1852
1806
|
"type": "option"
|
|
1853
1807
|
},
|
|
1854
1808
|
"metadata-dir": {
|
|
1855
|
-
"
|
|
1856
|
-
"metadatapath"
|
|
1857
|
-
],
|
|
1858
|
-
"char": "p",
|
|
1859
|
-
"deprecateAliases": true,
|
|
1860
|
-
"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.",
|
|
1861
|
-
"exclusive": [
|
|
1862
|
-
"manifest",
|
|
1863
|
-
"metadata"
|
|
1864
|
-
],
|
|
1809
|
+
"helpGroup": "Metadata API Format",
|
|
1865
1810
|
"name": "metadata-dir",
|
|
1866
|
-
"summary": "Root of directory or zip file of metadata formatted files to
|
|
1867
|
-
"delimiter": ",",
|
|
1811
|
+
"summary": "Root of directory or zip file of metadata formatted files to deploy.",
|
|
1868
1812
|
"hasDynamicHelp": false,
|
|
1869
|
-
"multiple":
|
|
1813
|
+
"multiple": false,
|
|
1870
1814
|
"type": "option"
|
|
1871
1815
|
},
|
|
1872
|
-
"
|
|
1873
|
-
"
|
|
1874
|
-
|
|
1875
|
-
"manifest",
|
|
1876
|
-
"metadatapath"
|
|
1816
|
+
"single-package": {
|
|
1817
|
+
"dependsOn": [
|
|
1818
|
+
"metadata-dir"
|
|
1877
1819
|
],
|
|
1878
|
-
"
|
|
1879
|
-
"
|
|
1880
|
-
"
|
|
1881
|
-
"hasDynamicHelp": false,
|
|
1882
|
-
"multiple": true,
|
|
1883
|
-
"type": "option"
|
|
1884
|
-
}
|
|
1885
|
-
},
|
|
1886
|
-
"hasDynamicHelp": false,
|
|
1887
|
-
"hiddenAliases": [],
|
|
1888
|
-
"id": "project:convert:mdapi",
|
|
1889
|
-
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
1890
|
-
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
1891
|
-
"pluginType": "core",
|
|
1892
|
-
"strict": true,
|
|
1893
|
-
"summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
|
|
1894
|
-
"enableJsonFlag": true,
|
|
1895
|
-
"requiresProject": true,
|
|
1896
|
-
"isESM": true,
|
|
1897
|
-
"relativePath": [
|
|
1898
|
-
"lib",
|
|
1899
|
-
"commands",
|
|
1900
|
-
"project",
|
|
1901
|
-
"convert",
|
|
1902
|
-
"mdapi.js"
|
|
1903
|
-
],
|
|
1904
|
-
"aliasPermutations": [
|
|
1905
|
-
"force:mdapi:convert",
|
|
1906
|
-
"mdapi:force:convert",
|
|
1907
|
-
"mdapi:convert:force",
|
|
1908
|
-
"force:convert:mdapi",
|
|
1909
|
-
"convert:force:mdapi",
|
|
1910
|
-
"convert:mdapi:force"
|
|
1911
|
-
],
|
|
1912
|
-
"permutations": [
|
|
1913
|
-
"project:convert:mdapi",
|
|
1914
|
-
"convert:project:mdapi",
|
|
1915
|
-
"convert:mdapi:project",
|
|
1916
|
-
"project:mdapi:convert",
|
|
1917
|
-
"mdapi:project:convert",
|
|
1918
|
-
"mdapi:convert:project"
|
|
1919
|
-
]
|
|
1920
|
-
},
|
|
1921
|
-
"project:convert:source": {
|
|
1922
|
-
"aliases": [
|
|
1923
|
-
"force:source:convert"
|
|
1924
|
-
],
|
|
1925
|
-
"args": {},
|
|
1926
|
-
"deprecateAliases": true,
|
|
1927
|
-
"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 --manifest and --source-dir.",
|
|
1928
|
-
"examples": [
|
|
1929
|
-
"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",
|
|
1930
|
-
"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'"
|
|
1931
|
-
],
|
|
1932
|
-
"flags": {
|
|
1933
|
-
"json": {
|
|
1934
|
-
"description": "Format output as json.",
|
|
1935
|
-
"helpGroup": "GLOBAL",
|
|
1936
|
-
"name": "json",
|
|
1820
|
+
"helpGroup": "Metadata API Format",
|
|
1821
|
+
"name": "single-package",
|
|
1822
|
+
"summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
|
|
1937
1823
|
"allowNo": false,
|
|
1938
1824
|
"type": "boolean"
|
|
1939
1825
|
},
|
|
1940
|
-
"
|
|
1941
|
-
"
|
|
1942
|
-
|
|
1943
|
-
|
|
1944
|
-
"
|
|
1945
|
-
"
|
|
1946
|
-
"
|
|
1947
|
-
"
|
|
1948
|
-
"hasDynamicHelp": false,
|
|
1826
|
+
"target-org": {
|
|
1827
|
+
"char": "o",
|
|
1828
|
+
"description": "Overrides your default org.",
|
|
1829
|
+
"name": "target-org",
|
|
1830
|
+
"noCacheDefault": true,
|
|
1831
|
+
"required": true,
|
|
1832
|
+
"summary": "Login username or alias for the target org.",
|
|
1833
|
+
"hasDynamicHelp": true,
|
|
1949
1834
|
"multiple": false,
|
|
1950
1835
|
"type": "option"
|
|
1951
1836
|
},
|
|
1952
|
-
"
|
|
1953
|
-
"
|
|
1954
|
-
|
|
1955
|
-
|
|
1956
|
-
"
|
|
1957
|
-
"
|
|
1837
|
+
"tests": {
|
|
1838
|
+
"char": "t",
|
|
1839
|
+
"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\"",
|
|
1840
|
+
"helpGroup": "Test",
|
|
1841
|
+
"name": "tests",
|
|
1842
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
1958
1843
|
"hasDynamicHelp": false,
|
|
1959
|
-
"multiple":
|
|
1844
|
+
"multiple": true,
|
|
1960
1845
|
"type": "option"
|
|
1961
1846
|
},
|
|
1962
|
-
"
|
|
1963
|
-
"
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
"
|
|
1967
|
-
"
|
|
1968
|
-
"
|
|
1969
|
-
"summary": "Source directory other than the default package to convert.",
|
|
1847
|
+
"test-level": {
|
|
1848
|
+
"char": "l",
|
|
1849
|
+
"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.",
|
|
1850
|
+
"helpGroup": "Test",
|
|
1851
|
+
"name": "test-level",
|
|
1852
|
+
"summary": "Deployment Apex testing level.",
|
|
1853
|
+
"default": "RunLocalTests",
|
|
1970
1854
|
"hasDynamicHelp": false,
|
|
1971
1855
|
"multiple": false,
|
|
1856
|
+
"options": [
|
|
1857
|
+
"RunAllTestsInOrg",
|
|
1858
|
+
"RunLocalTests",
|
|
1859
|
+
"RunSpecifiedTests"
|
|
1860
|
+
],
|
|
1972
1861
|
"type": "option"
|
|
1973
1862
|
},
|
|
1974
|
-
"
|
|
1975
|
-
"
|
|
1976
|
-
"
|
|
1863
|
+
"verbose": {
|
|
1864
|
+
"exclusive": [
|
|
1865
|
+
"concise"
|
|
1977
1866
|
],
|
|
1978
|
-
"
|
|
1979
|
-
"
|
|
1980
|
-
"
|
|
1981
|
-
"
|
|
1982
|
-
|
|
1867
|
+
"name": "verbose",
|
|
1868
|
+
"summary": "Show verbose output of the validation result.",
|
|
1869
|
+
"allowNo": false,
|
|
1870
|
+
"type": "boolean"
|
|
1871
|
+
},
|
|
1872
|
+
"wait": {
|
|
1873
|
+
"char": "w",
|
|
1874
|
+
"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\".",
|
|
1875
|
+
"name": "wait",
|
|
1876
|
+
"summary": "Number of minutes to wait for the command to complete and display results.",
|
|
1877
|
+
"default": {
|
|
1878
|
+
"quantity": 33,
|
|
1879
|
+
"unit": 0
|
|
1880
|
+
},
|
|
1983
1881
|
"hasDynamicHelp": false,
|
|
1882
|
+
"helpValue": "<minutes>",
|
|
1984
1883
|
"multiple": false,
|
|
1985
1884
|
"type": "option"
|
|
1986
1885
|
},
|
|
1987
|
-
"
|
|
1988
|
-
"
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
"
|
|
1992
|
-
"
|
|
1993
|
-
"
|
|
1994
|
-
|
|
1886
|
+
"ignore-warnings": {
|
|
1887
|
+
"char": "g",
|
|
1888
|
+
"description": "If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this flag is set to false, success is set to false, and the warning is treated like an error.",
|
|
1889
|
+
"name": "ignore-warnings",
|
|
1890
|
+
"summary": "Ignore warnings and allow a deployment to complete successfully.",
|
|
1891
|
+
"allowNo": false,
|
|
1892
|
+
"type": "boolean"
|
|
1893
|
+
},
|
|
1894
|
+
"coverage-formatters": {
|
|
1895
|
+
"description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
|
|
1896
|
+
"helpGroup": "Test",
|
|
1897
|
+
"name": "coverage-formatters",
|
|
1898
|
+
"summary": "Format of the code coverage results.",
|
|
1995
1899
|
"hasDynamicHelp": false,
|
|
1996
|
-
"multiple":
|
|
1900
|
+
"multiple": true,
|
|
1901
|
+
"options": [
|
|
1902
|
+
"clover",
|
|
1903
|
+
"cobertura",
|
|
1904
|
+
"html-spa",
|
|
1905
|
+
"html",
|
|
1906
|
+
"json",
|
|
1907
|
+
"json-summary",
|
|
1908
|
+
"lcovonly",
|
|
1909
|
+
"none",
|
|
1910
|
+
"teamcity",
|
|
1911
|
+
"text",
|
|
1912
|
+
"text-summary"
|
|
1913
|
+
],
|
|
1997
1914
|
"type": "option"
|
|
1998
1915
|
},
|
|
1999
|
-
"
|
|
2000
|
-
"
|
|
2001
|
-
"
|
|
2002
|
-
"
|
|
2003
|
-
"
|
|
1916
|
+
"junit": {
|
|
1917
|
+
"helpGroup": "Test",
|
|
1918
|
+
"name": "junit",
|
|
1919
|
+
"summary": "Output JUnit test results.",
|
|
1920
|
+
"allowNo": false,
|
|
1921
|
+
"type": "boolean"
|
|
1922
|
+
},
|
|
1923
|
+
"results-dir": {
|
|
1924
|
+
"helpGroup": "Test",
|
|
1925
|
+
"name": "results-dir",
|
|
1926
|
+
"relationships": [
|
|
1927
|
+
{
|
|
1928
|
+
"type": "some",
|
|
1929
|
+
"flags": [
|
|
1930
|
+
"coverage-formatters",
|
|
1931
|
+
"junit"
|
|
1932
|
+
]
|
|
1933
|
+
}
|
|
1934
|
+
],
|
|
1935
|
+
"summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
|
|
2004
1936
|
"hasDynamicHelp": false,
|
|
2005
1937
|
"multiple": false,
|
|
2006
1938
|
"type": "option"
|
|
2007
1939
|
},
|
|
2008
|
-
"
|
|
2009
|
-
"
|
|
2010
|
-
"
|
|
1940
|
+
"purge-on-delete": {
|
|
1941
|
+
"dependsOn": [
|
|
1942
|
+
"manifest"
|
|
2011
1943
|
],
|
|
2012
|
-
"
|
|
2013
|
-
"
|
|
2014
|
-
"
|
|
2015
|
-
|
|
2016
|
-
|
|
2017
|
-
|
|
1944
|
+
"helpGroup": "Delete",
|
|
1945
|
+
"name": "purge-on-delete",
|
|
1946
|
+
"relationships": [
|
|
1947
|
+
{
|
|
1948
|
+
"type": "some",
|
|
1949
|
+
"flags": [
|
|
1950
|
+
"pre-destructive-changes",
|
|
1951
|
+
"post-destructive-changes"
|
|
1952
|
+
]
|
|
1953
|
+
}
|
|
2018
1954
|
],
|
|
2019
|
-
"
|
|
2020
|
-
"
|
|
2021
|
-
"
|
|
1955
|
+
"summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
|
|
1956
|
+
"allowNo": false,
|
|
1957
|
+
"type": "boolean"
|
|
1958
|
+
},
|
|
1959
|
+
"pre-destructive-changes": {
|
|
1960
|
+
"dependsOn": [
|
|
1961
|
+
"manifest"
|
|
1962
|
+
],
|
|
1963
|
+
"helpGroup": "Delete",
|
|
1964
|
+
"name": "pre-destructive-changes",
|
|
1965
|
+
"summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
|
|
2022
1966
|
"hasDynamicHelp": false,
|
|
2023
|
-
"multiple":
|
|
1967
|
+
"multiple": false,
|
|
2024
1968
|
"type": "option"
|
|
2025
1969
|
},
|
|
2026
|
-
"
|
|
2027
|
-
"
|
|
2028
|
-
|
|
2029
|
-
"manifest",
|
|
2030
|
-
"sourcepath"
|
|
1970
|
+
"post-destructive-changes": {
|
|
1971
|
+
"dependsOn": [
|
|
1972
|
+
"manifest"
|
|
2031
1973
|
],
|
|
2032
|
-
"
|
|
2033
|
-
"
|
|
2034
|
-
"
|
|
1974
|
+
"helpGroup": "Delete",
|
|
1975
|
+
"name": "post-destructive-changes",
|
|
1976
|
+
"summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
|
|
2035
1977
|
"hasDynamicHelp": false,
|
|
2036
|
-
"multiple":
|
|
1978
|
+
"multiple": false,
|
|
2037
1979
|
"type": "option"
|
|
2038
1980
|
}
|
|
2039
1981
|
},
|
|
2040
|
-
"hasDynamicHelp":
|
|
1982
|
+
"hasDynamicHelp": true,
|
|
2041
1983
|
"hiddenAliases": [],
|
|
2042
|
-
"id": "project:
|
|
1984
|
+
"id": "project:deploy:validate",
|
|
2043
1985
|
"pluginAlias": "@salesforce/plugin-deploy-retrieve",
|
|
2044
1986
|
"pluginName": "@salesforce/plugin-deploy-retrieve",
|
|
2045
1987
|
"pluginType": "core",
|
|
2046
1988
|
"strict": true,
|
|
2047
|
-
"summary": "
|
|
1989
|
+
"summary": "Validate a metadata deployment without actually executing it.",
|
|
2048
1990
|
"enableJsonFlag": true,
|
|
2049
|
-
"
|
|
1991
|
+
"configurationVariablesSection": {
|
|
1992
|
+
"header": "CONFIGURATION VARIABLES",
|
|
1993
|
+
"body": [
|
|
1994
|
+
{
|
|
1995
|
+
"name": "target-org",
|
|
1996
|
+
"description": "Username or alias of the org that all commands run against by default. (sf only)"
|
|
1997
|
+
},
|
|
1998
|
+
{
|
|
1999
|
+
"name": "org-api-version",
|
|
2000
|
+
"description": "API version of your project. Default: API version of your Dev Hub org."
|
|
2001
|
+
}
|
|
2002
|
+
]
|
|
2003
|
+
},
|
|
2004
|
+
"envVariablesSection": {
|
|
2005
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2006
|
+
"body": [
|
|
2007
|
+
{
|
|
2008
|
+
"name": "SF_TARGET_ORG",
|
|
2009
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2010
|
+
},
|
|
2011
|
+
{
|
|
2012
|
+
"name": "SF_USE_PROGRESS_BAR",
|
|
2013
|
+
"description": "Set to false to disable the progress bar when running the metadata deploy command."
|
|
2014
|
+
}
|
|
2015
|
+
]
|
|
2016
|
+
},
|
|
2017
|
+
"errorCodes": {
|
|
2018
|
+
"header": "ERROR CODES",
|
|
2019
|
+
"body": [
|
|
2020
|
+
{
|
|
2021
|
+
"name": "Succeeded (0)",
|
|
2022
|
+
"description": "The deploy succeeded."
|
|
2023
|
+
},
|
|
2024
|
+
{
|
|
2025
|
+
"name": "Canceled (1)",
|
|
2026
|
+
"description": "The deploy was canceled."
|
|
2027
|
+
},
|
|
2028
|
+
{
|
|
2029
|
+
"name": "Failed (1)",
|
|
2030
|
+
"description": "The deploy failed."
|
|
2031
|
+
},
|
|
2032
|
+
{
|
|
2033
|
+
"name": "SucceededPartial (68)",
|
|
2034
|
+
"description": "The deploy partially succeeded."
|
|
2035
|
+
},
|
|
2036
|
+
{
|
|
2037
|
+
"name": "InProgress (69)",
|
|
2038
|
+
"description": "The deploy is in progress."
|
|
2039
|
+
},
|
|
2040
|
+
{
|
|
2041
|
+
"name": "Pending (69)",
|
|
2042
|
+
"description": "The deploy is pending."
|
|
2043
|
+
},
|
|
2044
|
+
{
|
|
2045
|
+
"name": "Canceling (69)",
|
|
2046
|
+
"description": "The deploy is being canceled."
|
|
2047
|
+
}
|
|
2048
|
+
]
|
|
2049
|
+
},
|
|
2050
2050
|
"isESM": true,
|
|
2051
2051
|
"relativePath": [
|
|
2052
2052
|
"lib",
|
|
2053
2053
|
"commands",
|
|
2054
2054
|
"project",
|
|
2055
|
-
"
|
|
2056
|
-
"
|
|
2055
|
+
"deploy",
|
|
2056
|
+
"validate.js"
|
|
2057
2057
|
],
|
|
2058
2058
|
"aliasPermutations": [
|
|
2059
|
-
"
|
|
2060
|
-
"
|
|
2061
|
-
"
|
|
2062
|
-
"
|
|
2063
|
-
"
|
|
2064
|
-
"
|
|
2059
|
+
"deploy:metadata:validate",
|
|
2060
|
+
"metadata:deploy:validate",
|
|
2061
|
+
"metadata:validate:deploy",
|
|
2062
|
+
"deploy:validate:metadata",
|
|
2063
|
+
"validate:deploy:metadata",
|
|
2064
|
+
"validate:metadata:deploy"
|
|
2065
2065
|
],
|
|
2066
2066
|
"permutations": [
|
|
2067
|
-
"project:
|
|
2068
|
-
"
|
|
2069
|
-
"
|
|
2070
|
-
"project:
|
|
2071
|
-
"
|
|
2072
|
-
"
|
|
2067
|
+
"project:deploy:validate",
|
|
2068
|
+
"deploy:project:validate",
|
|
2069
|
+
"deploy:validate:project",
|
|
2070
|
+
"project:validate:deploy",
|
|
2071
|
+
"validate:project:deploy",
|
|
2072
|
+
"validate:deploy:project"
|
|
2073
2073
|
]
|
|
2074
2074
|
},
|
|
2075
2075
|
"project:generate:manifest": {
|
|
@@ -2815,5 +2815,5 @@
|
|
|
2815
2815
|
]
|
|
2816
2816
|
}
|
|
2817
2817
|
},
|
|
2818
|
-
"version": "3.2.
|
|
2818
|
+
"version": "3.2.9"
|
|
2819
2819
|
}
|