Skip to content

Commit

Permalink
fix: you can't specify --manifest more than once (#1194)
Browse files Browse the repository at this point in the history
  • Loading branch information
jshackell-sfdc authored Nov 6, 2024
1 parent 21de9d8 commit 1471549
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 18 deletions.
6 changes: 3 additions & 3 deletions messages/convert.mdapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To use Salesforce CLI to work with components that you retrieved via Metadata AP

To convert files from the source format back to the metadata format, run "sf project convert source".

To convert multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
To convert multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.

# examples

Expand Down Expand Up @@ -42,7 +42,7 @@ Metadata component names to convert.

# flags.manifest.description

If you specify this parameter, don’t specify --metadata or --source-dir.
If you specify this flag, don’t specify --metadata or --source-dir.

# flags.metadata-dir.description

Expand All @@ -60,7 +60,7 @@ Expected a file but found a directory.

# InvalidFlagPath

The %s command parameter specifies an invalid path: %s
The %s command flag specifies an invalid path: %s
%s

# notFound
Expand Down
6 changes: 3 additions & 3 deletions messages/convert.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To convert Metadata API–formatted files into the source format, run "<%= confi

To specify a package name that includes spaces, enclose the name in single quotes.

To convert multiple components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
To convert multiple components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.

# examples

Expand Down Expand Up @@ -52,13 +52,13 @@ Metadata component names to convert.

# flags.manifest.description

If you specify this parameter, don’t specify --metadata or --source-dir.
If you specify this flag, don’t specify --metadata or --source-dir.

# flags.source-dir.description

The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).

If you specify this parameter, don’t specify --manifest or --metadata.
If you specify this flag, don’t specify --manifest or --metadata.

# success

Expand Down
8 changes: 4 additions & 4 deletions messages/delete.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Use this command to delete components from orgs that don’t have source trackin

When you run this command, both the local source file and the metadata component in the org are deleted.

To delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
To delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.

# examples

Expand Down Expand Up @@ -70,7 +70,7 @@ IMPORTANT: Where possible, we changed noninclusive terms to align with our compa

Validates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.

If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only 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.
If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only flag 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.

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.

Expand All @@ -82,13 +82,13 @@ Note: A Metadata API deletion that includes Master-Detail relationships deletes

# flags.metadata.description

If you specify this parameter, don’t specify --source-dir.
If you specify this flag, don’t specify --source-dir.

# flags.source-dir.description

The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).

If you specify this parameter, don’t specify --metadata.
If you specify this flag, don’t specify --metadata.

# flags.wait.description

Expand Down
2 changes: 1 addition & 1 deletion messages/delete.tracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ WARNING: This command deletes or overwrites all existing source tracking files.

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.

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:
Use the --revision flag 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:

<%= config.bin %> data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api --target-org my-scratch

Expand Down
2 changes: 1 addition & 1 deletion messages/deploy.metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Metadata components are deployed in source format by default. Deploy them in met

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 "<%= config.bin %> org create scratch|sandbox" commands.

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.
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 --source-dir.

# examples

Expand Down
2 changes: 1 addition & 1 deletion messages/deploy.metadata.preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The command outputs a table that describes what will happen if you run the "<%=

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 "<%= config.bin %> org create scratch|sandbox" commands.

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.
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 --source-dir.

# examples

Expand Down
2 changes: 1 addition & 1 deletion messages/deploy.metadata.validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You must run this command from within a project.

This command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.

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.
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 --source-dir.

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 "<%= config.bin %> project deploy start --dry-run --test-level RunLocalTests" instead.

Expand Down
4 changes: 2 additions & 2 deletions messages/manifest.generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Create a project manifest that lists the metadata components you want to deploy

# description

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.
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 flags, not both.

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:
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 flag, and their respective file names, are:

* package : package.xml (default)
* pre : destructiveChangesPre.xml
Expand Down
4 changes: 2 additions & 2 deletions messages/retrieve.start.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Metadata components are retrieved in source format by default. Retrieve them in

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 "<%= config.bin %> org create scratch|sandbox" commands.

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.
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 --source-dir.

# examples

Expand Down Expand Up @@ -95,7 +95,7 @@ File path for the manifest (package.xml) that specifies the components to retrie

# flags.manifest.description

If you specify this parameter, don’t specify --metadata or --source-dir.
If you specify this flag, don’t specify --metadata or --source-dir.

# flags.metadata.summary

Expand Down

0 comments on commit 1471549

Please sign in to comment.