feat(config): minimumGroupSize (renovatebot#37242)

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
Co-authored-by: Sebastian Poxhofer <secustor@users.noreply.github.com>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
Co-authored-by: Devin Buhl <onedr0p@users.noreply.github.com>

Author: 5 people

docs/usage/configuration-options.md

@@ -2660,6 +2660,30 @@ Renovate will only add a milestone when it _creates_ the PR.
 }
 ```
 
+## minimumGroupSize
+
+If set to to a positive value x then branch creation will be postponed until x or more updates are available in the branch.
+
+This applies to both these scenarios:
+
+- Grouped updates with more than one dependency updated together, and
+- Branches with multiple updates of the same dependency (e.g. in multiple files)
+
+Example:
+
+```json title="Create only a grouped update when there are 3 or more node updates"
+{
+  "packageRules": [
+    {
+      "description": "We need to update Node in two places - always wait until both upgrades are available",
+      "matchDepNames": ["node"],
+      "groupName": "Node.js",
+      "minimumGroupSize": 3
+    }
+  ]
+}
+```
+
 ## minimumReleaseAge
 
 This feature used to be called `stabilityDays`.

lib/config/options/index.ts

@@ -350,6 +350,13 @@ const options: RenovateOptions[] = [
       type: 'string',
     },
   },
+  {
+    name: 'minimumGroupSize',
+    description:
+      'The minimum number of updates which must be in a group for branches to be created.',
+    type: 'integer',
+    default: 1,
+  },
   {
     name: 'presetCachePersistence',
     description: 'Cache resolved presets in package cache.',

lib/config/types.ts

@@ -323,6 +323,7 @@ export interface RenovateConfig
   branchTopic?: string;
   additionalBranchPrefix?: string;
   sharedVariableName?: string;
+  minimumGroupSize?: number;
 }
 
 const CustomDatasourceFormats = [

lib/workers/repository/dependency-dashboard.spec.ts

@@ -283,6 +283,23 @@ describe('workers/repository/dependency-dashboard', () => {
         dependencyDashboardRebaseAllOpen: false,
       });
     });
+
+    it('reads dashboard body and group size not met branches', async () => {
+      const conf: RenovateConfig = {};
+      conf.prCreation = 'approval';
+      platform.findIssue.mockResolvedValueOnce({
+        title: '',
+        number: 1,
+        body: `
+        - [x] <!-- approveGroup-branch=groupedBranch1 -->
+        - [ ] <!-- approveGroup-branch=groupedBranch2 -->
+        `,
+      });
+      await dependencyDashboard.readDashboardBody(conf);
+      expect(conf.dependencyDashboardChecks).toMatchObject({
+        groupedBranch1: 'approveGroup',
+      });
+    });
   });
 
   describe('ensureDependencyDashboard()', () => {
@@ -685,6 +702,47 @@ describe('workers/repository/dependency-dashboard', () => {
       await dryRun(branches, platform, 0, 1);
     });
 
+    it('checks an issue with group size not met branches', async () => {
+      const branches: BranchConfig[] = [
+        {
+          ...mock<BranchConfig>(),
+          upgrades: [{ ...mock<PrUpgrade>(), depName: 'dep1' }],
+          result: 'minimum-group-size-not-met',
+          branchName: 'groupBranch1',
+        },
+      ];
+      config.dependencyDashboard = true;
+      await dependencyDashboard.ensureDependencyDashboard(
+        config,
+        branches,
+        {},
+        { result: 'no-migration' },
+      );
+      expect(platform.ensureIssueClosing).toHaveBeenCalledTimes(0);
+      expect(platform.ensureIssue).toHaveBeenCalledTimes(1);
+      expect(platform.ensureIssue.mock.calls[0][0].title).toBe(
+        config.dependencyDashboardTitle,
+      );
+      expect(platform.ensureIssue.mock.calls[0][0].body.trim()).toBe(
+        codeBlock`
+This issue lists Renovate updates and detected dependencies. Read the [Dependency Dashboard](https://docs.renovatebot.com/key-concepts/dashboard/) docs to learn more.
+
+## Group Size Not Met
+
+The following branches have not met their minimum group size. To create them, click on a checkbox below.
+
+ - [ ] <!-- approveGroup-branch=groupBranch1 -->undefined
+
+## Detected dependencies
+
+None detected
+`,
+      );
+
+      // same with dry run
+      await dryRun(branches, platform, 0, 1);
+    });
+
     it('checks an issue with 3 PR in approval', async () => {
       const branches: BranchConfig[] = [
         {

lib/workers/repository/dependency-dashboard.ts

@@ -395,6 +395,13 @@ export async function ensureDependencyDashboard(
     'Create all pending approval PRs at once',
     '🔐',
   );
+  issueBody += getBranchesListMd(
+    branches,
+    (branch) => branch.result === 'minimum-group-size-not-met',
+    'Group Size Not Met',
+    'The following branches have not met their minimum group size. To create them, click on a checkbox below.',
+    'approveGroup',
+  );
   issueBody += getBranchesListMd(
     branches,
     (branch) => branch.result === 'not-scheduled',
@@ -466,6 +473,7 @@ export async function ensureDependencyDashboard(
     'error',
     'automerged',
     'pr-edited',
+    'minimum-group-size-not-met',
   ];
   const inProgress = branches.filter(
     (branch) =>

lib/workers/repository/update/branch/index.spec.ts

@@ -165,6 +165,19 @@ describe('workers/repository/update/branch/index', () => {
       });
     });
 
+    it('skips branch creation if minimumGroupSize is not met', async () => {
+      scm.branchExists.mockResolvedValue(false);
+      const res = await branchWorker.processBranch({
+        ...config,
+        minimumGroupSize: 3,
+      });
+      expect(res).toEqual({
+        branchExists: false,
+        prNo: undefined,
+        result: 'minimum-group-size-not-met',
+      });
+    });
+
     it('skips branch if not scheduled and not updating out of schedule', async () => {
       schedule.isScheduledNow.mockReturnValueOnce(false);
       config.updateNotScheduled = false;

lib/workers/repository/update/branch/index.ts

@@ -125,6 +125,8 @@ export async function processBranch(
   let config: BranchConfig = { ...branchConfig };
   logger.trace({ config }, 'processBranch()');
   let branchExists = await scm.branchExists(config.branchName);
+  const dependencyDashboardCheck =
+    config.dependencyDashboardChecks?.[config.branchName];
   let updatesVerified = false;
   if (!branchExists && config.branchPrefix !== config.branchPrefixOld) {
     const branchName = config.branchName.replace(
@@ -138,13 +140,26 @@ export async function processBranch(
     }
   }
 
+  if (
+    !branchExists &&
+    branchConfig.minimumGroupSize &&
+    branchConfig.minimumGroupSize > branchConfig.upgrades.length &&
+    !dependencyDashboardCheck
+  ) {
+    logger.debug(
+      `Skipping branch creation as minimumGroupSize: ${branchConfig.minimumGroupSize} is not met`,
+    );
+    return {
+      branchExists: false,
+      result: 'minimum-group-size-not-met',
+    };
+  }
+
   let branchPr = await platform.getBranchPr(
     config.branchName,
     config.baseBranch,
   );
   logger.debug(`branchExists=${branchExists}`);
-  const dependencyDashboardCheck =
-    config.dependencyDashboardChecks?.[config.branchName];
   logger.debug(`dependencyDashboardCheck=${dependencyDashboardCheck!}`);
   if (branchPr) {
     config.rebaseRequested = await rebaseCheck(config, branchPr);

lib/workers/repository/updates/__snapshots__/generate.spec.ts.snap

@@ -21,6 +21,7 @@ exports[`workers/repository/updates/generate > generateBranchConfig() > handles
     "b",
   ],
   "manager": "some-manager",
+  "minimumGroupSize": 1,
   "newValue": "0.6.0",
   "prBodyColumns": [],
   "prTitle": "some-title",
@@ -112,6 +113,7 @@ exports[`workers/repository/updates/generate > generateBranchConfig() > handles
   "isRange": false,
   "labels": [],
   "manager": "some-manager",
+  "minimumGroupSize": 1,
   "newValue": "0.6.0",
   "prBodyColumns": [],
   "prTitle": "some-title",
@@ -194,6 +196,7 @@ exports[`workers/repository/updates/generate > generateBranchConfig() > handles
   "isLockFileMaintenance": true,
   "labels": [],
   "manager": "some-manager",
+  "minimumGroupSize": 1,
   "prBodyColumns": [],
   "prTitle": "some-title",
   "prettyDepType": "dependency",
@@ -239,6 +242,7 @@ exports[`workers/repository/updates/generate > generateBranchConfig() > handles
   "labels": [],
   "lockedVersion": "1.0.0",
   "manager": "some-manager",
+  "minimumGroupSize": 1,
   "newValue": "^1.0.0",
   "newVersion": "1.0.1",
   "prBodyColumns": [],

lib/workers/repository/updates/generate.spec.ts

@@ -48,6 +48,7 @@ describe('workers/repository/updates/generate', () => {
       expect(res.groupName).toBeUndefined();
       expect(res.releaseTimestamp).toBeDefined();
       expect(res.recreateClosed).toBe(false);
+      expect(res.minimumGroupSize).toBe(1);
     });
 
     it('handles lockFileMaintenance', () => {
@@ -75,6 +76,34 @@ describe('workers/repository/updates/generate', () => {
       });
     });
 
+    it('sets minimumGroupSize based on upgrades', () => {
+      const branch = [
+        {
+          manager: 'some-manager',
+          branchName: 'some-branch',
+          prTitle: 'some-title',
+          minimumGroupSize: 1,
+        },
+        {
+          manager: 'some-manager',
+          branchName: 'some-branch',
+          prTitle: 'some-title',
+          minimumGroupSize: 2,
+        },
+        {
+          manager: 'some-manager',
+          branchName: 'some-branch',
+          prTitle: 'some-title',
+          minimumGroupSize: 3,
+        },
+      ] satisfies BranchUpgradeConfig[];
+      const res = generateBranchConfig(branch);
+      expect(res.minimumGroupSize).toBe(3);
+      expect(logger.logger.debug).toHaveBeenCalledWith(
+        'Multiple minimumGroupSize values found for this branch, using highest.',
+      );
+    });
+
     it('handles lockFileUpdate', () => {
       const branch = [
         {

lib/workers/repository/updates/generate.ts

@@ -160,6 +160,28 @@ function compilePrTitle(
   logger.trace(`prTitle: ` + JSON.stringify(upgrade.prTitle));
 }
 
+function getMinimumGroupSize(upgrades: BranchUpgradeConfig[]): number {
+  let minimumGroupSize = 1;
+  const groupSizes = new Set<number>();
+
+  for (const upg of upgrades) {
+    if (upg.minimumGroupSize) {
+      groupSizes.add(upg.minimumGroupSize);
+      if (minimumGroupSize < upg.minimumGroupSize) {
+        minimumGroupSize = upg.minimumGroupSize;
+      }
+    }
+  }
+
+  if (groupSizes.size > 1) {
+    logger.debug(
+      'Multiple minimumGroupSize values found for this branch, using highest.',
+    );
+  }
+
+  return minimumGroupSize;
+}
+
 // Sorted by priority, from low to high
 const semanticCommitTypeByPriority = ['chore', 'ci', 'build', 'fix', 'feat'];
 
@@ -461,6 +483,7 @@ export function generateBranchConfig(
     }
   }
 
+  config.minimumGroupSize = getMinimumGroupSize(config.upgrades);
   // Set skipInstalls to false if any upgrade in the branch has it false
   config.skipInstalls = config.upgrades.every(
     (upgrade) => upgrade.skipInstalls !== false,