From 9decd11784ed47152dcdac5c09a55d56f154ab97 Mon Sep 17 00:00:00 2001 From: mshanemc Date: Thu, 30 May 2024 14:00:19 -0500 Subject: [PATCH 1/2] docs: restore some config.bin for --help stuff --- messages/convert.mdapi.md | 4 ++-- messages/convert.source.md | 8 +++---- messages/delete.source.md | 10 ++++----- messages/delete.tracking.md | 8 +++---- messages/deploy.metadata.cancel.md | 16 +++++++------- messages/deploy.metadata.md | 28 +++++++++++------------ messages/deploy.metadata.preview.md | 14 ++++++------ messages/deploy.metadata.quick.md | 12 +++++----- messages/deploy.metadata.report.md | 14 ++++++------ messages/deploy.metadata.resume.md | 14 ++++++------ messages/deploy.metadata.validate.md | 18 +++++++-------- messages/list.ignored.md | 6 ++--- messages/manifest.generate.md | 8 +++---- messages/retrieve.metadata.preview.md | 8 +++---- messages/retrieve.start.md | 32 +++++++++++++-------------- 15 files changed, 100 insertions(+), 100 deletions(-) diff --git a/messages/convert.mdapi.md b/messages/convert.mdapi.md index e4bd52f9a..322fed6ba 100644 --- a/messages/convert.mdapi.md +++ b/messages/convert.mdapi.md @@ -14,11 +14,11 @@ To convert multiple metadata components, either set multiple --metadata f - Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory: - $ sf <%= command.id %> --root-dir path/to/metadata + $ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata - Similar to previous example, but writes converted files to the specified output directory: - $ sf <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir + $ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir # flags.root-dir.summary diff --git a/messages/convert.source.md b/messages/convert.source.md index 943c93e0f..9fc49455e 100644 --- a/messages/convert.source.md +++ b/messages/convert.source.md @@ -4,9 +4,9 @@ Convert source-formatted files into metadata that you can deploy using Metadata # description -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 "sf project deploy". +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". -To convert Metadata API–formatted files into the source format, run "sf project convert mdapi". +To convert Metadata API–formatted files into the source format, run "<%= config.bin %> project convert mdapi". To specify a package name that includes spaces, enclose the name in single quotes. @@ -16,11 +16,11 @@ To convert multiple components, either set multiple --metadata flags or a - Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory: - $ sf <%= command.id %> --root-dir path/to/source + $ <%= config.bin %> <%= command.id %> --root-dir path/to/source - Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package: - $ sf <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package' + $ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package' # flags.api-version.summary diff --git a/messages/delete.source.md b/messages/delete.source.md index 6f5697c22..1124b031c 100644 --- a/messages/delete.source.md +++ b/messages/delete.source.md @@ -4,7 +4,7 @@ Delete source from your project and from a non-source-tracked org. # description -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". +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, "<%= config.bin %> project deploy start". When you run this command, both the local source file and the metadata component in the org are deleted. @@ -14,19 +14,19 @@ To delete multiple metadata components, either set multiple --metadata fl - Delete all local Apex source files and all Apex classes from the org with alias "my-scratch": - sf <%= command.id %> --metadata ApexClass --target-org my-scratch + <%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch - Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation: - sf <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata "Profile: My Profile" --no-prompt + <%= config.bin %> <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata "Profile: My Profile" --no-prompt - 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: - sf <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source + <%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source - Delete the Apex source files in a directory and the corresponding components from your default org: - sf <%= command.id %> --source-dir force-app/main/default/classes + <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes # flags.source-dir.summary diff --git a/messages/delete.tracking.md b/messages/delete.tracking.md index f16dda75e..127f2c9da 100644 --- a/messages/delete.tracking.md +++ b/messages/delete.tracking.md @@ -10,23 +10,23 @@ Resets local and remote source tracking so that Salesforce CLI no longer registe 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: - sf data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api --target-org my-scratch + <%= config.bin %> data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api --target-org my-scratch # resetExample - Reset source tracking for the org with alias "my-scratch": - $ sf <%= command.id %> --target-org my-scratch + $ <%= config.bin %> <%= command.id %> --target-org my-scratch - Reset source tracking to revision number 30 for your default org: - $ sf <%= command.id %> --revision 30 + $ <%= config.bin %> <%= command.id %> --revision 30 # deleteExample - Delete local source tracking for the org with alias "my-scratch": - $ sf <%= command.id %> --target-org my-scratch + $ <%= config.bin %> <%= command.id %> --target-org my-scratch # deleteSummary diff --git a/messages/deploy.metadata.cancel.md b/messages/deploy.metadata.cancel.md index a47c09bac..5d6979270 100644 --- a/messages/deploy.metadata.cancel.md +++ b/messages/deploy.metadata.cancel.md @@ -12,11 +12,11 @@ Run this command by either passing it a job ID or specifying the --use-most-rece - Cancel a deploy operation using a job ID: - sf <%= command.id %> --job-id 0Af0x000017yLUFCA2 + <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 - Cancel the most recent deploy operation: - sf <%= command.id %> --use-most-recent + <%= config.bin %> <%= command.id %> --use-most-recent # flags.job-id.summary @@ -26,10 +26,10 @@ Job ID of the deploy operation you want to cancel. These commands return a job ID if they time out or you specified the --async flag: -- sf project deploy start -- sf project deploy validate -- sf project deploy quick -- sf project deploy cancel +- <%= config.bin %> project deploy start +- <%= config.bin %> project deploy validate +- <%= config.bin %> project deploy quick +- <%= config.bin %> project deploy cancel The job ID is valid for 10 days from when you started the deploy operation. @@ -47,7 +47,7 @@ Number of minutes to wait for the command to complete and display results. # flags.wait.description -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". +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 "<%= config.bin %> project deploy resume". To check the status of the cancellation, run "<%= config.bin %> project deploy report". # flags.async.summary @@ -55,7 +55,7 @@ Run the command asynchronously. # flags.async.description -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". +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 "<%= config.bin %> project deploy resume". To check the status of the cancellation, run "<%= config.bin %> project deploy report". # error.CannotCancelDeploy diff --git a/messages/deploy.metadata.md b/messages/deploy.metadata.md index 2b41fec69..3fb2ce9ef 100644 --- a/messages/deploy.metadata.md +++ b/messages/deploy.metadata.md @@ -8,7 +8,7 @@ You must run this command from within a project. 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. -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. +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. @@ -20,41 +20,41 @@ To deploy multiple metadata components, either set multiple --metadata fl - 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: - sf <%= command.id %> --source-dir force-app --target-org my-scratch --concise + <%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch --concise - 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: - sf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects - sf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects + <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects + <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects - Deploy all Apex classes that are in all package directories defined in the "sfdx-project.json" file: - sf <%= command.id %> --metadata ApexClass + <%= config.bin %> <%= command.id %> --metadata ApexClass - 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!): - sf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts + <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts - 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): - sf <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings + <%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings - Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent): - sf <%= command.id %> --metadata CustomObject ApexClass - sf <%= command.id %> --metadata CustomObject --metadata ApexClass + <%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass + <%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass - Deploy all Apex classes and a profile that has a space in its name: - sf <%= command.id %> --metadata ApexClass --metadata "Profile:My Profile" + <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata "Profile:My Profile" - Deploy all components listed in a manifest: - sf <%= command.id %> --manifest path/to/package.xml + <%= config.bin %> <%= command.id %> --manifest path/to/package.xml - Run the tests that aren’t in any managed packages as part of a deployment: - sf <%= command.id %> --metadata ApexClass --test-level RunLocalTests + <%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests # flags.target-org.summary @@ -114,7 +114,7 @@ Number of minutes to wait for command to complete and display results. # flags.wait.description -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". +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 "<%= config.bin %> project deploy resume". To check the status of the deployment, run "<%= config.bin %> project deploy report". # flags.manifest.summary @@ -176,7 +176,7 @@ Run the command asynchronously. # flags.async.description -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". +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 "<%= config.bin %> project deploy resume". To check the status of the deployment, run "<%= config.bin %> project deploy report". # flags.metadata-dir.summary diff --git a/messages/deploy.metadata.preview.md b/messages/deploy.metadata.preview.md index 9aa096ff3..6e9b5e433 100644 --- a/messages/deploy.metadata.preview.md +++ b/messages/deploy.metadata.preview.md @@ -6,31 +6,31 @@ Preview a deployment to see what will deploy to the org, the potential conflicts You must run this command from within a project. -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. +The command outputs a table that describes what will happen if you run the "<%= config.bin %> 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. -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. +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. # examples -- 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. +- 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 "<%= config.bin %> project deploy start" for more examples that you can adapt for previewing. - Preview the deployment of source files in a directory, such as force-app, to your default org: - sf <%= command.id %> --source-dir force-app + <%= config.bin %> <%= command.id %> --source-dir force-app - Preview the deployment of all Apex classes to an org with alias "my-scratch": - sf <%= command.id %> --metadata ApexClass --target-org my-scratch + <%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch - Preview deployment of a specific Apex class: - sf <%= command.id %> --metadata ApexClass:MyApexClass + <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass - Preview deployment of all components listed in a manifest: - sf <%= command.id %> --manifest path/to/package.xml + <%= config.bin %> <%= command.id %> --manifest path/to/package.xml # flags.target-org.summary diff --git a/messages/deploy.metadata.quick.md b/messages/deploy.metadata.quick.md index ea494115c..f77544d48 100644 --- a/messages/deploy.metadata.quick.md +++ b/messages/deploy.metadata.quick.md @@ -4,23 +4,23 @@ Quickly deploy a validated deployment to an org. # description -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. +Before you run this command, first create a validated deployment with the "<%= config.bin %> 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. 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. 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. -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. +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 "<%= config.bin %> project deploy start" instead. # examples - Run a quick deploy to your default org using a job ID: - sf <%= command.id %> --job-id 0Af0x000017yLUFCA2 + <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 - Asynchronously run a quick deploy of the most recently validated deployment to an org with alias "my-prod-org": - sf <%= command.id %> --async --use-most-recent --target-org my-prod-org + <%= config.bin %> <%= command.id %> --async --use-most-recent --target-org my-prod-org # flags.job-id.summary @@ -52,7 +52,7 @@ Number of minutes to wait for the command to complete and display results. # flags.wait.description -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". +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 "<%= config.bin %> project deploy resume". To check the status of the deploy, run "<%= config.bin %> project deploy report". # flags.verbose.summary @@ -68,7 +68,7 @@ Run the command asynchronously. # flags.async.description -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". +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 "<%= config.bin %> project deploy resume". To check the status of the deploy, run "<%= config.bin %> project deploy report". # flags.target-org.summary diff --git a/messages/deploy.metadata.report.md b/messages/deploy.metadata.report.md index bbd1c36d4..9833e0e0f 100644 --- a/messages/deploy.metadata.report.md +++ b/messages/deploy.metadata.report.md @@ -16,15 +16,15 @@ This command doesn't update source tracking information. - Check the status using a job ID: - sf <%= command.id %> --job-id 0Af0x000017yLUFCA2 + <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 - Check the status of the most recent deploy operation: - sf <%= command.id %> --use-most-recent + <%= config.bin %> <%= command.id %> --use-most-recent - Poll for the status using a job ID and target org: - sf <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30 + <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30 # flags.job-id.summary @@ -34,10 +34,10 @@ Job ID of the deploy operation you want to check the status of. These commands return a job ID if they time out or you specified the --async flag: -- sf project deploy start -- sf project deploy validate -- sf project deploy quick -- sf project deploy cancel +- <%= config.bin %> project deploy start +- <%= config.bin %> project deploy validate +- <%= config.bin %> project deploy quick +- <%= config.bin %> project deploy cancel The job ID is valid for 10 days from when you started the deploy operation. diff --git a/messages/deploy.metadata.resume.md b/messages/deploy.metadata.resume.md index 5531f9772..4b417fabb 100644 --- a/messages/deploy.metadata.resume.md +++ b/messages/deploy.metadata.resume.md @@ -12,11 +12,11 @@ Run this command by either passing it a job ID or specifying the --use-most-rece - Resume watching a deploy operation using a job ID: - sf <%= command.id %> --job-id 0Af0x000017yLUFCA2 + <%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 - Resume watching the most recent deploy operation: - sf <%= command.id %> --use-most-recent + <%= config.bin %> <%= command.id %> --use-most-recent # flags.job-id.summary @@ -26,10 +26,10 @@ Job ID of the deploy operation you want to resume. These commands return a job ID if they time out or you specified the --async flag: -- sf project deploy start -- sf project deploy validate -- sf project deploy quick -- sf project deploy cancel +- <%= config.bin %> project deploy start +- <%= config.bin %> project deploy validate +- <%= config.bin %> project deploy quick +- <%= config.bin %> project deploy cancel The job ID is valid for 10 days from when you started the deploy operation. @@ -47,7 +47,7 @@ Number of minutes to wait for the command to complete and display results. # flags.wait.description -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". +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 "<%= config.bin %> project deploy report". # flags.verbose.summary diff --git a/messages/deploy.metadata.validate.md b/messages/deploy.metadata.validate.md index 8519e7045..8c170772d 100644 --- a/messages/deploy.metadata.validate.md +++ b/messages/deploy.metadata.validate.md @@ -4,7 +4,7 @@ Validate a metadata deployment without actually executing it. # description -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. +Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to "<%= config.bin %> 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 "<%= config.bin %> 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. You must run this command from within a project. @@ -12,27 +12,27 @@ This command doesn't support source-tracking. When you quick deploy with the res 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. -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. +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. # examples -- 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. +- NOTE: These examples focus on validating large deployments. See the help for "<%= config.bin %> project deploy start" for examples of deploying smaller sets of metadata which you can also use to validate. - Validate the deployment of all source files in the "force-app" directory to the default org: - sf <%= command.id %> --source-dir force-app + <%= config.bin %> <%= command.id %> --source-dir force-app - Validate the deployment of all source files in two directories: "force-app" and "force-app-utils": - sf <%= command.id %> --source-dir force-app --source-dir force-app-utils + <%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils - Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately returns the job ID: - sf <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org + <%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org - Validate the deployment of all components listed in a manifest: - sf <%= command.id %> --manifest path/to/package.xml + <%= config.bin %> <%= command.id %> --manifest path/to/package.xml # flags.target-org.summary @@ -76,7 +76,7 @@ Number of minutes to wait for the command to complete and display results. # flags.wait.description -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". +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 "<%= config.bin %> project deploy resume". To check the status of the validation, run "<%= config.bin %> project deploy report". # flags.manifest.summary @@ -112,7 +112,7 @@ Run the command asynchronously. # flags.async.description -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". +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 "<%= config.bin %> project deploy resume". To check the status of the validation, run "<%= config.bin %> project deploy report". # flags.metadata-dir.summary diff --git a/messages/list.ignored.md b/messages/list.ignored.md index 0034778c3..932bd4cd4 100644 --- a/messages/list.ignored.md +++ b/messages/list.ignored.md @@ -10,15 +10,15 @@ When deploying or retrieving metadata between your local project and an org, you - List all the files in all package directories that are ignored: - sf <%= command.id %> + <%= config.bin %> <%= command.id %> - List all the files in a specific directory that are ignored: - sf <%= command.id %> --source-dir force-app + <%= config.bin %> <%= command.id %> --source-dir force-app - Check if a particular file is ignored: - sf <%= command.id %> --source-dir package.xml + <%= config.bin %> <%= command.id %> --source-dir package.xml # flags.source-dir.summary diff --git a/messages/manifest.generate.md b/messages/manifest.generate.md index c7c29121e..9a221d9ab 100644 --- a/messages/manifest.generate.md +++ b/messages/manifest.generate.md @@ -23,19 +23,19 @@ To include multiple metadata components, either set multiple --metadata f - Create a manifest for deploying or retrieving all Apex classes and custom objects: - $ sf <%= command.id %> --metadata ApexClass --metadata CustomObject + $ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject - Create a manifest for deleting the specified Apex class: - $ sf <%= command.id %> --metadata ApexClass:MyApexClass --type destroy + $ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy - Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml: - $ sf <%= command.id %> --source-dir force-app --name myNewManifest + $ <%= config.bin %> <%= command.id %> --source-dir force-app --name myNewManifest - Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages: - $ sf <%= command.id %> --from-org test@myorg.com --include-packages unlocked + $ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --include-packages unlocked # flags.include-packages.summary diff --git a/messages/retrieve.metadata.preview.md b/messages/retrieve.metadata.preview.md index 9f00f02ca..d98d3087c 100644 --- a/messages/retrieve.metadata.preview.md +++ b/messages/retrieve.metadata.preview.md @@ -6,19 +6,19 @@ Preview a retrieval to see what will be retrieved from the org, the potential co You must run this command from within a project. -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. +The command outputs a table that describes what will happen if you run the "<%= config.bin %> 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. -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. +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. # examples - Preview the retrieve of all changes from your default org: - sf <%= command.id %> + <%= config.bin %> <%= command.id %> - Preview the retrieve when ignoring any conflicts from an org with alias "my-scratch": - sf <%= command.id %> --ignore-conflicts --target-org my-scratch + <%= config.bin %> <%= command.id %> --ignore-conflicts --target-org my-scratch # flags.target-org.summary diff --git a/messages/retrieve.start.md b/messages/retrieve.start.md index 9095bb030..576800536 100644 --- a/messages/retrieve.start.md +++ b/messages/retrieve.start.md @@ -8,7 +8,7 @@ You must run this command from within a project. 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. -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. +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. @@ -16,54 +16,54 @@ To retrieve multiple metadata components, either use multiple --metadata - Retrieve all remote changes from your default org: - sf <%= command.id %> + <%= config.bin %> <%= command.id %> - Retrieve the source files in the "force-app" directory from an org with alias "my-scratch": - sf <%= command.id %> --source-dir force-app --target-org my-scratch + <%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch - 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: - sf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects - sf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects + <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects + <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects - Retrieve all Apex classes that are in all package directories defined in the "sfdx-project.json" file: - sf <%= command.id %> --metadata ApexClass + <%= config.bin %> <%= command.id %> --metadata ApexClass - 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!): - sf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts + <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts - Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the string "MyApex": - sf <%= command.id %> --metadata 'ApexClass:MyApex*' + <%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' - Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent): - sf <%= command.id %> --metadata CustomObject ApexClass - sf <%= command.id %> --metadata CustomObject --metadata ApexClass + <%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass + <%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass - Retrieve all metadata components listed in a manifest: - sf <%= command.id %> --manifest path/to/package.xml + <%= config.bin %> <%= command.id %> --manifest path/to/package.xml - Retrieve metadata from a package: - sf <%= command.id %> --package-name MyPackageName + <%= config.bin %> <%= command.id %> --package-name MyPackageName - Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent): - sf <%= command.id %> --package-name Package1 "PackageName With Spaces" Package3 - sf <%= command.id %> --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3 + <%= config.bin %> <%= command.id %> --package-name Package1 "PackageName With Spaces" Package3 + <%= config.bin %> <%= command.id %> --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3 - Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the "output" directory: - sf <%= command.id %> --source-dir force-app --target-metadata-dir output + <%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output - Retrieve in metadata format and automatically extract the contents into the "output" directory: - sf <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip + <%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip # flags.api-version.summary From fca11a26a74e0436c6413b3c8492863ebe9e779c Mon Sep 17 00:00:00 2001 From: mshanemc Date: Mon, 3 Jun 2024 16:35:17 -0500 Subject: [PATCH 2/2] fix: the one I missed --- messages/deploy.metadata.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/messages/deploy.metadata.md b/messages/deploy.metadata.md index 3fb2ce9ef..60bf0eec6 100644 --- a/messages/deploy.metadata.md +++ b/messages/deploy.metadata.md @@ -16,7 +16,7 @@ To deploy multiple metadata components, either set multiple --metadata fl - Deploy local changes not in the org; uses your default org: - sf <%= command.id %> + <%= config.bin %> <%= command.id %> - 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: