@salesforce/plugin-deploy-retrieve 1.8.6 → 1.8.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/commands/deploy.d.ts +5 -0
- package/lib/commands/deploy.js +5 -0
- package/lib/commands/deploy.js.map +1 -1
- package/lib/commands/project/convert/mdapi.d.ts +32 -0
- package/lib/commands/project/convert/mdapi.js +170 -0
- package/lib/commands/project/convert/mdapi.js.map +1 -0
- package/lib/commands/project/convert/source.d.ts +81 -0
- package/lib/commands/project/convert/source.js +141 -0
- package/lib/commands/project/convert/source.js.map +1 -0
- package/lib/commands/project/delete/source.d.ts +69 -0
- package/lib/commands/project/delete/source.js +424 -0
- package/lib/commands/project/delete/source.js.map +1 -0
- package/lib/commands/project/delete/tracking.d.ts +19 -0
- package/lib/commands/project/delete/tracking.js +49 -0
- package/lib/commands/project/delete/tracking.js.map +1 -0
- package/lib/commands/{deploy/metadata → project/deploy}/cancel.d.ts +2 -1
- package/lib/commands/{deploy/metadata → project/deploy}/cancel.js +20 -7
- package/lib/commands/project/deploy/cancel.js.map +1 -0
- package/lib/commands/{deploy/metadata → project/deploy}/preview.d.ts +2 -1
- package/lib/commands/{deploy/metadata → project/deploy}/preview.js +3 -2
- package/lib/commands/project/deploy/preview.js.map +1 -0
- package/lib/commands/{deploy/metadata → project/deploy}/quick.d.ts +3 -1
- package/lib/commands/{deploy/metadata → project/deploy}/quick.js +14 -7
- package/lib/commands/project/deploy/quick.js.map +1 -0
- package/lib/commands/{deploy/metadata → project/deploy}/report.d.ts +5 -1
- package/lib/commands/{deploy/metadata → project/deploy}/report.js +25 -7
- package/lib/commands/project/deploy/report.js.map +1 -0
- package/lib/commands/{deploy/metadata → project/deploy}/resume.d.ts +5 -1
- package/lib/commands/{deploy/metadata → project/deploy}/resume.js +21 -6
- package/lib/commands/project/deploy/resume.js.map +1 -0
- package/lib/commands/{deploy/metadata.d.ts → project/deploy/start.d.ts} +10 -3
- package/lib/commands/{deploy/metadata.js → project/deploy/start.js} +56 -17
- package/lib/commands/project/deploy/start.js.map +1 -0
- package/lib/commands/{deploy/metadata → project/deploy}/validate.d.ts +2 -1
- package/lib/commands/{deploy/metadata → project/deploy}/validate.js +10 -9
- package/lib/commands/project/deploy/validate.js.map +1 -0
- package/lib/commands/project/generate/manifest.d.ts +26 -0
- package/lib/commands/project/generate/manifest.js +132 -0
- package/lib/commands/project/generate/manifest.js.map +1 -0
- package/lib/commands/project/list/ignored.d.ts +24 -0
- package/lib/commands/project/list/ignored.js +85 -0
- package/lib/commands/project/list/ignored.js.map +1 -0
- package/lib/commands/project/reset/tracking.d.ts +21 -0
- package/lib/commands/project/reset/tracking.js +64 -0
- package/lib/commands/project/reset/tracking.js.map +1 -0
- package/lib/commands/{retrieve/metadata → project/retrieve}/preview.d.ts +2 -1
- package/lib/commands/{retrieve/metadata → project/retrieve}/preview.js +2 -1
- package/lib/commands/project/retrieve/preview.js.map +1 -0
- package/lib/commands/{retrieve/metadata.d.ts → project/retrieve/start.d.ts} +3 -2
- package/lib/commands/{retrieve/metadata.js → project/retrieve/start.js} +12 -10
- package/lib/commands/project/retrieve/start.js.map +1 -0
- package/lib/formatters/asyncDeployCancelResultFormatter.d.ts +10 -0
- package/lib/formatters/asyncDeployCancelResultFormatter.js +29 -0
- package/lib/formatters/asyncDeployCancelResultFormatter.js.map +1 -0
- package/lib/formatters/asyncDeployResultFormatter.d.ts +10 -0
- package/lib/formatters/asyncDeployResultFormatter.js +31 -0
- package/lib/formatters/asyncDeployResultFormatter.js.map +1 -0
- package/lib/formatters/deleteResultFormatter.d.ts +13 -0
- package/lib/formatters/deleteResultFormatter.js +72 -0
- package/lib/formatters/deleteResultFormatter.js.map +1 -0
- package/lib/formatters/deployCancelResultFormatter.d.ts +8 -0
- package/lib/formatters/deployCancelResultFormatter.js +29 -0
- package/lib/formatters/deployCancelResultFormatter.js.map +1 -0
- package/lib/formatters/deployReportResultFormatter.d.ts +4 -0
- package/lib/formatters/deployReportResultFormatter.js +52 -0
- package/lib/formatters/deployReportResultFormatter.js.map +1 -0
- package/lib/formatters/deployResultFormatter.d.ts +46 -0
- package/lib/formatters/deployResultFormatter.js +296 -0
- package/lib/formatters/deployResultFormatter.js.map +1 -0
- package/lib/formatters/metadataConvertResultFormatter.d.ts +9 -0
- package/lib/formatters/metadataConvertResultFormatter.js +59 -0
- package/lib/formatters/metadataConvertResultFormatter.js.map +1 -0
- package/lib/formatters/metadataRetrieveResultFormatter.d.ts +17 -0
- package/lib/formatters/metadataRetrieveResultFormatter.js +38 -0
- package/lib/formatters/metadataRetrieveResultFormatter.js.map +1 -0
- package/lib/formatters/retrieveResultFormatter.d.ts +13 -0
- package/lib/formatters/retrieveResultFormatter.js +66 -0
- package/lib/formatters/retrieveResultFormatter.js.map +1 -0
- package/lib/formatters/sourceConvertResultFormatter.d.ts +10 -0
- package/lib/formatters/sourceConvertResultFormatter.js +37 -0
- package/lib/formatters/sourceConvertResultFormatter.js.map +1 -0
- package/lib/utils/conflicts.js +1 -1
- package/lib/utils/conflicts.js.map +1 -1
- package/lib/utils/coverage.d.ts +9 -0
- package/lib/utils/coverage.js +109 -0
- package/lib/utils/coverage.js.map +1 -0
- package/lib/utils/deploy.d.ts +10 -6
- package/lib/utils/deploy.js +23 -26
- package/lib/utils/deploy.js.map +1 -1
- package/lib/utils/deployCache.d.ts +8 -2
- package/lib/utils/deployCache.js +11 -2
- package/lib/utils/deployCache.js.map +1 -1
- package/lib/utils/errorCodes.d.ts +3 -1
- package/lib/utils/errorCodes.js +4 -4
- package/lib/utils/errorCodes.js.map +1 -1
- package/lib/utils/flags.js +3 -8
- package/lib/utils/flags.js.map +1 -1
- package/lib/utils/manifestCache.d.ts +5 -0
- package/lib/utils/manifestCache.js +44 -0
- package/lib/utils/manifestCache.js.map +1 -0
- package/lib/utils/metadataDeployer.js +3 -2
- package/lib/utils/metadataDeployer.js.map +1 -1
- package/lib/utils/output.d.ts +6 -83
- package/lib/utils/output.js +3 -385
- package/lib/utils/output.js.map +1 -1
- package/lib/utils/previewOutput.d.ts +1 -0
- package/lib/utils/previewOutput.js +18 -21
- package/lib/utils/previewOutput.js.map +1 -1
- package/lib/utils/progressBar.d.ts +1 -0
- package/lib/utils/progressBar.js +21 -17
- package/lib/utils/progressBar.js.map +1 -1
- package/lib/utils/types.d.ts +39 -0
- package/lib/utils/types.js +3 -1
- package/lib/utils/types.js.map +1 -1
- package/messages/convert.mdapi.md +68 -0
- package/messages/convert.source.md +69 -0
- package/messages/delete.source.md +136 -0
- package/messages/delete.tracking.md +39 -0
- package/messages/deploy.async.md +3 -3
- package/messages/deploy.md +5 -1
- package/messages/deploy.metadata.cancel.md +10 -6
- package/messages/deploy.metadata.md +37 -5
- package/messages/deploy.metadata.preview.md +11 -7
- package/messages/deploy.metadata.quick.md +11 -3
- package/messages/deploy.metadata.report.md +16 -4
- package/messages/deploy.metadata.resume.md +17 -5
- package/messages/deploy.metadata.validate.md +9 -5
- package/messages/list.ignored.md +29 -0
- package/messages/manifest.generate.md +74 -0
- package/messages/retrieve.metadata.md +4 -4
- package/messages/retrieve.metadata.preview.md +7 -7
- package/oclif.manifest.json +1476 -463
- package/package.json +55 -39
- package/schemas/project-convert-mdapi.json +29 -0
- package/schemas/project-delete-source.json +609 -0
- package/schemas/project-delete-tracking.json +19 -0
- package/schemas/project-generate-manifest.json +19 -0
- package/schemas/project-list-ignored.json +19 -0
- package/schemas/project-reset-tracking.json +19 -0
- package/lib/commands/deploy/metadata/cancel.js.map +0 -1
- package/lib/commands/deploy/metadata/preview.js.map +0 -1
- package/lib/commands/deploy/metadata/quick.js.map +0 -1
- package/lib/commands/deploy/metadata/report.js.map +0 -1
- package/lib/commands/deploy/metadata/resume.js.map +0 -1
- package/lib/commands/deploy/metadata/validate.js.map +0 -1
- package/lib/commands/deploy/metadata.js.map +0 -1
- package/lib/commands/retrieve/metadata/preview.js.map +0 -1
- package/lib/commands/retrieve/metadata.js.map +0 -1
- /package/schemas/{deploy-metadata-cancel.json → project-deploy-cancel.json} +0 -0
- /package/schemas/{deploy-metadata-preview.json → project-deploy-preview.json} +0 -0
- /package/schemas/{deploy-metadata-quick.json → project-deploy-quick.json} +0 -0
- /package/schemas/{deploy-metadata-report.json → project-deploy-report.json} +0 -0
- /package/schemas/{deploy-metadata-resume.json → project-deploy-resume.json} +0 -0
- /package/schemas/{deploy-metadata-validate.json → project-deploy-start.json} +0 -0
- /package/schemas/{deploy-metadata.json → project-deploy-validate.json} +0 -0
- /package/schemas/{retrieve-metadata-preview.json → project-retrieve-preview.json} +0 -0
- /package/schemas/{retrieve-metadata.json → project-retrieve-start.json} +0 -0
package/messages/deploy.async.md
CHANGED
|
@@ -8,12 +8,12 @@ Deploy has been queued for cancellation.
|
|
|
8
8
|
|
|
9
9
|
# info.AsyncDeployCancel
|
|
10
10
|
|
|
11
|
-
Run "
|
|
11
|
+
Run "%s project deploy cancel --job-id %s" to cancel the deploy.
|
|
12
12
|
|
|
13
13
|
# info.AsyncDeployStatus
|
|
14
14
|
|
|
15
|
-
Run "
|
|
15
|
+
Run "%s project deploy report --job-id %s" to get the latest status.
|
|
16
16
|
|
|
17
17
|
# info.AsyncDeployResume
|
|
18
18
|
|
|
19
|
-
Run "
|
|
19
|
+
Run "%s project deploy resume --job-id %s" to resume watching the deploy.
|
package/messages/deploy.md
CHANGED
|
@@ -12,7 +12,7 @@ For example, if your local project contains a source directory with metadata fil
|
|
|
12
12
|
|
|
13
13
|
The command stores your responses in the "deploy-options.json" file in your local project directory and uses them as defaults when you rerun the command. Specify --interactive to force the command to reprompt.
|
|
14
14
|
|
|
15
|
-
Use this command for quick and simple deploys. For more complicated deployments, use the environment-specific commands, such as "
|
|
15
|
+
Use this command for quick and simple deploys. For more complicated deployments, use the environment-specific commands, such as "<%= config.bin %> project deploy start", that provide additional flags.
|
|
16
16
|
|
|
17
17
|
# examples
|
|
18
18
|
|
|
@@ -84,3 +84,7 @@ Deployer "%s" exited with code %d.
|
|
|
84
84
|
# save.as.default
|
|
85
85
|
|
|
86
86
|
Save username %s as default?
|
|
87
|
+
|
|
88
|
+
# deprecation
|
|
89
|
+
|
|
90
|
+
The top-level deploy command is deprecated. You should use `functions deploy` to deploy functions, and use `project deploy start` to deploy metadata to Salesforce orgs.
|
|
@@ -26,10 +26,10 @@ Job ID of the deploy operation you want to cancel.
|
|
|
26
26
|
|
|
27
27
|
These commands return a job ID if they time out or you specified the --async flag:
|
|
28
28
|
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
29
|
+
- <%= config.bin %> project deploy start
|
|
30
|
+
- <%= config.bin %> project deploy validate
|
|
31
|
+
- <%= config.bin %> project deploy quick
|
|
32
|
+
- <%= config.bin %> project deploy cancel
|
|
33
33
|
|
|
34
34
|
The job ID is valid for 10 days from when you started the deploy operation.
|
|
35
35
|
|
|
@@ -47,7 +47,7 @@ Number of minutes to wait for the command to complete and display results.
|
|
|
47
47
|
|
|
48
48
|
# flags.wait.description
|
|
49
49
|
|
|
50
|
-
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 "
|
|
50
|
+
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".
|
|
51
51
|
|
|
52
52
|
# flags.async.summary
|
|
53
53
|
|
|
@@ -55,8 +55,12 @@ Run the command asynchronously.
|
|
|
55
55
|
|
|
56
56
|
# flags.async.description
|
|
57
57
|
|
|
58
|
-
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 "
|
|
58
|
+
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".
|
|
59
59
|
|
|
60
60
|
# error.CannotCancelDeploy
|
|
61
61
|
|
|
62
62
|
Can't cancel deploy because it's already completed.
|
|
63
|
+
|
|
64
|
+
# error.CannotCancelDeployPre
|
|
65
|
+
|
|
66
|
+
Can't cancel deploy with Job Id %s because it's already completed (status is %s)
|
|
@@ -56,6 +56,18 @@ To deploy multiple metadata components, either set multiple --metadata <name> fl
|
|
|
56
56
|
|
|
57
57
|
Login username or alias for the target org.
|
|
58
58
|
|
|
59
|
+
# flags.pre-destructive-changes.summary
|
|
60
|
+
|
|
61
|
+
File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy
|
|
62
|
+
|
|
63
|
+
# flags.post-destructive-changes.summary
|
|
64
|
+
|
|
65
|
+
File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.
|
|
66
|
+
|
|
67
|
+
# flags.purge-on-delete.summary
|
|
68
|
+
|
|
69
|
+
Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.
|
|
70
|
+
|
|
59
71
|
# flags.target-org.description
|
|
60
72
|
|
|
61
73
|
Overrides your default org.
|
|
@@ -98,7 +110,7 @@ Number of minutes to wait for command to complete and display results.
|
|
|
98
110
|
|
|
99
111
|
# flags.wait.description
|
|
100
112
|
|
|
101
|
-
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 "
|
|
113
|
+
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".
|
|
102
114
|
|
|
103
115
|
# flags.manifest.summary
|
|
104
116
|
|
|
@@ -166,7 +178,7 @@ Run the command asynchronously.
|
|
|
166
178
|
|
|
167
179
|
# flags.async.description
|
|
168
180
|
|
|
169
|
-
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 "
|
|
181
|
+
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".
|
|
170
182
|
|
|
171
183
|
# flags.metadata-dir.summary
|
|
172
184
|
|
|
@@ -191,7 +203,7 @@ You must specify tests using the --tests flag if the --test-level flag is set to
|
|
|
191
203
|
|
|
192
204
|
# error.ClientTimeout
|
|
193
205
|
|
|
194
|
-
The command has timed out, although the deployment is still running. Use "
|
|
206
|
+
The command has timed out, although the deployment is still running. Use "%s project deploy resume" to resume watching the deployment.
|
|
195
207
|
|
|
196
208
|
# error.Conflicts
|
|
197
209
|
|
|
@@ -201,7 +213,7 @@ There are changes in the org that conflict with the local changes you're trying
|
|
|
201
213
|
|
|
202
214
|
- To overwrite the remote changes, rerun this command with the --ignore-conflicts flag.
|
|
203
215
|
|
|
204
|
-
- To overwrite the local changes, run the "
|
|
216
|
+
- To overwrite the local changes, run the "%s project retrieve start" command with the --ignore-conflicts flag.
|
|
205
217
|
|
|
206
218
|
# error.nothingToDeploy
|
|
207
219
|
|
|
@@ -209,4 +221,24 @@ No local changes to deploy.
|
|
|
209
221
|
|
|
210
222
|
# error.nothingToDeploy.Actions
|
|
211
223
|
|
|
212
|
-
- To see conflicts and ignored files, run "
|
|
224
|
+
- To see conflicts and ignored files, run "%s project deploy preview" with any of the manifest, directory, or metadata flags.
|
|
225
|
+
|
|
226
|
+
# flags.junit.summary
|
|
227
|
+
|
|
228
|
+
Output JUnit test results.
|
|
229
|
+
|
|
230
|
+
# flags.coverage-formatters.summary
|
|
231
|
+
|
|
232
|
+
Format of the code coverage results.
|
|
233
|
+
|
|
234
|
+
# flags.results-dir.summary
|
|
235
|
+
|
|
236
|
+
Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
237
|
+
|
|
238
|
+
# asyncCoverageJunitWarning
|
|
239
|
+
|
|
240
|
+
You requested an async deploy with code coverage or JUnit results. The reports will be available when the deploy completes.
|
|
241
|
+
|
|
242
|
+
# pushPackageDirsWarning
|
|
243
|
+
|
|
244
|
+
The `pushPackageDirectoriesSequentially` property is not respected by this command. Please call the `project deploy start --source-dir` command for each dependency in the correct order.
|
|
@@ -6,7 +6,7 @@ Preview a deployment to see what will deploy to the org, the potential conflicts
|
|
|
6
6
|
|
|
7
7
|
You must run this command from within a project.
|
|
8
8
|
|
|
9
|
-
The command outputs a table that describes what will happen if you run the "
|
|
9
|
+
The 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.
|
|
10
10
|
|
|
11
11
|
If your org allows source tracking, then this command considers conflicts between the org and local. Some orgs, such as production orgs, never allow source tracking. Use the "--no-track-source" flag when you create a scratch or sandbox org to disable source tracking.
|
|
12
12
|
|
|
@@ -14,15 +14,15 @@ To preview the deployment of multiple metadata components, either set multiple -
|
|
|
14
14
|
|
|
15
15
|
# examples
|
|
16
16
|
|
|
17
|
-
- 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 "
|
|
17
|
+
- 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.
|
|
18
18
|
|
|
19
|
-
- Preview the deployment of source files in a directory, such as force-app:
|
|
19
|
+
- Preview the deployment of source files in a directory, such as force-app, to your default org:
|
|
20
20
|
|
|
21
21
|
<%= config.bin %> <%= command.id %> --source-dir force-app
|
|
22
22
|
|
|
23
|
-
- Preview the deployment of all Apex classes:
|
|
23
|
+
- Preview the deployment of all Apex classes to an org with alias "my-scratch":
|
|
24
24
|
|
|
25
|
-
<%= config.bin %> <%= command.id %> --metadata ApexClass
|
|
25
|
+
<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch
|
|
26
26
|
|
|
27
27
|
- Preview deployment of a specific Apex class:
|
|
28
28
|
|
|
@@ -36,6 +36,10 @@ To preview the deployment of multiple metadata components, either set multiple -
|
|
|
36
36
|
|
|
37
37
|
Login username or alias for the target org.
|
|
38
38
|
|
|
39
|
+
# flags.only-ignored.summary
|
|
40
|
+
|
|
41
|
+
Preview files to be ignored in a deployment.
|
|
42
|
+
|
|
39
43
|
# flags.target-org.description
|
|
40
44
|
|
|
41
45
|
Overrides your default org.
|
|
@@ -64,7 +68,7 @@ All child components are included. If you specify this flag, don’t specify --m
|
|
|
64
68
|
|
|
65
69
|
# flags.ignore-conflicts.summary
|
|
66
70
|
|
|
67
|
-
|
|
71
|
+
Don't display conflicts in preview of the deployment.
|
|
68
72
|
|
|
69
73
|
# flags.ignore-conflicts.description
|
|
70
74
|
|
|
@@ -90,4 +94,4 @@ There are changes in the org that conflict with the local changes you're trying
|
|
|
90
94
|
|
|
91
95
|
- To overwrite the remote changes, rerun this command with the --ignore-conflicts flag.
|
|
92
96
|
|
|
93
|
-
- To overwrite the local changes, run the "
|
|
97
|
+
- To overwrite the local changes, run the "%s project retrieve start" command with the --ignore-conflicts flag.
|
|
@@ -4,7 +4,7 @@ Quickly deploy a validated deployment to an org.
|
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
Before you run this command, first create a validated deployment with the "
|
|
7
|
+
Before you run this command, first create a validated deployment with the "<%= config.bin %> project deploy validate" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.
|
|
8
8
|
|
|
9
9
|
Executing this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.
|
|
10
10
|
|
|
@@ -36,13 +36,21 @@ Use the job ID of the most recently validated deployment.
|
|
|
36
36
|
|
|
37
37
|
For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find a job ID.
|
|
38
38
|
|
|
39
|
+
# flags.api-version.summary
|
|
40
|
+
|
|
41
|
+
Target API version for the deploy.
|
|
42
|
+
|
|
43
|
+
# flags.api-version.description
|
|
44
|
+
|
|
45
|
+
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.
|
|
46
|
+
|
|
39
47
|
# flags.wait.summary
|
|
40
48
|
|
|
41
49
|
Number of minutes to wait for the command to complete and display results.
|
|
42
50
|
|
|
43
51
|
# flags.wait.description
|
|
44
52
|
|
|
45
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy, run "
|
|
53
|
+
If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy, run "<%= config.bin %> project deploy resume". To check the status of the deploy, run "<%= config.bin %> project deploy report".
|
|
46
54
|
|
|
47
55
|
# flags.verbose.summary
|
|
48
56
|
|
|
@@ -58,7 +66,7 @@ Run the command asynchronously.
|
|
|
58
66
|
|
|
59
67
|
# flags.async.description
|
|
60
68
|
|
|
61
|
-
The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the deploy, run "
|
|
69
|
+
The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the deploy, run "<%= config.bin %> project deploy resume". To check the status of the deploy, run "<%= config.bin %> project deploy report".
|
|
62
70
|
|
|
63
71
|
# flags.target-org.summary
|
|
64
72
|
|
|
@@ -26,10 +26,10 @@ Job ID of the deploy operation you want to check the status of.
|
|
|
26
26
|
|
|
27
27
|
These commands return a job ID if they time out or you specified the --async flag:
|
|
28
28
|
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
29
|
+
- <%= config.bin %> project deploy start
|
|
30
|
+
- <%= config.bin %> project deploy validate
|
|
31
|
+
- <%= config.bin %> project deploy quick
|
|
32
|
+
- <%= config.bin %> project deploy cancel
|
|
33
33
|
|
|
34
34
|
The job ID is valid for 10 days from when you started the deploy operation.
|
|
35
35
|
|
|
@@ -40,3 +40,15 @@ Use the job ID of the most recent deploy operation.
|
|
|
40
40
|
# flags.use-most-recent.description
|
|
41
41
|
|
|
42
42
|
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.
|
|
43
|
+
|
|
44
|
+
# flags.junit.summary
|
|
45
|
+
|
|
46
|
+
Output JUnit test results.
|
|
47
|
+
|
|
48
|
+
# flags.coverage-formatters.summary
|
|
49
|
+
|
|
50
|
+
Format of the code coverage results
|
|
51
|
+
|
|
52
|
+
# flags.results-dir.summary
|
|
53
|
+
|
|
54
|
+
Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
@@ -26,10 +26,10 @@ Job ID of the deploy operation you want to resume.
|
|
|
26
26
|
|
|
27
27
|
These commands return a job ID if they time out or you specified the --async flag:
|
|
28
28
|
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
29
|
+
- <%= config.bin %> project deploy start
|
|
30
|
+
- <%= config.bin %> project deploy validate
|
|
31
|
+
- <%= config.bin %> project deploy quick
|
|
32
|
+
- <%= config.bin %> project deploy cancel
|
|
33
33
|
|
|
34
34
|
The job ID is valid for 10 days from when you started the deploy operation.
|
|
35
35
|
|
|
@@ -47,7 +47,7 @@ Number of minutes to wait for the command to complete and display results.
|
|
|
47
47
|
|
|
48
48
|
# flags.wait.description
|
|
49
49
|
|
|
50
|
-
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 "
|
|
50
|
+
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".
|
|
51
51
|
|
|
52
52
|
# flags.verbose.summary
|
|
53
53
|
|
|
@@ -60,3 +60,15 @@ Show concise output of the deploy operation result.
|
|
|
60
60
|
# error.DeployNotResumable
|
|
61
61
|
|
|
62
62
|
Job ID %s is not resumable with status %s.
|
|
63
|
+
|
|
64
|
+
# flags.junit.summary
|
|
65
|
+
|
|
66
|
+
Output JUnit test results.
|
|
67
|
+
|
|
68
|
+
# flags.coverage-formatters.summary
|
|
69
|
+
|
|
70
|
+
Format of the code coverage results.
|
|
71
|
+
|
|
72
|
+
# flags.results-dir.summary
|
|
73
|
+
|
|
74
|
+
Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
@@ -4,7 +4,7 @@ Validate a metadata deployment without actually executing it.
|
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to "
|
|
7
|
+
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.
|
|
8
8
|
|
|
9
9
|
You must run this command from within a project.
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ To validate the deployment of multiple metadata components, either set multiple
|
|
|
14
14
|
|
|
15
15
|
# examples
|
|
16
16
|
|
|
17
|
-
- NOTE: These examples focus on validating large deployments. See the help for "
|
|
17
|
+
- 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.
|
|
18
18
|
|
|
19
19
|
- Validate the deployment of all source files in a directory to the default org:
|
|
20
20
|
|
|
@@ -72,7 +72,7 @@ Number of minutes to wait for the command to complete and display results.
|
|
|
72
72
|
|
|
73
73
|
# flags.wait.description
|
|
74
74
|
|
|
75
|
-
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 "
|
|
75
|
+
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".
|
|
76
76
|
|
|
77
77
|
# flags.manifest.summary
|
|
78
78
|
|
|
@@ -112,7 +112,7 @@ Run the command asynchronously.
|
|
|
112
112
|
|
|
113
113
|
# flags.async.description
|
|
114
114
|
|
|
115
|
-
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 "
|
|
115
|
+
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".
|
|
116
116
|
|
|
117
117
|
# flags.metadata-dir.summary
|
|
118
118
|
|
|
@@ -126,6 +126,10 @@ Indicates that the metadata zip file points to a directory structure for a singl
|
|
|
126
126
|
|
|
127
127
|
Successfully validated the deployment (%s).
|
|
128
128
|
|
|
129
|
+
# info.suggestedQuickDeploy
|
|
130
|
+
|
|
131
|
+
Run "%s project deploy quick --job-id %s" to execute this deploy
|
|
132
|
+
|
|
129
133
|
# error.FailedValidation
|
|
130
134
|
|
|
131
|
-
|
|
135
|
+
Failed to validate the deployment (%s).
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# summary
|
|
2
|
+
|
|
3
|
+
Check your local project package directories for forceignored files.
|
|
4
|
+
|
|
5
|
+
# description
|
|
6
|
+
|
|
7
|
+
When deploying or retrieving metadata between your local project and an org, you can specify the source files you want to exclude with a .forceignore file. The .forceignore file structure mimics the .gitignore structure. Each line in .forceignore specifies a pattern that corresponds to one or more files. The files typically represent metadata components, but can be any files you want to exclude, such as LWC configuration JSON files or tests.
|
|
8
|
+
|
|
9
|
+
# examples
|
|
10
|
+
|
|
11
|
+
- List all the files in all package directories that are ignored:
|
|
12
|
+
|
|
13
|
+
<%= config.bin %> <%= command.id %>
|
|
14
|
+
|
|
15
|
+
- List all the files in a specific directory that are ignored:
|
|
16
|
+
|
|
17
|
+
<%= config.bin %> <%= command.id %> --source-dir force-app
|
|
18
|
+
|
|
19
|
+
- Check if a particular file is ignored:
|
|
20
|
+
|
|
21
|
+
<%= config.bin %> <%= command.id %> --source-dir package.xml
|
|
22
|
+
|
|
23
|
+
# flags.source-dir.summary
|
|
24
|
+
|
|
25
|
+
File or directory of files that the command checks for foreceignored files.
|
|
26
|
+
|
|
27
|
+
# invalidSourceDir
|
|
28
|
+
|
|
29
|
+
File or directory '%s' doesn't exist in your project. Specify one that exists and rerun the command.
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# summary
|
|
2
|
+
|
|
3
|
+
Create a project manifest that lists the metadata components you want to deploy or retrieve.
|
|
4
|
+
|
|
5
|
+
# description
|
|
6
|
+
|
|
7
|
+
Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these parameters, not both.
|
|
8
|
+
|
|
9
|
+
Use --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their respective file names, are:
|
|
10
|
+
|
|
11
|
+
* package : package.xml (default)
|
|
12
|
+
* pre : destructiveChangesPre.xml
|
|
13
|
+
* post : destructiveChangesPost.xml
|
|
14
|
+
* destroy : destructiveChanges.xml
|
|
15
|
+
|
|
16
|
+
See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for information about these destructive manifest files.
|
|
17
|
+
|
|
18
|
+
Use --name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --type or --name, but not both.
|
|
19
|
+
|
|
20
|
+
To include multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --include-packages and --source-dir.
|
|
21
|
+
|
|
22
|
+
# examples
|
|
23
|
+
|
|
24
|
+
- Create a manifest for deploying or retrieving all Apex classes and custom objects:
|
|
25
|
+
|
|
26
|
+
$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject
|
|
27
|
+
|
|
28
|
+
- Create a manifest for deleting the specified Apex class:
|
|
29
|
+
|
|
30
|
+
$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy
|
|
31
|
+
|
|
32
|
+
- Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:
|
|
33
|
+
|
|
34
|
+
$ <%= config.bin %> <%= command.id %> --source-dir force-app --name myNewManifest
|
|
35
|
+
|
|
36
|
+
- Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:
|
|
37
|
+
|
|
38
|
+
$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --include-packages unlocked
|
|
39
|
+
|
|
40
|
+
# flags.include-packages.summary
|
|
41
|
+
|
|
42
|
+
Package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored.
|
|
43
|
+
|
|
44
|
+
# flags.from-org.summary
|
|
45
|
+
|
|
46
|
+
Username or alias of the org that contains the metadata components from which to build a manifest.
|
|
47
|
+
|
|
48
|
+
# flags.type.summary
|
|
49
|
+
|
|
50
|
+
Type of manifest to create; the type determines the name of the created file.
|
|
51
|
+
|
|
52
|
+
# flags.name.summary
|
|
53
|
+
|
|
54
|
+
Name of a custom manifest file to create.
|
|
55
|
+
|
|
56
|
+
# flags.output-dir.summary
|
|
57
|
+
|
|
58
|
+
Directory to save the created manifest.
|
|
59
|
+
|
|
60
|
+
# flags.source-dir.summary
|
|
61
|
+
|
|
62
|
+
Paths to the local source files to include in the manifest.
|
|
63
|
+
|
|
64
|
+
# flags.metadata.summary
|
|
65
|
+
|
|
66
|
+
Names of metadata components to include in the manifest.
|
|
67
|
+
|
|
68
|
+
# success
|
|
69
|
+
|
|
70
|
+
successfully wrote %s
|
|
71
|
+
|
|
72
|
+
# successOutputDir
|
|
73
|
+
|
|
74
|
+
successfully wrote %s to %s
|
|
@@ -14,13 +14,13 @@ To retrieve multiple metadata components, either use multiple --metadata <name>
|
|
|
14
14
|
|
|
15
15
|
# examples
|
|
16
16
|
|
|
17
|
-
- Retrieve remote changes:
|
|
17
|
+
- Retrieve remote changes from your default org:
|
|
18
18
|
|
|
19
19
|
<%= config.bin %> <%= command.id %>
|
|
20
20
|
|
|
21
|
-
- Retrieve the source files in a directory:
|
|
21
|
+
- Retrieve the source files in a directory from an org with alias "my-scratch":
|
|
22
22
|
|
|
23
|
-
<%= config.bin %> <%= command.id %> --source-dir path/to/source
|
|
23
|
+
<%= config.bin %> <%= command.id %> --source-dir path/to/source --target-org my-scratch
|
|
24
24
|
|
|
25
25
|
- Retrieve a specific Apex class and the objects whose source is in a directory (both examples are equivalent):
|
|
26
26
|
|
|
@@ -157,7 +157,7 @@ There are changes in your local files that conflict with the org changes you're
|
|
|
157
157
|
|
|
158
158
|
- To overwrite the local changes, rerun this command with the --ignore-conflicts flag.
|
|
159
159
|
|
|
160
|
-
- To overwrite the remote changes, run the "
|
|
160
|
+
- To overwrite the remote changes, run the "%s project deploy start" command with the --ignore-conflicts flag.
|
|
161
161
|
|
|
162
162
|
# info.WroteZipFile
|
|
163
163
|
|
|
@@ -6,19 +6,19 @@ Preview a retrieval to see what will be retrieved from the org, the potential co
|
|
|
6
6
|
|
|
7
7
|
You must run this command from within a project.
|
|
8
8
|
|
|
9
|
-
The command outputs a table that describes what will happen if you run the "
|
|
9
|
+
The command outputs a table that describes what will happen if you run the "<%= config.bin %> project retrieve start" command. The table lists the metadata components that will be retrieved 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 retrieved because they're included in your .forceignore file.
|
|
10
10
|
|
|
11
11
|
If your org allows source tracking, then this command considers conflicts between the org and local. Some orgs, such as production orgs, never allow source tracking. Use the "--no-track-source" flag when you create a scratch or sandbox org to disable source tracking.
|
|
12
12
|
|
|
13
13
|
# examples
|
|
14
14
|
|
|
15
|
-
- Preview the retrieve of all changes from
|
|
15
|
+
- Preview the retrieve of all changes from your default org:
|
|
16
16
|
|
|
17
17
|
<%= config.bin %> <%= command.id %>
|
|
18
18
|
|
|
19
|
-
- Preview the retrieve when ignoring any conflicts:
|
|
19
|
+
- Preview the retrieve when ignoring any conflicts from an org with alias "my-scratch":
|
|
20
20
|
|
|
21
|
-
<%= config.bin %> <%= command.id %> --ignore-conflicts
|
|
21
|
+
<%= config.bin %> <%= command.id %> --ignore-conflicts --target-org my-scratch
|
|
22
22
|
|
|
23
23
|
# flags.target-org.summary
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Overrides your default org.
|
|
|
30
30
|
|
|
31
31
|
# flags.ignore-conflicts.summary
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
Don't display conflicts in the preview of the retrieval.
|
|
34
34
|
|
|
35
35
|
# flags.ignore-conflicts.description
|
|
36
36
|
|
|
@@ -54,6 +54,6 @@ There are local changes that conflict with the remote changes that would be retr
|
|
|
54
54
|
|
|
55
55
|
# error.Conflicts.Actions
|
|
56
56
|
|
|
57
|
-
- To overwrite the remote changes, run the "
|
|
57
|
+
- To overwrite the remote changes, run the "project deploy start" command with the --ignore-conflicts flag.
|
|
58
58
|
|
|
59
|
-
- To overwrite the local changes, run the "
|
|
59
|
+
- To overwrite the local changes, run the "project retrieve start" command with the --ignore-conflicts flag.
|