Merge pull request #1062 from salesforcecli/hc/support-recommendedversionid-field

W-19743455 - feat: add recommended-version-id to package update

Author: WillieRuemmele

README.md

@@ -794,7 +794,7 @@ Update package details.
 ```
 USAGE
   $ sf package update -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>] [-d
-    <value>] [-o <value>] [--enable-app-analytics]
+    <value>] [-o <value>] [-r <value>] [--enable-app-analytics]
 
 FLAGS
   -d, --description=<value>                  New description of the package.
@@ -804,6 +804,7 @@ FLAGS
   -p, --package=<value>                      (required) ID (starts with 0Ho) or alias of the package to update.
   -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.
+  -r, --recommended-version-id               Package version ID (starts with 04t) that subscribers are notified to install or upgrade to
       --api-version=<value>                  Override the api version used for api requests made by this command
       --[no-]enable-app-analytics            Enable AppExchange App Analytics usage data collection on this managed
                                              package and its components.

command-snapshot.json

@@ -363,7 +363,7 @@
     "alias": ["force:package:update"],
     "command": "package:update",
     "flagAliases": ["apiversion", "errornotificationusername", "target-hub-org", "targetdevhubusername"],
-    "flagChars": ["d", "n", "o", "p", "v"],
+    "flagChars": ["d", "n", "o", "p", "v", "r"],
     "flags": [
       "api-version",
       "description",
@@ -374,7 +374,8 @@
       "loglevel",
       "name",
       "package",
-      "target-dev-hub"
+      "target-dev-hub",
+      "recommended-version-id"
     ],
     "plugin": "@salesforce/plugin-packaging"
   },

messages/package_update.md

@@ -37,3 +37,11 @@ Enable AppExchange App Analytics usage data collection on this managed package a
 # success
 
 Successfully updated the package. %s
+
+# flags.recommended-version-id.summary
+
+Package version ID that subscribers are notified to install or upgrade to.
+
+# 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.

schemas/package-version-report.json

@@ -78,6 +78,9 @@
             },
             "IsOrgDependent": {
               "type": "string"
+            },
+            "RecommendedVersionId": {
+              "type": "string"
             }
           },
           "additionalProperties": false

src/commands/package/update.ts

@@ -59,6 +59,11 @@ export class PackageUpdateCommand extends SfCommand<PackageSaveResult> {
       summary: messages.getMessage('flags.enable-app-analytics.summary'),
       allowNo: true,
     }),
+    'recommended-version-id': Flags.string({
+      char: 'r',
+      summary: messages.getMessage('flags.recommended-version-id.summary'),
+      description: messages.getMessage('flags.recommended-version-id.description'),
+    }),
   };
 
   public async run(): Promise<PackageSaveResult> {
@@ -76,6 +81,7 @@ export class PackageUpdateCommand extends SfCommand<PackageSaveResult> {
       Description: flags.description,
       PackageErrorUsername: flags['error-notification-username'],
       AppAnalyticsEnabled: flags['enable-app-analytics'],
+      RecommendedVersionId: flags['recommended-version-id'],
     });
 
     this.logSuccess(messages.getMessage('success', [pkg.getId()]));