@salesforce/plugin-packaging 2.24.2 → 2.24.4

package/README.md

@@ -155,7 +155,7 @@ FLAG DESCRIPTIONS
     --installation-key-bypass flag is required.
 ```
 
-_See code: [src/commands/package/convert.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/convert.ts)_
+_See code: [src/commands/package/convert.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/convert.ts)_
 
 ## `sf package create`
 
@@ -234,7 +234,7 @@ FLAG DESCRIPTIONS
     Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
 ```
 
-_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/create.ts)_
+_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/create.ts)_
 
 ## `sf package delete`
 
@@ -276,7 +276,7 @@ EXAMPLES
     $ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
 ```
 
-_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/delete.ts)_
+_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/delete.ts)_
 
 ## `sf package install`
 
@@ -375,7 +375,7 @@ FLAG DESCRIPTIONS
     - Delete: Delete removed components, except for custom objects and custom fields, that don't have dependencies.
 ```
 
-_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/install.ts)_
+_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/install.ts)_
 
 ## `sf package install report`
 
@@ -408,7 +408,7 @@ EXAMPLES
     $ sf package install report --request-id 0Hf... --target-org me@example.com
 ```
 
-_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/install/report.ts)_
+_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/install/report.ts)_
 
 ## `sf package installed list`
 
@@ -440,7 +440,7 @@ EXAMPLES
     $ sf package installed list --target-org me@example.com
 ```
 
-_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/installed/list.ts)_
+_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/installed/list.ts)_
 
 ## `sf package list`
 
@@ -478,7 +478,7 @@ EXAMPLES
     $ sf package list --target-dev-hub devhub@example.com --verbose
 ```
 
-_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/list.ts)_
+_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/list.ts)_
 
 ## `sf package push-upgrade abort`
 
@@ -517,7 +517,7 @@ EXAMPLES
     $ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub devhub@example.com
 ```
 
-_See code: [src/commands/package/push-upgrade/abort.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/push-upgrade/abort.ts)_
+_See code: [src/commands/package/push-upgrade/abort.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/push-upgrade/abort.ts)_
 
 ## `sf package push-upgrade list`
 
@@ -576,7 +576,7 @@ EXAMPLES
     $ sf package push-upgrade list --package 033xyz –-status Failed
 ```
 
-_See code: [src/commands/package/push-upgrade/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/push-upgrade/list.ts)_
+_See code: [src/commands/package/push-upgrade/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/push-upgrade/list.ts)_
 
 ## `sf package push-upgrade report`
 
@@ -618,7 +618,7 @@ EXAMPLES
     $ sf package push-upgrade report --push-request-id 0DV... --target-dev-hub devhub@example.com
 ```
 
-_See code: [src/commands/package/push-upgrade/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/push-upgrade/report.ts)_
+_See code: [src/commands/package/push-upgrade/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/push-upgrade/report.ts)_
 
 ## `sf package push-upgrade schedule`
 
@@ -705,7 +705,7 @@ FLAG DESCRIPTIONS
     Overrides the value of the target-dev-hub configuration variable, if set.
 ```
 
-_See code: [src/commands/package/push-upgrade/schedule.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/push-upgrade/schedule.ts)_
+_See code: [src/commands/package/push-upgrade/schedule.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/push-upgrade/schedule.ts)_
 
 ## `sf package uninstall`
 
@@ -753,7 +753,7 @@ EXAMPLES
     $ sf package uninstall --package "Undesirable Package Alias"
 ```
 
-_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/uninstall.ts)_
+_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/uninstall.ts)_
 
 ## `sf package uninstall report`
 
@@ -786,7 +786,7 @@ EXAMPLES
     $ sf package uninstall report --request-id 06y... --target-org me@example.com
 ```
 
-_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/uninstall/report.ts)_
+_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/uninstall/report.ts)_
 
 ## `sf package update`
 
@@ -803,7 +803,9 @@ FLAGS
   -o, --error-notification-username=<value>  Active Dev Hub user designated to receive email notifications for package
                                              errors.
   -p, --package=<value>                      (required) ID (starts with 0Ho) or alias of the package to update.
-  -r, --recommended-version-id=<value>       Package version ID that subscribers are notified to install or upgrade to.
+  -r, --recommended-version-id=<value>       ID of the package version that's installed when subscribers click the
+                                             Upgrade to Recommended Version option on the Installed Packages page of
+                                             their org.
   -v, --target-dev-hub=<value>               (required) Username or alias of the Dev Hub org. Not required if the
                                              `target-dev-hub` configuration variable is already set.
       --api-version=<value>                  Override the api version used for api requests made by this command
@@ -842,14 +844,17 @@ FLAG DESCRIPTIONS
     Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures
     associated with your package.
 
-  -r, --recommended-version-id=<value>  Package version ID that subscribers are notified to install or upgrade to.
+  -r, --recommended-version-id=<value>
 
-    Specify the recommended package version for subscribers to install. Subscribers are notified to install the package
-    version ID that you specify. If the subscribers have a different version of the same package installed, they're
-    notified to upgrade to the recommended version.
+    ID of the package version that's installed when subscribers click the Upgrade to Recommended Version option on the
+    Installed Packages page of their org.
+
+    Specify the recommended package version for subscribers to install. If a subscriber has a package version installed
+    in their org that's lower than the version you set, the subscriber sees the Upgrade to Recommended Version option on
+    the Installed Packages page. Only released package versions can be set as the recommended version.
 ```
 
-_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/update.ts)_
+_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/update.ts)_
 
 ## `sf package version create`
 
@@ -1024,7 +1029,7 @@ FLAG DESCRIPTIONS
     periods of no output from commands.
 ```
 
-_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/create.ts)_
+_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/version/create.ts)_
 
 ## `sf package version create list`
 
@@ -1085,7 +1090,7 @@ EXAMPLES
     $ sf package version create list --created-last-days 0 --status Success
 ```
 
-_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/create/list.ts)_
+_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/version/create/list.ts)_
 
 ## `sf package version create report`
 
@@ -1128,7 +1133,7 @@ EXAMPLES
     $ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
 ```
 
-_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/create/report.ts)_
+_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/version/create/report.ts)_
 
 ## `sf package version delete`
 
@@ -1169,7 +1174,7 @@ EXAMPLES
     $ sf package version delete --package 04t... --target-org devhub@example.com
 ```
 
-_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/delete.ts)_
+_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/version/delete.ts)_
 
 ## `sf package version displayancestry`
 
@@ -1229,7 +1234,7 @@ FLAG DESCRIPTIONS
     You can use the DOT code output in graph visualization software to create tree visualizations.
 ```
 
-_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/displayancestry.ts)_
+_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/version/displayancestry.ts)_
 
 ## `sf package version displaydependencies`
 
@@ -1291,7 +1296,7 @@ FLAG DESCRIPTIONS
     package, which must be installed last.
 ```
 
-_See code: [src/commands/package/version/displaydependencies.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/displaydependencies.ts)_
+_See code: [src/commands/package/version/displaydependencies.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/version/displaydependencies.ts)_
 
 ## `sf package version list`
 
@@ -1367,7 +1372,7 @@ EXAMPLES
     $ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
 ```
 
-_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/list.ts)_
+_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/version/list.ts)_
 
 ## `sf package version promote`
 
@@ -1411,7 +1416,7 @@ EXAMPLES
     $ sf package version promote --package "Awesome Package Alias"
 ```
 
-_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/promote.ts)_
+_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/version/promote.ts)_
 
 ## `sf package version report`
 
@@ -1451,7 +1456,7 @@ EXAMPLES
     $ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
 ```
 
-_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/report.ts)_
+_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/version/report.ts)_
 
 ## `sf package version retrieve`
 
@@ -1496,7 +1501,7 @@ EXAMPLES
     $ sf package version retrieve --package 04tXXX --output-dir my-directory/ --target-dev-hub devhub@example.com
 ```
 
-_See code: [src/commands/package/version/retrieve.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/retrieve.ts)_
+_See code: [src/commands/package/version/retrieve.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/version/retrieve.ts)_
 
 ## `sf package version update`
 
@@ -1549,7 +1554,7 @@ EXAMPLES
     $ sf package version update --package 04t... --version-description "New Package Version Description"
 ```
 
-_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/update.ts)_
+_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package/version/update.ts)_
 
 ## `sf package1 version create`
 
@@ -1616,7 +1621,7 @@ FLAG DESCRIPTIONS
     subscribers.
 ```
 
-_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package1/version/create.ts)_
+_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package1/version/create.ts)_
 
 ## `sf package1 version create get`
 
@@ -1649,7 +1654,7 @@ EXAMPLES
     $ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
 ```
 
-_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package1/version/create/get.ts)_
+_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package1/version/create/get.ts)_
 
 ## `sf package1 version display`
 
@@ -1683,7 +1688,7 @@ EXAMPLES
     $ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
 ```
 
-_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package1/version/display.ts)_
+_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package1/version/display.ts)_
 
 ## `sf package1 version list`
 
@@ -1721,6 +1726,6 @@ FLAG DESCRIPTIONS
     If not specified, shows all versions for all packages (managed and unmanaged) in the org.
 ```
 
-_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package1/version/list.ts)_
+_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.4/src/commands/package1/version/list.ts)_
 
 <!-- commandsstop -->

package/messages/package_update.md

@@ -40,11 +40,11 @@ Successfully updated the package. %s
 
 # flags.recommended-version-id.summary
 
-Package version ID that subscribers are notified to install or upgrade to.
+ID of the package version that's installed when subscribers click the Upgrade to Recommended Version option on the Installed Packages page of their org.
 
 # flags.recommended-version-id.description
 
-Specify the recommended package version for subscribers to install. Subscribers are notified to install the package version ID that you specify. If the subscribers have a different version of the same package installed, they're notified to upgrade to the recommended version.
+Specify the recommended package version for subscribers to install. If a subscriber has a package version installed in their org that's lower than the version you set, the subscriber sees the Upgrade to Recommended Version option on the Installed Packages page. Only released package versions can be set as the recommended version.
 
 # flags.skip-ancestor-check.summary