Skip to content

Commit f321a6e

Browse files
refactor: messages for deploy|retrieve in md format (#332)
* fix: edit messages * fix: update with info about metadata format
1 parent 6d7ea9b commit f321a6e

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

messages/deploy.metadata.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# summary
22

3-
Deploy metadata in source format to an org from your local project.
3+
Deploy metadata to an org from your local project.
44

55
# description
66

77
You must run this command from within a project.
88

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+
911
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production org, never allow source tracking. You can also use the "--no-track-source" flag when you create a scratch or sandbox org to disable source tracking.
1012

1113
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.

messages/retrieve.metadata.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# summary
22

3-
Retrieve metadata in source format from an org to your local project.
3+
Retrieve metadata from an org to your local project.
44

55
# description
66

77
You must run this command from within a project.
88

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+
911
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production org, never allow source tracking. You can also use the "--no-track-source" flag when you create a scratch or sandbox org to disable source tracking.
1012

1113
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.
@@ -51,11 +53,11 @@ To retrieve multiple metadata components, either use multiple --metadata <name>
5153
<%= config.bin %> <%= command.id %> --package-name Package1 "PackageName With Spaces" Package3
5254
<%= config.bin %> <%= command.id %> --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
5355

54-
- Retrieve using Metadata API
56+
- Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the "output" directory:
5557

5658
<%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output
5759

58-
- Retrieve using Metadata API and automatically unzip the contents
60+
- Retrieve in metadata format and automatically extract the contents into the "output" directory:
5961

6062
<%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip
6163

@@ -125,7 +127,7 @@ Indicates that the zip file points to a directory structure for a single package
125127

126128
# flags.target-metadata-dir.summary
127129

128-
Directory root for the retrieved files.
130+
Directory that will contain the retrieved metadata format files or ZIP.
129131

130132
# flags.unzip.summary
131133

0 commit comments

Comments
 (0)