diff --git a/CHANGELOG.md b/CHANGELOG.md index fb01b6a9..2634fd19 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## [1.19.3](https://github.com/salesforcecli/plugin-deploy-retrieve/compare/1.19.2...1.19.3) (2023-10-31) + +### Bug Fixes + +- bump sdr and stl ([1311e78](https://github.com/salesforcecli/plugin-deploy-retrieve/commit/1311e78103c1e39044101dc0556469db875a7501)) + ## [1.19.2](https://github.com/salesforcecli/plugin-deploy-retrieve/compare/1.19.1...1.19.2) (2023-10-17) ### Bug Fixes diff --git a/README.md b/README.md index 0ef1a787..206f9a70 100644 --- a/README.md +++ b/README.md @@ -64,173 +64,248 @@ sf plugins -- [`sf deploy`](#sf-deploy) -- [`sf deploy metadata`](#sf-deploy-metadata) -- [`sf deploy metadata cancel`](#sf-deploy-metadata-cancel) -- [`sf deploy metadata preview`](#sf-deploy-metadata-preview) -- [`sf deploy metadata quick`](#sf-deploy-metadata-quick) -- [`sf deploy metadata report`](#sf-deploy-metadata-report) -- [`sf deploy metadata resume`](#sf-deploy-metadata-resume) -- [`sf deploy metadata validate`](#sf-deploy-metadata-validate) -- [`sf retrieve metadata`](#sf-retrieve-metadata) -- [`sf retrieve metadata preview`](#sf-retrieve-metadata-preview) - -## `sf deploy` - -Deploy a project interactively to any Salesforce environment. +- [`sf project convert mdapi`](#sf-project-convert-mdapi) +- [`sf project convert source`](#sf-project-convert-source) +- [`sf project delete source`](#sf-project-delete-source) +- [`sf project delete tracking`](#sf-project-delete-tracking) +- [`sf project deploy cancel`](#sf-project-deploy-cancel) +- [`sf project deploy preview`](#sf-project-deploy-preview) +- [`sf project deploy quick`](#sf-project-deploy-quick) +- [`sf project deploy report`](#sf-project-deploy-report) +- [`sf project deploy resume`](#sf-project-deploy-resume) +- [`sf project deploy start`](#sf-project-deploy-start) +- [`sf project deploy validate`](#sf-project-deploy-validate) +- [`sf project generate manifest`](#sf-project-generate-manifest) +- [`sf project list ignored`](#sf-project-list-ignored) +- [`sf project reset tracking`](#sf-project-reset-tracking) +- [`sf project retrieve preview`](#sf-project-retrieve-preview) +- [`sf project retrieve start`](#sf-project-retrieve-start) + +## `sf project convert mdapi` + +Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects. ``` USAGE - $ sf deploy [--interactive] + $ sf project convert mdapi -r [--json] [--api-version ] [-d ] [-p | -x | -m + ] FLAGS - --interactive Force the CLI to prompt for all deployment inputs. + -d, --output-dir= Directory to store your files in after they’re converted to source format; can be an + absolute or relative path. + -m, --metadata=... Metadata component names to convert. + -p, --metadata-dir=... Root of directory or zip file of metadata formatted files to convert. + -r, --root-dir= (required) Root directory that contains the Metadata API–formatted metadata. + -x, --manifest= File path to manifest (package.xml) of metadata types to convert. + --api-version= Override the api version used for api requests made by this command -DESCRIPTION - Deploy a project interactively to any Salesforce environment. +GLOBAL FLAGS + --json Format output as json. - This command must be run from within a project. +DESCRIPTION + Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects. - The command first analyzes your project, your active or logged-into environments, and local defaults to determine what - to deploy and where to deploy it. The command then prompts you for information about this particular deployment and - provides intelligent choices based on its analysis. + To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the + metadata format to the source format using this command. - For example, if your local project contains a source directory with metadata files in source format, the command asks - if you want to deploy that Salesforce app to an org. The command lists your connected orgs and asks which one you want - to deploy to. The list of orgs starts with scratch orgs, ordered by expiration date with the most recently created one - first, and then Dev Hub and production orgs ordered by name. If the command finds Apex tests, it asks if you want to - run them and at which level. + To convert files from the source format back to the metadata format, run "sf project convert source". - The command stores your responses in the "deploy-options.json" file in your local project directory and uses them as - defaults when you rerun the command. Specify --interactive to force the command to reprompt. + 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. - Use this command for quick and simple deploys. For more complicated deployments, use the environment-specific - commands, such as "sf deploy metadata", that provide additional flags. +ALIASES + $ sf force mdapi convert EXAMPLES - Deploy a project and use stored values from a previous command run: + Convert metadata formatted files in the specified directory into source formatted files; writes converted files to + your default package directory: + + $ sf project convert mdapi --root-dir path/to/metadata + + Similar to previous example, but writes converted files to the specified output directory: + + $ sf project convert mdapi --root-dir path/to/metadata --output-dir path/to/outputdir + +FLAG DESCRIPTIONS + -p, --metadata-dir=... Root of directory or zip file of metadata formatted files to convert. + + 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). - $ sf deploy + If you specify this flag, don’t specify --manifest or --metadata. If the comma-separated list you’re supplying + contains spaces, enclose the entire comma-separated list in one set of double quotes. - Reprompt for all deployment inputs: + -x, --manifest= File path to manifest (package.xml) of metadata types to convert. - $ sf deploy --interactive + If you specify this parameter, don’t specify --metadata or --source-dir. ``` -_See code: [src/commands/deploy.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.6.0/src/commands/deploy.ts)_ +_See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/1.19.3/src/commands/project/convert/mdapi.ts)_ -## `sf deploy metadata` +## `sf project convert source` -Deploy metadata to an org from your local project. +Convert source-formatted files into metadata that you can deploy using Metadata API. ``` USAGE - $ sf deploy metadata [--json] [-a ] [--async | -w ] [--concise | --verbose] [--dry-run] [-c] [-r] - [-g] [-x | -d | -m | --metadata-dir ] [--single-package ] [-o ] [-t ] - [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] + $ sf project convert source [--json] [--api-version ] [-r ] [-d ] [-n ] [-p | -x + | -m ] FLAGS - -a, --api-version= Target API version for the deploy. - -c, --ignore-conflicts Ignore conflicts and deploy local files, even if they overwrite changes in the org. - -d, --source-dir=... Path to the local source files to deploy. - -g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully. - -l, --test-level=