@salesforce/plugin-deploy-retrieve 3.7.9 → 3.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +78 -20
- package/lib/commands/project/convert/source-behavior.d.ts +21 -0
- package/lib/commands/project/convert/source-behavior.js +74 -0
- package/lib/commands/project/convert/source-behavior.js.map +1 -0
- package/lib/commands/project/deploy/cancel.js +1 -1
- package/lib/commands/project/deploy/cancel.js.map +1 -1
- package/lib/commands/project/deploy/quick.js +1 -1
- package/lib/commands/project/deploy/quick.js.map +1 -1
- package/lib/commands/project/deploy/resume.js +1 -1
- package/lib/commands/project/deploy/resume.js.map +1 -1
- package/lib/commands/project/deploy/start.js +4 -4
- package/lib/commands/project/deploy/start.js.map +1 -1
- package/lib/commands/project/deploy/validate.js +3 -3
- package/lib/commands/project/deploy/validate.js.map +1 -1
- package/lib/commands/project/retrieve/start.js +1 -1
- package/lib/commands/project/retrieve/start.js.map +1 -1
- package/lib/formatters/asyncDeployCancelResultFormatter.d.ts +1 -2
- package/lib/formatters/asyncDeployCancelResultFormatter.js +3 -5
- package/lib/formatters/asyncDeployCancelResultFormatter.js.map +1 -1
- package/lib/formatters/asyncDeployResultFormatter.d.ts +1 -2
- package/lib/formatters/asyncDeployResultFormatter.js +4 -6
- package/lib/formatters/asyncDeployResultFormatter.js.map +1 -1
- package/lib/utils/convertBehavior.d.ts +24 -0
- package/lib/utils/convertBehavior.js +126 -0
- package/lib/utils/convertBehavior.js.map +1 -0
- package/lib/utils/deploy.d.ts +1 -1
- package/lib/utils/deploy.js +2 -2
- package/lib/utils/deploy.js.map +1 -1
- package/messages/convert.mdapi.md +3 -3
- package/messages/convert.source-behavior.md +70 -0
- package/messages/convert.source.md +4 -4
- package/messages/delete.source.md +6 -6
- package/messages/delete.tracking.md +4 -4
- package/messages/deploy.async.md +3 -3
- package/messages/deploy.metadata.cancel.md +8 -8
- package/messages/deploy.metadata.md +18 -18
- package/messages/deploy.metadata.preview.md +8 -8
- package/messages/deploy.metadata.quick.md +6 -6
- package/messages/deploy.metadata.report.md +7 -7
- package/messages/deploy.metadata.resume.md +7 -7
- package/messages/deploy.metadata.validate.md +10 -10
- package/messages/list.ignored.md +3 -3
- package/messages/manifest.generate.md +4 -4
- package/messages/retrieve.metadata.preview.md +4 -4
- package/messages/retrieve.start.md +17 -17
- package/oclif.manifest.json +177 -87
- package/package.json +7 -6
- package/schemas/project-convert-source__behavior.json +31 -0
- package/schemas/project-delete-source.json +5 -5
- package/schemas/project-deploy-cancel.json +4 -4
- package/schemas/project-deploy-quick.json +4 -4
- package/schemas/project-deploy-report.json +4 -4
- package/schemas/project-deploy-resume.json +4 -4
- package/schemas/project-deploy-start.json +4 -4
- package/schemas/project-deploy-validate.json +4 -4
- package/schemas/project-retrieve-start.json +4 -4
|
@@ -12,11 +12,11 @@ Run this command by either passing it a job ID or specifying the --use-most-rece
|
|
|
12
12
|
|
|
13
13
|
- Cancel a deploy operation using a job ID:
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
sf <%= command.id %> --job-id 0Af0x000017yLUFCA2
|
|
16
16
|
|
|
17
17
|
- Cancel the most recent deploy operation:
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
sf <%= command.id %> --use-most-recent
|
|
20
20
|
|
|
21
21
|
# flags.job-id.summary
|
|
22
22
|
|
|
@@ -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
|
+
- sf project deploy start
|
|
30
|
+
- sf project deploy validate
|
|
31
|
+
- sf project deploy quick
|
|
32
|
+
- sf 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 "sf project deploy resume". To check the status of the cancellation, run "sf project deploy report".
|
|
51
51
|
|
|
52
52
|
# flags.async.summary
|
|
53
53
|
|
|
@@ -55,7 +55,7 @@ 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 "sf project deploy resume". To check the status of the cancellation, run "sf project deploy report".
|
|
59
59
|
|
|
60
60
|
# error.CannotCancelDeploy
|
|
61
61
|
|
|
@@ -8,7 +8,7 @@ You must run this command from within a project.
|
|
|
8
8
|
|
|
9
9
|
Metadata 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.
|
|
10
10
|
|
|
11
|
-
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "
|
|
11
|
+
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create scratch|sandbox" commands.
|
|
12
12
|
|
|
13
13
|
To 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.
|
|
14
14
|
|
|
@@ -16,45 +16,45 @@ To deploy multiple metadata components, either set multiple --metadata <name> fl
|
|
|
16
16
|
|
|
17
17
|
- Deploy local changes not in the org; uses your default org:
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
sf <%= command.id %>
|
|
20
20
|
|
|
21
21
|
- Deploy all source files in the "force-app" directory to an org with alias "my-scratch"; show only concise output, in other words don't print a list of all the source that was deployed:
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
sf <%= command.id %> --source-dir force-app --target-org my-scratch --concise
|
|
24
24
|
|
|
25
25
|
- Deploy all the Apex classes and custom objects that are in the "force-app" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:
|
|
26
26
|
|
|
27
|
-
|
|
28
|
-
|
|
27
|
+
sf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
|
|
28
|
+
sf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
|
|
29
29
|
|
|
30
30
|
- Deploy all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
sf <%= command.id %> --metadata ApexClass
|
|
33
33
|
|
|
34
34
|
- Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
sf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
|
|
37
37
|
|
|
38
38
|
- Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string "MyApex". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
sf <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings
|
|
41
41
|
|
|
42
42
|
- Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
|
|
43
43
|
|
|
44
|
-
|
|
45
|
-
|
|
44
|
+
sf <%= command.id %> --metadata CustomObject ApexClass
|
|
45
|
+
sf <%= command.id %> --metadata CustomObject --metadata ApexClass
|
|
46
46
|
|
|
47
47
|
- Deploy all Apex classes and a profile that has a space in its name:
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
sf <%= command.id %> --metadata ApexClass --metadata "Profile:My Profile"
|
|
50
50
|
|
|
51
51
|
- Deploy all components listed in a manifest:
|
|
52
52
|
|
|
53
|
-
|
|
53
|
+
sf <%= command.id %> --manifest path/to/package.xml
|
|
54
54
|
|
|
55
55
|
- Run the tests that aren’t in any managed packages as part of a deployment:
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
sf <%= command.id %> --metadata ApexClass --test-level RunLocalTests
|
|
58
58
|
|
|
59
59
|
# flags.target-org.summary
|
|
60
60
|
|
|
@@ -114,7 +114,7 @@ Number of minutes to wait for command to complete and display results.
|
|
|
114
114
|
|
|
115
115
|
# flags.wait.description
|
|
116
116
|
|
|
117
|
-
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 "
|
|
117
|
+
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 "sf project deploy resume". To check the status of the deployment, run "sf project deploy report".
|
|
118
118
|
|
|
119
119
|
# flags.manifest.summary
|
|
120
120
|
|
|
@@ -176,7 +176,7 @@ Run the command asynchronously.
|
|
|
176
176
|
|
|
177
177
|
# flags.async.description
|
|
178
178
|
|
|
179
|
-
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 "
|
|
179
|
+
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 "sf project deploy resume". To check the status of the deployment, run "sf project deploy report".
|
|
180
180
|
|
|
181
181
|
# flags.metadata-dir.summary
|
|
182
182
|
|
|
@@ -201,7 +201,7 @@ You must specify tests using the --tests flag if the --test-level flag is set to
|
|
|
201
201
|
|
|
202
202
|
# error.ClientTimeout
|
|
203
203
|
|
|
204
|
-
The command has timed out, although the deployment is still running. Use "
|
|
204
|
+
The command has timed out, although the deployment is still running. Use "sf project deploy resume" to resume watching the deployment.
|
|
205
205
|
|
|
206
206
|
# error.Conflicts
|
|
207
207
|
|
|
@@ -211,7 +211,7 @@ There are changes in the org that conflict with the local changes you're trying
|
|
|
211
211
|
|
|
212
212
|
- To overwrite the remote changes, rerun this command with the --ignore-conflicts flag.
|
|
213
213
|
|
|
214
|
-
- To overwrite the local changes, run the "
|
|
214
|
+
- To overwrite the local changes, run the "sf project retrieve start" command with the --ignore-conflicts flag.
|
|
215
215
|
|
|
216
216
|
# error.nothingToDeploy
|
|
217
217
|
|
|
@@ -219,7 +219,7 @@ No local changes to deploy.
|
|
|
219
219
|
|
|
220
220
|
# error.nothingToDeploy.Actions
|
|
221
221
|
|
|
222
|
-
- To see conflicts and ignored files, run "
|
|
222
|
+
- To see conflicts and ignored files, run "sf project deploy preview" with any of the manifest, directory, or metadata flags.
|
|
223
223
|
|
|
224
224
|
# error.InvalidDeployId
|
|
225
225
|
|
|
@@ -6,31 +6,31 @@ 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 "sf 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
|
-
If 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 "
|
|
11
|
+
If 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 "sf org create scratch|sandbox" commands.
|
|
12
12
|
|
|
13
13
|
To 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.
|
|
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 "sf project deploy start" for more examples that you can adapt for previewing.
|
|
18
18
|
|
|
19
19
|
- Preview the deployment of source files in a directory, such as force-app, to your default org:
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
sf <%= command.id %> --source-dir force-app
|
|
22
22
|
|
|
23
23
|
- Preview the deployment of all Apex classes to an org with alias "my-scratch":
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
sf <%= command.id %> --metadata ApexClass --target-org my-scratch
|
|
26
26
|
|
|
27
27
|
- Preview deployment of a specific Apex class:
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
sf <%= command.id %> --metadata ApexClass:MyApexClass
|
|
30
30
|
|
|
31
31
|
- Preview deployment of all components listed in a manifest:
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
sf <%= command.id %> --manifest path/to/package.xml
|
|
34
34
|
|
|
35
35
|
# flags.target-org.summary
|
|
36
36
|
|
|
@@ -94,4 +94,4 @@ There are changes in the org that conflict with the local changes you're trying
|
|
|
94
94
|
|
|
95
95
|
- To overwrite the remote changes, rerun this command with the --ignore-conflicts flag.
|
|
96
96
|
|
|
97
|
-
- To overwrite the local changes, run the "
|
|
97
|
+
- To overwrite the local changes, run the "sf project retrieve start" command with the --ignore-conflicts flag.
|
|
@@ -4,23 +4,23 @@ 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 "sf 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
|
|
|
11
11
|
This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.
|
|
12
12
|
|
|
13
|
-
Note: Don't use this command on sandboxes; the command is intended to be used on production orgs.
|
|
13
|
+
Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. Use `sf project deploy start` instead.
|
|
14
14
|
|
|
15
15
|
# examples
|
|
16
16
|
|
|
17
17
|
- Run a quick deploy to your default org using a job ID:
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
sf <%= command.id %> --job-id 0Af0x000017yLUFCA2
|
|
20
20
|
|
|
21
21
|
- Asynchronously run a quick deploy of the most recently validated deployment to an org with alias "my-prod-org":
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
sf <%= command.id %> --async --use-most-recent --target-org my-prod-org
|
|
24
24
|
|
|
25
25
|
# flags.job-id.summary
|
|
26
26
|
|
|
@@ -52,7 +52,7 @@ Number of minutes to wait for the command to complete and display results.
|
|
|
52
52
|
|
|
53
53
|
# flags.wait.description
|
|
54
54
|
|
|
55
|
-
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 "
|
|
55
|
+
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 "sf project deploy resume". To check the status of the deploy, run "sf project deploy report".
|
|
56
56
|
|
|
57
57
|
# flags.verbose.summary
|
|
58
58
|
|
|
@@ -68,7 +68,7 @@ Run the command asynchronously.
|
|
|
68
68
|
|
|
69
69
|
# flags.async.description
|
|
70
70
|
|
|
71
|
-
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 "
|
|
71
|
+
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 "sf project deploy resume". To check the status of the deploy, run "sf project deploy report".
|
|
72
72
|
|
|
73
73
|
# flags.target-org.summary
|
|
74
74
|
|
|
@@ -16,15 +16,15 @@ This command doesn't update source tracking information.
|
|
|
16
16
|
|
|
17
17
|
- Check the status using a job ID:
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
sf <%= command.id %> --job-id 0Af0x000017yLUFCA2
|
|
20
20
|
|
|
21
21
|
- Check the status of the most recent deploy operation:
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
sf <%= command.id %> --use-most-recent
|
|
24
24
|
|
|
25
25
|
- Poll for the status using a job ID and target org:
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
sf <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30
|
|
28
28
|
|
|
29
29
|
# flags.job-id.summary
|
|
30
30
|
|
|
@@ -34,10 +34,10 @@ Job ID of the deploy operation you want to check the status of.
|
|
|
34
34
|
|
|
35
35
|
These commands return a job ID if they time out or you specified the --async flag:
|
|
36
36
|
|
|
37
|
-
-
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
-
|
|
37
|
+
- sf project deploy start
|
|
38
|
+
- sf project deploy validate
|
|
39
|
+
- sf project deploy quick
|
|
40
|
+
- sf project deploy cancel
|
|
41
41
|
|
|
42
42
|
The job ID is valid for 10 days from when you started the deploy operation.
|
|
43
43
|
|
|
@@ -12,11 +12,11 @@ Run this command by either passing it a job ID or specifying the --use-most-rece
|
|
|
12
12
|
|
|
13
13
|
- Resume watching a deploy operation using a job ID:
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
sf <%= command.id %> --job-id 0Af0x000017yLUFCA2
|
|
16
16
|
|
|
17
17
|
- Resume watching the most recent deploy operation:
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
sf <%= command.id %> --use-most-recent
|
|
20
20
|
|
|
21
21
|
# flags.job-id.summary
|
|
22
22
|
|
|
@@ -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
|
+
- sf project deploy start
|
|
30
|
+
- sf project deploy validate
|
|
31
|
+
- sf project deploy quick
|
|
32
|
+
- sf 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 "sf project deploy report".
|
|
51
51
|
|
|
52
52
|
# flags.verbose.summary
|
|
53
53
|
|
|
@@ -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 "sf 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 "sf 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
|
|
|
@@ -12,27 +12,27 @@ This command doesn't support source-tracking. When you quick deploy with the res
|
|
|
12
12
|
|
|
13
13
|
To 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.
|
|
14
14
|
|
|
15
|
-
Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy.
|
|
15
|
+
Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use "sf project deploy start --dry-run --test-level RunLocalTests" instead.
|
|
16
16
|
|
|
17
17
|
# examples
|
|
18
18
|
|
|
19
|
-
- NOTE: These examples focus on validating large deployments. See the help for "
|
|
19
|
+
- NOTE: These examples focus on validating large deployments. See the help for "sf project deploy start" for examples of deploying smaller sets of metadata which you can also use to validate.
|
|
20
20
|
|
|
21
21
|
- Validate the deployment of all source files in the "force-app" directory to the default org:
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
sf <%= command.id %> --source-dir force-app
|
|
24
24
|
|
|
25
25
|
- Validate the deployment of all source files in two directories: "force-app" and "force-app-utils":
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
sf <%= command.id %> --source-dir force-app --source-dir force-app-utils
|
|
28
28
|
|
|
29
29
|
- Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately returns the job ID:
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
sf <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org
|
|
32
32
|
|
|
33
33
|
- Validate the deployment of all components listed in a manifest:
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
sf <%= command.id %> --manifest path/to/package.xml
|
|
36
36
|
|
|
37
37
|
# flags.target-org.summary
|
|
38
38
|
|
|
@@ -76,7 +76,7 @@ Number of minutes to wait for the command to complete and display results.
|
|
|
76
76
|
|
|
77
77
|
# flags.wait.description
|
|
78
78
|
|
|
79
|
-
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 "
|
|
79
|
+
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 "sf project deploy resume". To check the status of the validation, run "sf project deploy report".
|
|
80
80
|
|
|
81
81
|
# flags.manifest.summary
|
|
82
82
|
|
|
@@ -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 "sf project deploy resume". To check the status of the validation, run "sf project deploy report".
|
|
116
116
|
|
|
117
117
|
# flags.metadata-dir.summary
|
|
118
118
|
|
|
@@ -128,7 +128,7 @@ Successfully validated the deployment (%s).
|
|
|
128
128
|
|
|
129
129
|
# info.suggestedQuickDeploy
|
|
130
130
|
|
|
131
|
-
Run "
|
|
131
|
+
Run "sf project deploy quick --job-id %s" to execute this deploy
|
|
132
132
|
|
|
133
133
|
# error.FailedValidation
|
|
134
134
|
|
package/messages/list.ignored.md
CHANGED
|
@@ -10,15 +10,15 @@ When deploying or retrieving metadata between your local project and an org, you
|
|
|
10
10
|
|
|
11
11
|
- List all the files in all package directories that are ignored:
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
sf <%= command.id %>
|
|
14
14
|
|
|
15
15
|
- List all the files in a specific directory that are ignored:
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
sf <%= command.id %> --source-dir force-app
|
|
18
18
|
|
|
19
19
|
- Check if a particular file is ignored:
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
sf <%= command.id %> --source-dir package.xml
|
|
22
22
|
|
|
23
23
|
# flags.source-dir.summary
|
|
24
24
|
|
|
@@ -23,19 +23,19 @@ To include multiple metadata components, either set multiple --metadata <name> f
|
|
|
23
23
|
|
|
24
24
|
- Create a manifest for deploying or retrieving all Apex classes and custom objects:
|
|
25
25
|
|
|
26
|
-
$
|
|
26
|
+
$ sf <%= command.id %> --metadata ApexClass --metadata CustomObject
|
|
27
27
|
|
|
28
28
|
- Create a manifest for deleting the specified Apex class:
|
|
29
29
|
|
|
30
|
-
$
|
|
30
|
+
$ sf <%= command.id %> --metadata ApexClass:MyApexClass --type destroy
|
|
31
31
|
|
|
32
32
|
- Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:
|
|
33
33
|
|
|
34
|
-
$
|
|
34
|
+
$ sf <%= command.id %> --source-dir force-app --name myNewManifest
|
|
35
35
|
|
|
36
36
|
- Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:
|
|
37
37
|
|
|
38
|
-
$
|
|
38
|
+
$ sf <%= command.id %> --from-org test@myorg.com --include-packages unlocked
|
|
39
39
|
|
|
40
40
|
# flags.include-packages.summary
|
|
41
41
|
|
|
@@ -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 "sf 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
|
-
If 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 "
|
|
11
|
+
If 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 "sf org create scratch|sandbox" commands.
|
|
12
12
|
|
|
13
13
|
# examples
|
|
14
14
|
|
|
15
15
|
- Preview the retrieve of all changes from your default org:
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
sf <%= command.id %>
|
|
18
18
|
|
|
19
19
|
- Preview the retrieve when ignoring any conflicts from an org with alias "my-scratch":
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
sf <%= command.id %> --ignore-conflicts --target-org my-scratch
|
|
22
22
|
|
|
23
23
|
# flags.target-org.summary
|
|
24
24
|
|
|
@@ -8,7 +8,7 @@ You must run this command from within a project.
|
|
|
8
8
|
|
|
9
9
|
Metadata components are retrieved in source format by default. Retrieve them in metadata format by specifying the --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.
|
|
10
10
|
|
|
11
|
-
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "
|
|
11
|
+
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create scratch|sandbox" commands.
|
|
12
12
|
|
|
13
13
|
To retrieve multiple metadata components, either use multiple --metadata <name> flags or use 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.
|
|
14
14
|
|
|
@@ -16,54 +16,54 @@ To retrieve multiple metadata components, either use multiple --metadata <name>
|
|
|
16
16
|
|
|
17
17
|
- Retrieve all remote changes from your default org:
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
sf <%= command.id %>
|
|
20
20
|
|
|
21
21
|
- Retrieve the source files in the "force-app" directory from an org with alias "my-scratch":
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
sf <%= command.id %> --source-dir force-app --target-org my-scratch
|
|
24
24
|
|
|
25
25
|
- Retrieve all the Apex classes and custom objects whose source is in the "force-app" directory. The list views, layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:
|
|
26
26
|
|
|
27
|
-
|
|
28
|
-
|
|
27
|
+
sf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
|
|
28
|
+
sf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
|
|
29
29
|
|
|
30
30
|
- Retrieve all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
sf <%= command.id %> --metadata ApexClass
|
|
33
33
|
|
|
34
34
|
- Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class source files in your local project if there are conflicts!):
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
sf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
|
|
37
37
|
|
|
38
38
|
- Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the string "MyApex":
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
sf <%= command.id %> --metadata 'ApexClass:MyApex*'
|
|
41
41
|
|
|
42
42
|
- Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
|
|
43
43
|
|
|
44
|
-
|
|
45
|
-
|
|
44
|
+
sf <%= command.id %> --metadata CustomObject ApexClass
|
|
45
|
+
sf <%= command.id %> --metadata CustomObject --metadata ApexClass
|
|
46
46
|
|
|
47
47
|
- Retrieve all metadata components listed in a manifest:
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
sf <%= command.id %> --manifest path/to/package.xml
|
|
50
50
|
|
|
51
51
|
- Retrieve metadata from a package:
|
|
52
52
|
|
|
53
|
-
|
|
53
|
+
sf <%= command.id %> --package-name MyPackageName
|
|
54
54
|
|
|
55
55
|
- Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent):
|
|
56
56
|
|
|
57
|
-
|
|
58
|
-
|
|
57
|
+
sf <%= command.id %> --package-name Package1 "PackageName With Spaces" Package3
|
|
58
|
+
sf <%= command.id %> --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
|
|
59
59
|
|
|
60
60
|
- Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the "output" directory:
|
|
61
61
|
|
|
62
|
-
|
|
62
|
+
sf <%= command.id %> --source-dir force-app --target-metadata-dir output
|
|
63
63
|
|
|
64
64
|
- Retrieve in metadata format and automatically extract the contents into the "output" directory:
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
sf <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip
|
|
67
67
|
|
|
68
68
|
# flags.api-version.summary
|
|
69
69
|
|
|
@@ -161,7 +161,7 @@ There are changes in your local files that conflict with the org changes you're
|
|
|
161
161
|
|
|
162
162
|
- To overwrite the local changes, rerun this command with the --ignore-conflicts flag.
|
|
163
163
|
|
|
164
|
-
- To overwrite the remote changes, run the "
|
|
164
|
+
- To overwrite the remote changes, run the "sf project deploy start" command with the --ignore-conflicts flag.
|
|
165
165
|
|
|
166
166
|
# info.WroteZipFile
|
|
167
167
|
|