Merge branch 'main' into sh/deploy-zip-size

salesforcecli · Aug 19, 2024 · 8027db0 · 8027db0
2 parents 56e8bd5 + a0bdcbb
commit 8027db0
Show file tree

Hide file tree

Showing 12 changed files with 723 additions and 342 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,26 @@
+# [3.10.0](https://github.com/salesforcecli/plugin-deploy-retrieve/compare/3.9.27...3.10.0) (2024-08-16)
+
+### Bug Fixes
+
+- always display the "no main/default" warning even in dry-run ([e122e72](https://github.com/salesforcecli/plugin-deploy-retrieve/commit/e122e725bd8cf0efce0a3f4c76e053ab718f897a))
+- stl fix and other deps ([13462f0](https://github.com/salesforcecli/plugin-deploy-retrieve/commit/13462f0cd7856935130e95a7f92fcbc379aa29a2))
+
+### Features
+
+- confirmation and warnings for convert behavior ([29d8309](https://github.com/salesforcecli/plugin-deploy-retrieve/commit/29d83095b273114bd084188563734be7b768266a))
+
+## [3.9.27](https://github.com/salesforcecli/plugin-deploy-retrieve/compare/3.9.26...3.9.27) (2024-08-13)
+
+### Bug Fixes
+
+- clarify help docs and command output for package-name flag ([16b2993](https://github.com/salesforcecli/plugin-deploy-retrieve/commit/16b29938835bf09ad91e05385a5d1650325334ae))
+
+## [3.9.26](https://github.com/salesforcecli/plugin-deploy-retrieve/compare/3.9.25...3.9.26) (2024-08-10)
+
+### Bug Fixes
+
+- **deps:** bump @salesforce/sf-plugins-core from 11.2.4 to 11.3.0 ([3ed5999](https://github.com/salesforcecli/plugin-deploy-retrieve/commit/3ed59999fc2d6c11f1ad625d85ed1978bbeb0f05))
+
 ## [3.9.25](https://github.com/salesforcecli/plugin-deploy-retrieve/compare/3.9.24...3.9.25) (2024-08-03)
 
 ### Bug Fixes

diff --git a/README.md b/README.md
@@ -141,7 +141,7 @@ FLAG DESCRIPTIONS
     If you specify this parameter, don’t specify --metadata or --source-dir.
 ```
 
-_See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/convert/mdapi.ts)_
+_See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/convert/mdapi.ts)_
 
 ## `sf project convert source`
 
@@ -153,7 +153,7 @@ USAGE
     [-p <value>... | -x <value> | -m <value>...]
 
 FLAGS
-  -d, --output-dir=<value>     [default: metadataPackage_1722653249381] Output directory to store the Metadata
+  -d, --output-dir=<value>     [default: metadataPackage_1723826880963] Output directory to store the Metadata
                                API–formatted files in.
   -m, --metadata=<value>...    Metadata component names to convert.
   -n, --package-name=<value>   Name of the package to associate with the metadata-formatted files.
@@ -214,7 +214,7 @@ FLAG DESCRIPTIONS
     Override the api version used for api requests made by this command
 ```
 
-_See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/convert/source.ts)_
+_See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/convert/source.ts)_
 
 ## `sf project convert source-behavior`
 
@@ -223,14 +223,14 @@ Enable a behavior of your project source files, and then update your Salesforce
 ```
 USAGE
   $ sf project convert source-behavior -b
-    decomposeCustomLabelsBeta|decomposePermissionSetBeta|decomposeSharingRulesBeta|decomposeWorkflowBeta [--json]
-    [--flags-dir <value>] [--dry-run] [--preserve-temp-dir] [-o <value>]
+    decomposeCustomLabelsBeta2|decomposeCustomLabelsBeta|decomposePermissionSetBeta|decomposeSharingRulesBeta|decomposeW
+    orkflowBeta [--json] [--flags-dir <value>] [--dry-run] [--preserve-temp-dir] [-o <value>]
 
 FLAGS
   -b, --behavior=<option>   (required) Behavior to enable; the values correspond to the possible values of the
                             "sourceBehaviorOption" option in the "sfdx-project.json" file.
-                            <options: decomposeCustomLabelsBeta|decomposePermissionSetBeta|decomposeSharingRulesBeta|dec
-                            omposeWorkflowBeta>
+                            <options: decomposeCustomLabelsBeta2|decomposeCustomLabelsBeta|decomposePermissionSetBeta|de
+                            composeSharingRulesBeta|decomposeWorkflowBeta>
   -o, --target-org=<value>  Username or alias of the target org.
       --dry-run             Display what the command would do, but don't make any actual changes.
       --preserve-temp-dir   Don't delete the metadata API format temporary directory that this command creates. Useful
@@ -258,20 +258,20 @@ DESCRIPTION
   https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.
 
 EXAMPLES
-  Update your Salesforce DX project to decompose custom labels:
+  Update your Salesforce DX project to decompose custom permission sets:
 
-    $ sf project convert source-behavior --behavior decomposeCustomLabelsBeta
+    $ sf project convert source-behavior --behavior decomposePermissionSetBeta
 
   Display what the command would do, but don't change any existing files:
 
-    $ sf project convert source-behavior --behavior decomposeCustomLabelsBeta --dry-run
+    $ sf project convert source-behavior --behavior decomposePermissionSetBeta --dry-run
 
   Keep the temporary directory that contains the interim metadata API formatted files:
 
-    $ sf project convert source-behavior --behavior decomposeCustomLabelsBeta --dry-run --preserve-temp-dir
+    $ sf project convert source-behavior --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir
 ```
 
-_See code: [src/commands/project/convert/source-behavior.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/convert/source-behavior.ts)_
+_See code: [src/commands/project/convert/source-behavior.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/convert/source-behavior.ts)_
 
 ## `sf project delete source`
 
@@ -411,7 +411,7 @@ FLAG DESCRIPTIONS
     - Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
 ```
 
-_See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/delete/source.ts)_
+_See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/delete/source.ts)_
 
 ## `sf project delete tracking`
 
@@ -448,7 +448,7 @@ EXAMPLES
     $ sf project delete tracking --target-org my-scratch
 ```
 
-_See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/delete/tracking.ts)_
+_See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/delete/tracking.ts)_
 
 ## `sf project deploy cancel`
 
@@ -520,7 +520,7 @@ FLAG DESCRIPTIONS
     project deploy report".
 ```
 
-_See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/deploy/cancel.ts)_
+_See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/deploy/cancel.ts)_
 
 ## `sf project deploy preview`
 
@@ -603,7 +603,7 @@ FLAG DESCRIPTIONS
     All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
 ```
 
-_See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/deploy/preview.ts)_
+_See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/deploy/preview.ts)_
 
 ## `sf project deploy quick`
 
@@ -687,7 +687,7 @@ FLAG DESCRIPTIONS
     deploy report".
 ```
 
-_See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/deploy/quick.ts)_
+_See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/deploy/quick.ts)_
 
 ## `sf project deploy report`
 
@@ -779,7 +779,7 @@ FLAG DESCRIPTIONS
     --coverage-formatters lcov --coverage-formatters clover
 ```
 
-_See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/deploy/report.ts)_
+_See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/deploy/report.ts)_
 
 ## `sf project deploy resume`
 
@@ -864,7 +864,7 @@ FLAG DESCRIPTIONS
     --coverage-formatters lcov --coverage-formatters clover
 ```
 
-_See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/deploy/resume.ts)_
+_See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/deploy/resume.ts)_
 
 ## `sf project deploy start`
 
@@ -1100,7 +1100,7 @@ FLAG DESCRIPTIONS
     --coverage-formatters lcov --coverage-formatters clover
 ```
 
-_See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/deploy/start.ts)_
+_See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/deploy/start.ts)_
 
 ## `sf project deploy validate`
 
@@ -1273,7 +1273,7 @@ FLAG DESCRIPTIONS
     --coverage-formatters lcov --coverage-formatters clover
 ```
 
-_See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/deploy/validate.ts)_
+_See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/deploy/validate.ts)_
 
 ## `sf project generate manifest`
 
@@ -1350,7 +1350,7 @@ EXAMPLES
     $ sf project generate manifest --from-org [email protected] --include-packages unlocked
 ```
 
-_See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/generate/manifest.ts)_
+_See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/generate/manifest.ts)_
 
 ## `sf project list ignored`
 
@@ -1392,7 +1392,7 @@ EXAMPLES
     $ sf project list ignored --source-dir package.xml
 ```
 
-_See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/list/ignored.ts)_
+_See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/list/ignored.ts)_
 
 ## `sf project reset tracking`
 
@@ -1441,7 +1441,7 @@ EXAMPLES
     $ sf project reset tracking --revision 30
 ```
 
-_See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/reset/tracking.ts)_
+_See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/reset/tracking.ts)_
 
 ## `sf project retrieve preview`
 
@@ -1495,7 +1495,7 @@ FLAG DESCRIPTIONS
     production orgs.
 ```
 
-_See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/retrieve/preview.ts)_
+_See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/retrieve/preview.ts)_
 
 ## `sf project retrieve start`
 
@@ -1514,7 +1514,8 @@ FLAGS
   -d, --source-dir=<value>...    File paths for source to retrieve from the org.
   -m, --metadata=<value>...      Metadata component names to retrieve. Wildcards (`*`) supported as long as you use
                                  quotes, such as `ApexClass:MyClass*`.
-  -n, --package-name=<value>...  Package names to retrieve.
+  -n, --package-name=<value>...  Package names to retrieve. Use of this flag is for reference only; don't use it to
+                                 retrieve packaged metadata for development.
   -o, --target-org=<value>       (required) Username or alias of the target org. Not required if the `target-org`
                                  configuration variable is already set.
   -r, --output-dir=<value>       Directory root for the retrieved source files.
@@ -1637,6 +1638,17 @@ FLAG DESCRIPTIONS
     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 source files in the directory and its subdirectories).
 
+  -n, --package-name=<value>...
+
+    Package names to retrieve. Use of this flag is for reference only; don't use it to retrieve packaged metadata for
+    development.
+
+    The metadata of the supplied package name(s) will be retrieved into a child directory of the project. The name of
+    that child directory matches the name of the package. The retrieved metadata is meant for your reference only, don't
+    add it to a source control system for development and deployment. For package development, retrieve the metadata
+    using a manifest (`--manifest` flag) or by targeting a source controlled package directory within your project
+    (`--source-dir` flag).
+
   -r, --output-dir=<value>  Directory root for the retrieved source files.
 
     The root of the directory structure into which the source files are retrieved.
@@ -1652,6 +1664,6 @@ FLAG DESCRIPTIONS
     If you specify this parameter, don’t specify --metadata or --source-dir.
 ```
 
-_See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.25/src/commands/project/retrieve/start.ts)_
+_See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.10.0/src/commands/project/retrieve/start.ts)_
 
 <!-- commandsstop -->
diff --git a/messages/convert.source-behavior.md b/messages/convert.source-behavior.md
@@ -16,17 +16,17 @@ Behavior to enable; the values correspond to the possible values of the "sourceB
 
 # examples
 
-- Update your Salesforce DX project to decompose custom labels:
+- Update your Salesforce DX project to decompose custom permission sets:
 
-  <%= config.bin %> <%= command.id %> --behavior decomposeCustomLabelsBeta
+  <%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta
 
 - Display what the command would do, but don't change any existing files:
 
-  <%= config.bin %> <%= command.id %> --behavior decomposeCustomLabelsBeta --dry-run
+  <%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run
 
 - Keep the temporary directory that contains the interim metadata API formatted files:
 
-  <%= config.bin %> <%= command.id %> --behavior decomposeCustomLabelsBeta --dry-run --preserve-temp-dir
+  <%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir
 
 # flags.dry-run.summary
 
@@ -51,15 +51,13 @@ Your project has a default org (target-org) that uses source tracking. This oper
 - Run this command again.
 - Create a new org ("sf org create scratch" or "sf org create sandbox") and deploy the modified source.
 
-# error.packageDirectoryNeedsMainDefault
+# mainDefaultConfirmation
 
-The package directory %s doesn't have a main/default structure.
-This command moves metadata into a main/default structure, but your package directories aren't ready for it.
+- This command puts components in a newly created `main/default` folder in each package directory. You might need to re-organize them into your preferred structure.
 
-# error.packageDirectoryNeedsMainDefault.actions
+# basicConfirmation
 
-- Update %s to have all its metadata inside a main/default directory structure.
-- Run the command again.
+- This command makes changes to your project. Be sure you've committed any source changes before continuing so you can easily revert if necessary.
 
 # success.dryRun
 

diff --git a/messages/retrieve.start.md b/messages/retrieve.start.md
@@ -103,7 +103,11 @@ Metadata component names to retrieve. Wildcards (`*`) supported as long as you u
 
 # flags.package-name.summary
 
-Package names to retrieve.
+Package names to retrieve. Use of this flag is for reference only; don't use it to retrieve packaged metadata for development.
+
+# flags.package-name.description
+
+The metadata of the supplied package name(s) will be retrieved into a child directory of the project. The name of that child directory matches the name of the package. The retrieved metadata is meant for your reference only, don't add it to a source control system for development and deployment. For package development, retrieve the metadata using a manifest (`--manifest` flag) or by targeting a source controlled package directory within your project (`--source-dir` flag).
 
 # flags.source-dir.summary
 

diff --git a/package.json b/package.json
@@ -1,32 +1,32 @@
 {
   "name": "@salesforce/plugin-deploy-retrieve",
   "description": "deploy and retrieve commands for sf",
-  "version": "3.9.25",
+  "version": "3.10.0",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/core": "^4.0.12",
-    "@salesforce/apex-node": "^8.1.1",
-    "@salesforce/core": "^8.2.8",
-    "@salesforce/kit": "^3.1.6",
-    "@salesforce/plugin-info": "^3.3.24",
-    "@salesforce/sf-plugins-core": "^11.2.4",
-    "@salesforce/source-deploy-retrieve": "^12.1.11",
-    "@salesforce/source-tracking": "^7.1.2",
+    "@oclif/core": "^4.0.17",
+    "@salesforce/apex-node": "^8.1.3",
+    "@salesforce/core": "^8.4.0",
+    "@salesforce/kit": "^3.2.1",
+    "@salesforce/plugin-info": "^3.3.28",
+    "@salesforce/sf-plugins-core": "^11.3.2",
+    "@salesforce/source-deploy-retrieve": "^12.4.0",
+    "@salesforce/source-tracking": "^7.1.7",
     "@salesforce/ts-types": "^2.0.12",
     "ansis": "^3.3.2"
   },
   "devDependencies": {
-    "@oclif/plugin-command-snapshot": "^5.2.10",
-    "@salesforce/cli-plugins-testkit": "^5.3.20",
+    "@oclif/plugin-command-snapshot": "^5.2.12",
+    "@salesforce/cli-plugins-testkit": "^5.3.25",
     "@salesforce/dev-scripts": "^10.2.9",
-    "@salesforce/plugin-command-reference": "^3.1.13",
+    "@salesforce/plugin-command-reference": "^3.1.16",
     "@salesforce/schemas": "^1.9.0",
     "@salesforce/source-testkit": "^2.2.39",
-    "@salesforce/ts-sinon": "^1.4.23",
+    "@salesforce/ts-sinon": "^1.4.24",
     "cross-env": "^7.0.3",
-    "eslint-plugin-sf-plugin": "^1.18.11",
-    "oclif": "^4.14.6",
+    "eslint-plugin-sf-plugin": "^1.20.4",
+    "oclif": "^4.14.19",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.4"
   },