@salesforce/plugin-deploy-retrieve 1.8.5-beta.3 → 1.8.5-beta.4
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/project/convert/mdapi.js +8 -11
- package/lib/commands/project/convert/mdapi.js.map +1 -1
- package/lib/commands/project/convert/source.js +8 -8
- package/lib/commands/project/convert/source.js.map +1 -1
- package/lib/commands/project/delete/source.js +16 -15
- package/lib/commands/project/delete/source.js.map +1 -1
- package/lib/commands/project/delete/tracking.js +2 -2
- package/lib/commands/project/delete/tracking.js.map +1 -1
- package/lib/commands/project/manifest/create.js +8 -8
- package/lib/commands/project/manifest/create.js.map +1 -1
- package/lib/commands/project/reset/tracking.js +3 -3
- package/lib/commands/project/reset/tracking.js.map +1 -1
- package/messages/convert.mdapi.md +22 -34
- package/messages/convert.source.md +24 -25
- package/messages/delete.source.md +57 -45
- package/messages/delete.tracking.md +17 -12
- package/messages/manifest.create.md +34 -23
- package/oclif.manifest.json +67 -68
- package/package.json +3 -3
|
@@ -1,13 +1,10 @@
|
|
|
1
1
|
# summary
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Convert source-formatted files into metadata that you can deploy using Metadata API.
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
convert source into Metadata API
|
|
8
|
-
Converts source-formatted files into metadata that you can deploy using Metadata API.
|
|
9
|
-
To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API,
|
|
10
|
-
run "<%= config.bin %> project convert mdapi". Then deploy the metadata using "<%= config.bin %> project deploy".
|
|
7
|
+
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".
|
|
11
8
|
|
|
12
9
|
To convert Metadata API–formatted files into the source format, run "<%= config.bin %> project convert mdapi".
|
|
13
10
|
|
|
@@ -15,45 +12,47 @@ To specify a package name that includes spaces, enclose the name in single quote
|
|
|
15
12
|
|
|
16
13
|
# examples
|
|
17
14
|
|
|
18
|
-
-
|
|
15
|
+
- Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:
|
|
19
16
|
|
|
20
|
-
|
|
17
|
+
$ <%= config.bin %> <%= command.id %> --root-dir path/to/source
|
|
21
18
|
|
|
22
|
-
|
|
19
|
+
- Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:
|
|
23
20
|
|
|
24
|
-
|
|
21
|
+
$ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'
|
|
25
22
|
|
|
26
|
-
# flags.
|
|
23
|
+
# flags.root-dir.summary
|
|
27
24
|
|
|
28
|
-
|
|
25
|
+
Source directory other than the default package to convert.
|
|
29
26
|
|
|
30
|
-
# flags.
|
|
27
|
+
# flags.output-dir.summary
|
|
31
28
|
|
|
32
|
-
|
|
29
|
+
Output directory to store the Metadata API–formatted files in.
|
|
33
30
|
|
|
34
|
-
# flags.
|
|
31
|
+
# flags.package-name.summary
|
|
35
32
|
|
|
36
|
-
|
|
33
|
+
Name of the package to associate with the metadata-formatted files.
|
|
37
34
|
|
|
38
|
-
# flags.
|
|
35
|
+
# flags.manifest.summary
|
|
39
36
|
|
|
40
|
-
|
|
37
|
+
Path to the manifest (package.xml) file that specifies the metadata types to convert.
|
|
41
38
|
|
|
42
|
-
# flags.
|
|
39
|
+
# flags.source-dir.summary
|
|
43
40
|
|
|
44
|
-
|
|
41
|
+
Comma-separated list of paths to the local source files to convert.
|
|
45
42
|
|
|
46
|
-
#
|
|
43
|
+
# flags.metadata.summary
|
|
47
44
|
|
|
48
|
-
-
|
|
45
|
+
Comma-separated list of metadata component names to convert.
|
|
49
46
|
|
|
50
|
-
|
|
47
|
+
# flags.manifest.description
|
|
51
48
|
|
|
52
|
-
|
|
49
|
+
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
53
50
|
|
|
54
|
-
|
|
51
|
+
# flags.source-dir.description
|
|
55
52
|
|
|
56
|
-
|
|
53
|
+
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).
|
|
54
|
+
|
|
55
|
+
If you specify this parameter, don’t specify --manifest or --metadata.
|
|
57
56
|
|
|
58
57
|
# success
|
|
59
58
|
|
|
@@ -1,98 +1,110 @@
|
|
|
1
1
|
# summary
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Delete source from your project and from a non-source-tracked org.
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
delete
|
|
8
|
-
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.
|
|
7
|
+
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, "sf project deploy start".
|
|
9
8
|
|
|
10
|
-
|
|
11
|
-
To remove deleted items from scratch orgs, which have change tracking, use "sf project deploy start".
|
|
9
|
+
When you run this command, both the local source file and the metadata component in the org are deleted.
|
|
12
10
|
|
|
13
11
|
# examples
|
|
14
12
|
|
|
15
|
-
-
|
|
13
|
+
- Delete all local Apex source files and all Apex classes from the org with alias "my-scratch":
|
|
16
14
|
|
|
17
|
-
|
|
15
|
+
<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch
|
|
18
16
|
|
|
19
|
-
|
|
17
|
+
- Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:
|
|
20
18
|
|
|
21
|
-
|
|
19
|
+
<%= config.bin %> <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata "Profile: My Profile" --no-prompt
|
|
22
20
|
|
|
23
|
-
|
|
21
|
+
- 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:
|
|
24
22
|
|
|
25
|
-
|
|
23
|
+
<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source
|
|
26
24
|
|
|
27
|
-
|
|
25
|
+
- Delete the Apex source files in a directory and the corresponding components from your default org:
|
|
28
26
|
|
|
29
|
-
|
|
27
|
+
<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes
|
|
30
28
|
|
|
31
|
-
|
|
29
|
+
- Delete all components listed in a manifest:
|
|
32
30
|
|
|
33
|
-
|
|
31
|
+
<%= config.bin %> <%= command.id %> --manifest path/to/package.xml
|
|
34
32
|
|
|
35
|
-
# flags.
|
|
33
|
+
# flags.source-dir.summary
|
|
36
34
|
|
|
37
|
-
|
|
35
|
+
Comma-separated list of source file paths to delete.
|
|
38
36
|
|
|
39
|
-
# flags.
|
|
37
|
+
# flags.metadata.summary
|
|
40
38
|
|
|
41
|
-
|
|
39
|
+
Comma-separated list of names of metadata components to delete.
|
|
42
40
|
|
|
43
|
-
# flags.
|
|
41
|
+
# flags.no-prompt.summary
|
|
44
42
|
|
|
45
|
-
|
|
43
|
+
Don't prompt for delete confirmation.
|
|
46
44
|
|
|
47
|
-
# flags.
|
|
45
|
+
# flags.wait.summary
|
|
48
46
|
|
|
49
|
-
|
|
47
|
+
Number of minutes to wait for the command to finish.
|
|
50
48
|
|
|
51
|
-
# flags.
|
|
49
|
+
# flags.check-only.summary
|
|
52
50
|
|
|
53
|
-
|
|
51
|
+
Validate delete command but don't delete anything from the org or the local project.
|
|
54
52
|
|
|
55
|
-
#
|
|
53
|
+
# flags.test-Level.summary
|
|
56
54
|
|
|
57
|
-
|
|
55
|
+
Deployment Apex testing level.
|
|
58
56
|
|
|
59
|
-
|
|
57
|
+
# flags.track-source.summary
|
|
60
58
|
|
|
61
|
-
|
|
59
|
+
If the delete succeeds, update the source tracking information.
|
|
62
60
|
|
|
63
|
-
|
|
61
|
+
# flags.force-overwrite.summary
|
|
64
62
|
|
|
65
|
-
|
|
63
|
+
Ignore conflict warnings and overwrite changes to the org.
|
|
66
64
|
|
|
67
|
-
|
|
65
|
+
# flags.verbose.summary
|
|
68
66
|
|
|
69
|
-
|
|
67
|
+
Verbose output of the delete result.
|
|
70
68
|
|
|
71
|
-
|
|
69
|
+
# flags.check-only.description
|
|
72
70
|
|
|
73
|
-
|
|
71
|
+
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.
|
|
74
72
|
|
|
75
|
-
|
|
73
|
+
Validates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.
|
|
76
74
|
|
|
77
|
-
|
|
75
|
+
If 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.
|
|
78
76
|
|
|
79
|
-
-
|
|
77
|
+
If 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.
|
|
80
78
|
|
|
81
|
-
|
|
79
|
+
Note: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.
|
|
82
80
|
|
|
83
|
-
|
|
81
|
+
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.
|
|
84
82
|
|
|
85
|
-
|
|
83
|
+
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.
|
|
86
84
|
|
|
87
|
-
|
|
85
|
+
# flags.metadata.description
|
|
88
86
|
|
|
89
|
-
|
|
87
|
+
If you specify this parameter, don’t specify --source-dir.
|
|
90
88
|
|
|
91
|
-
|
|
89
|
+
# flags.source-dir.description
|
|
90
|
+
|
|
91
|
+
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).
|
|
92
|
+
|
|
93
|
+
If you specify this parameter, don’t specify --metadata.
|
|
92
94
|
|
|
95
|
+
# flags.wait.description
|
|
96
|
+
|
|
97
|
+
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
98
|
+
|
|
99
|
+
# flags.test-Level.description
|
|
100
|
+
|
|
101
|
+
Valid values are:
|
|
102
|
+
|
|
103
|
+
- 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.
|
|
104
|
+
- 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.
|
|
93
105
|
- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
|
|
94
106
|
|
|
95
|
-
|
|
107
|
+
If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.
|
|
96
108
|
|
|
97
109
|
# localPrompt
|
|
98
110
|
|
|
@@ -1,29 +1,34 @@
|
|
|
1
|
-
#
|
|
1
|
+
# resetSummary
|
|
2
|
+
|
|
3
|
+
Reset local and remote source tracking.
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
# resetDescription
|
|
4
6
|
|
|
5
7
|
WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.
|
|
6
8
|
|
|
7
|
-
Resets local and remote source tracking so that
|
|
9
|
+
Resets local and remote source tracking so that Salesforce CLI no longer registers differences between your local files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.
|
|
8
10
|
|
|
9
|
-
Use the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the
|
|
10
|
-
$ sfdx force:data:soql:query -q "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" -t
|
|
11
|
+
Use the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:
|
|
11
12
|
|
|
12
|
-
|
|
13
|
+
<%= config.bin %> data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api
|
|
13
14
|
|
|
14
|
-
|
|
15
|
+
# deleteSummary
|
|
16
|
+
|
|
17
|
+
Delete all local source tracking information.
|
|
18
|
+
|
|
19
|
+
# deleteDescription
|
|
15
20
|
|
|
16
21
|
WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.
|
|
17
22
|
|
|
18
|
-
Deletes all local source tracking information. When you next run 'project deploy preview',
|
|
23
|
+
Deletes 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.
|
|
19
24
|
|
|
20
|
-
# no-
|
|
25
|
+
# flags.no-prompt.summary
|
|
21
26
|
|
|
22
|
-
|
|
27
|
+
Don't prompt for source tracking override confirmation.
|
|
23
28
|
|
|
24
|
-
#
|
|
29
|
+
# flags.revision.summary
|
|
25
30
|
|
|
26
|
-
|
|
31
|
+
SourceMember revision counter number to reset to.
|
|
27
32
|
|
|
28
33
|
# promptMessage
|
|
29
34
|
|
|
@@ -1,14 +1,17 @@
|
|
|
1
|
+
# summary
|
|
2
|
+
|
|
3
|
+
Create a project manifest that lists the metadata components you want to deploy or retrieve.
|
|
4
|
+
|
|
1
5
|
# description
|
|
2
6
|
|
|
3
|
-
create a project manifest that lists the metadata components you want to deploy or retrieve
|
|
4
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.
|
|
5
8
|
|
|
6
9
|
Use --manifest-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:
|
|
7
10
|
|
|
8
|
-
package : package.xml (default)
|
|
9
|
-
pre : destructiveChangesPre.xml
|
|
10
|
-
post : destructiveChangesPost.xml
|
|
11
|
-
destroy : destructiveChanges.xml
|
|
11
|
+
* package : package.xml (default)
|
|
12
|
+
* pre : destructiveChangesPre.xml
|
|
13
|
+
* post : destructiveChangesPost.xml
|
|
14
|
+
* destroy : destructiveChanges.xml
|
|
12
15
|
|
|
13
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.
|
|
14
17
|
|
|
@@ -16,41 +19,49 @@ Use --manifest-name to specify a custom name for the generated manifest if the p
|
|
|
16
19
|
|
|
17
20
|
# examples
|
|
18
21
|
|
|
19
|
-
-
|
|
22
|
+
- Create a manifest for deploying or retrieving all Apex classes:
|
|
23
|
+
|
|
24
|
+
$ <%= config.bin %> <%= command.id %> --metadata ApexClass
|
|
25
|
+
|
|
26
|
+
- Create a manifest for deleting the specified Apex class:
|
|
27
|
+
|
|
28
|
+
$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --manifest-type destroy
|
|
29
|
+
|
|
30
|
+
- Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:
|
|
20
31
|
|
|
21
|
-
|
|
32
|
+
$ <%= config.bin %> <%= command.id %> --source-dir force-app --manifest-name myNewManifest
|
|
22
33
|
|
|
23
|
-
-
|
|
34
|
+
- Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:
|
|
24
35
|
|
|
25
|
-
|
|
36
|
+
$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --include-packages unlocked
|
|
26
37
|
|
|
27
|
-
# flags.include-packages
|
|
38
|
+
# flags.include-packages.summary
|
|
28
39
|
|
|
29
|
-
|
|
40
|
+
Comma-separated list of package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored.
|
|
30
41
|
|
|
31
|
-
# flags.from-org
|
|
42
|
+
# flags.from-org.summary
|
|
32
43
|
|
|
33
|
-
|
|
44
|
+
Username or alias of the org that contains the metadata components from which to build a manifest.
|
|
34
45
|
|
|
35
|
-
# flags.manifest-type
|
|
46
|
+
# flags.manifest-type.summary
|
|
36
47
|
|
|
37
|
-
|
|
48
|
+
Type of manifest to create; the type determines the name of the created file.
|
|
38
49
|
|
|
39
|
-
# flags.manifest-name
|
|
50
|
+
# flags.manifest-name.summary
|
|
40
51
|
|
|
41
|
-
|
|
52
|
+
Name of a custom manifest file to create.
|
|
42
53
|
|
|
43
|
-
# flags.output-dir
|
|
54
|
+
# flags.output-dir.summary
|
|
44
55
|
|
|
45
|
-
|
|
56
|
+
Directory to save the created manifest.
|
|
46
57
|
|
|
47
|
-
# flags.source-dir
|
|
58
|
+
# flags.source-dir.summary
|
|
48
59
|
|
|
49
|
-
|
|
60
|
+
Comma-separated list of paths to the local source files to include in the manifest.
|
|
50
61
|
|
|
51
|
-
# flags.metadata
|
|
62
|
+
# flags.metadata.summary
|
|
52
63
|
|
|
53
|
-
|
|
64
|
+
Comma-separated list of names of metadata components to include in the manifest.
|
|
54
65
|
|
|
55
66
|
# success
|
|
56
67
|
|