From 14715492ead3e342965ea743443bbb98f10cae59 Mon Sep 17 00:00:00 2001 From: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> Date: Wed, 6 Nov 2024 11:16:35 -0800 Subject: [PATCH] fix: you can't specify --manifest more than once (#1194) --- messages/convert.mdapi.md | 6 +++--- messages/convert.source.md | 6 +++--- messages/delete.source.md | 8 ++++---- messages/delete.tracking.md | 2 +- messages/deploy.metadata.md | 2 +- messages/deploy.metadata.preview.md | 2 +- messages/deploy.metadata.validate.md | 2 +- messages/manifest.generate.md | 4 ++-- messages/retrieve.start.md | 4 ++-- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/messages/convert.mdapi.md b/messages/convert.mdapi.md index 322fed6b..2716cd2e 100644 --- a/messages/convert.mdapi.md +++ b/messages/convert.mdapi.md @@ -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 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 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 @@ -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 @@ -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 diff --git a/messages/convert.source.md b/messages/convert.source.md index 9fc49455..14ae69e8 100644 --- a/messages/convert.source.md +++ b/messages/convert.source.md @@ -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 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 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 @@ -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 diff --git a/messages/delete.source.md b/messages/delete.source.md index 1124b031..da571700 100644 --- a/messages/delete.source.md +++ b/messages/delete.source.md @@ -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 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 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 @@ -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. @@ -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 diff --git a/messages/delete.tracking.md b/messages/delete.tracking.md index 127f2c9d..b7cdaa70 100644 --- a/messages/delete.tracking.md +++ b/messages/delete.tracking.md @@ -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 diff --git a/messages/deploy.metadata.md b/messages/deploy.metadata.md index a35d1579..34983887 100644 --- a/messages/deploy.metadata.md +++ b/messages/deploy.metadata.md @@ -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 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 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 diff --git a/messages/deploy.metadata.preview.md b/messages/deploy.metadata.preview.md index f3e0766a..3b038c6c 100644 --- a/messages/deploy.metadata.preview.md +++ b/messages/deploy.metadata.preview.md @@ -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 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 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 diff --git a/messages/deploy.metadata.validate.md b/messages/deploy.metadata.validate.md index 46673d49..6b1fe0e4 100644 --- a/messages/deploy.metadata.validate.md +++ b/messages/deploy.metadata.validate.md @@ -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 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 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. diff --git a/messages/manifest.generate.md b/messages/manifest.generate.md index 9a221d9a..be2d5549 100644 --- a/messages/manifest.generate.md +++ b/messages/manifest.generate.md @@ -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 diff --git a/messages/retrieve.start.md b/messages/retrieve.start.md index 12fa5e27..74310830 100644 --- a/messages/retrieve.start.md +++ b/messages/retrieve.start.md @@ -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 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 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 @@ -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