Merge pull request #690 from salesforcecli/wr/filterPVLbyBranch

feat: create/consume branch flag to filter PVL

Author: shetzel

command-snapshot.json

@@ -325,9 +325,10 @@
       "target-hub-org",
       "targetdevhubusername"
     ],
-    "flagChars": ["c", "m", "o", "p", "r", "v"],
+    "flagChars": ["b", "c", "m", "o", "p", "r", "v"],
     "flags": [
       "api-version",
+      "branch",
       "concise",
       "created-last-days",
       "flags-dir",

messages/package_version_list.md

@@ -12,6 +12,10 @@ All filter parameters are applied using the AND logical operator (not OR).
 
 Display limited package version details.
 
+# flags.branch.summary
+
+Branch in your source control system used to filter the results; only package versions based on the specified branch are listed.
+
 # flags.packages.summary
 
 Comma-delimited list of packages (aliases or 0Ho IDs) to list.
@@ -50,6 +54,10 @@ Filter the list output to display only converted package version.
 
   <%= config.bin %> <%= command.id %> --concise --modified-last-days 0
 
+- List package versions that are based on the "featureA" branch in your source control system that were modified today in your default Dev Hub org; show limited details about each one:
+
+  <%= config.bin %> <%= command.id %> --concise --modified-last-days 0 --branch featureA
+
 - List released package versions that were created in the last 3 days in your default Dev Hub org; show limited details:
 
   <%= config.bin %> <%= command.id %> --concise --created-last-days 3 --released

src/commands/package/version/create.ts

@@ -199,7 +199,10 @@ export class PackageVersionCreateCommand extends SfCommand<PackageVersionCommand
       // no async methods
       // eslint-disable-next-line @typescript-eslint/require-await
       async (data: PackageVersionCreateReportProgress) => {
-        if (data.Status !== Package2VersionStatus.success && data.Status !== Package2VersionStatus.error && data.Status !== Package2VersionStatus.performingValidations
+        if (
+          data.Status !== Package2VersionStatus.success &&
+          data.Status !== Package2VersionStatus.error &&
+          data.Status !== Package2VersionStatus.performingValidations
         ) {
           const status = messages.getMessage('packageVersionCreateWaitingStatus', [
             data.remainingWaitTime.minutes,

src/commands/package/version/list.ts

@@ -85,6 +85,10 @@ export class PackageVersionListCommand extends SfCommand<PackageVersionListComma
       char: 'r',
       summary: messages.getMessage('flags.released.summary'),
     }),
+    branch: Flags.string({
+      char: 'b',
+      summary: messages.getMessage('flags.branch.summary'),
+    }),
     'order-by': Flags.string({
       // eslint-disable-next-line sf-plugin/dash-o
       char: 'o',
@@ -103,13 +107,14 @@ export class PackageVersionListCommand extends SfCommand<PackageVersionListComma
     const project = SfProject.getInstance();
 
     const records = await Package.listVersions(connection, project, {
-      createdLastDays: flags['created-last-days'] as number,
+      createdLastDays: flags['created-last-days'],
       concise: flags.concise,
-      modifiedLastDays: flags['modified-last-days'] as number,
+      modifiedLastDays: flags['modified-last-days'],
       packages: flags.packages?.split(',') ?? [],
       isReleased: flags.released,
-      orderBy: flags['order-by'] as string,
+      orderBy: flags['order-by'],
       verbose: flags.verbose,
+      branch: flags.branch,
       showConversionsOnly: flags['show-conversions-only'],
     });
 
@@ -129,7 +134,7 @@ export class PackageVersionListCommand extends SfCommand<PackageVersionListComma
 
       records.forEach((record) => {
         const ids = [record.Id, record.SubscriberPackageVersionId];
-        const aliases: string[] = ids.map((id) => project.getAliasesFromPackageId(id)).flat();
+        const aliases = ids.map((id) => project.getAliasesFromPackageId(id)).flat();
         const AliasStr = aliases.length > 0 ? aliases.join() : '';
 
         // set Ancestor display values

test/commands/package/packageVersion.nut.ts

@@ -71,11 +71,9 @@ describe('package:version:*', () => {
   describe('package:version:create', () => {
     it('should create a new package version (human)', () => {
       const result = execCmd(
-        `package:version:create --package ${pkgName} -x --code-coverage --version-description "Initial version"`,
+        `package:version:create --package ${pkgName} -x --code-coverage --version-description "Initial version" --branch testing`,
         { ensureExitCode: 0 }
       ).shellOutput.stdout;
-      // eslint-disable-next-line no-console
-      console.log(result);
       expect(result).to.include("Package version creation request status is '");
       expect(result).to.match(/Run "sfd?x? package:version:create:report -i 08c.{15}" to query for status\./);
     });
@@ -297,6 +295,16 @@ describe('package:version:*', () => {
         /Package Name\s+Namespace\s+Version Name\s+Version\s+Subscriber Package Version Id\sAlias\s+Installation Key\s+Released\s+Validation Skipped\s+Ancestor\s+Ancestor Version\s+Branch\s+Package Id\s+Installation URL\s+Package Version Id\s+Created Date\s+Last Modified Date\s+Tag\s+Description\s+Code Coverage\s+Code Coverage Met\s+Converted From Version Id\s+Org-Dependent\s+Unlocked Package\s+Release\s+Version\s+Build Duration in Seconds\s+Managed Metadata Removed\s+Created By/
       );
     });
+
+    it("should list installed packages in dev hub - verbose human readable results only on the 'testing' branch", () => {
+      const command = `package:version:list -v ${session.hubOrg.username} --verbose --branch testing`;
+      const output = execCmd(command, { ensureExitCode: 0 }).shellOutput.stdout;
+      expect(output).to.contain('=== Package Versions [');
+      expect(output).to.match(
+        /Package Name\s+Namespace\s+Version Name\s+Version\s+Subscriber Package Version Id\sAlias\s+Installation Key\s+Released\s+Validation Skipped\s+Ancestor\s+Ancestor Version\s+Branch\s+Package Id\s+Installation URL\s+Package Version Id\s+Created Date\s+Last Modified Date\s+Tag\s+Description\s+Code Coverage\s+Code Coverage Met\s+Converted From Version Id\s+Org-Dependent\s+Unlocked Package\s+Release\s+Version\s+Build Duration in Seconds\s+Managed Metadata Removed\s+Created By/
+      );
+      expect(output).to.include('testing');
+    });
     it('should list package versions in dev hub - json results', () => {
       const command = `package:version:list -v ${session.hubOrg.username} --json`;
       const output = execCmd<[PackageVersionListCommandResult]>(command, { ensureExitCode: 0 }).jsonOutput?.result;