Add group pull request capability for dependabot pull requests

index.js

@@ -8,6 +8,7 @@ const {
 } = require('./lib/releases')
 const { findCommitsWithAssociatedPullRequests } = require('./lib/commits')
 const { sortPullRequests } = require('./lib/sort-pull-requests')
+const { groupPullRequests } = require('./lib/group-pull-requests')
 const { log } = require('./lib/log')
 const core = require('@actions/core')
 const { runnerIsActions } = require('./lib/utils')
@@ -181,8 +182,10 @@ module.exports = (app, { getRouter }) => {
         config,
       })
 
+    const groupedMergedPullRequests = groupPullRequests(mergedPullRequests)
+
     const sortedMergedPullRequests = sortPullRequests(
-      mergedPullRequests,
+      groupedMergedPullRequests,
       config['sort-by'],
       config['sort-direction']
     )

lib/group-pull-requests.js

@@ -0,0 +1,54 @@
+const compareVersions = require("compare-versions");
+
+const groupPullRequests = (pullRequests) => {
+
+    const dependabotPRs = {}
+    const otherPRs = []
+
+    const bumpVersionRegExp = new RegExp("Bump ([^\S]+) from ([^\S]+) to ([^\S]+)", "g");
+
+    // group all matching dependabot PRs
+    for (let i in pullRequests) {
+        const currentPR = pullRequests[i]
+
+        if (currentPR.title.match(bumpVersionRegExp)) {
+            const match = [...pullRequests[i].title.matchAll(bumpVersionRegExp)][0]
+
+            const artifact = match[1]
+            const fromVersion = match[2]
+            const toVersion = match[3]
+
+            if (dependabotPRs[artifact]) {
+                const prevDependabotPR = dependabotPRs[artifact]
+                dependabotPRs[artifact] = {
+                    from: (compareVersions(fromVersion, prevDependabotPR.from) < 0) ? fromVersion : prevDependabotPR.from,
+                    to: (compareVersions(toVersion, prevDependabotPR.to) > 0) ? toVersion : prevDependabotPR.to,
+                    pullRequests: [...prevDependabotPR.pullRequests, currentPR.number],
+                    // use the latest PR for creating the final changelog entry
+                    pr: (compareVersions(toVersion, prevDependabotPR.to) > 0) ? currentPR : prevDependabotPR.pr
+                }
+            } else {
+                dependabotPRs[artifact] = {
+                    from: fromVersion,
+                    to: toVersion,
+                    pullRequests: [currentPR.number],
+                    pr: currentPR
+                }
+            }
+        } else {
+            otherPRs.push(currentPR)
+        }
+    }
+
+    // reconstruct all PRs
+    const result = [...otherPRs]
+    for (const [key, value] of Object.entries(dependabotPRs)) {
+        const pr = value.pr
+        pr.title = `Bump ${key} from ${value.from} to ${value.to}`
+        pr.number = value.pullRequests
+        result.push(pr)
+    }
+    return result
+}
+
+exports.groupPullRequests = groupPullRequests

lib/template.js

@@ -12,6 +12,12 @@ const template = (string, object, customReplacers) => {
     let result
     if (object[k] === undefined || object[k] === null) {
       result = k
+    } else if (Array.isArray(object[k])) {
+      // FIXME: this is basically a hack to support changelog entries to refer to multiple PRs
+      //        we assume that a list of values refers to PR numbers. If somebody has a better
+      //        idea how to handle that in a clean way, i.e. to support the change template for
+      //        each individual PR number.
+      result = object[k].map(item => `${item}`).join(',#')
     } else if (typeof object[k] === 'object') {
       result = template(object[k].template, object[k])
     } else {