fix: correctly determine release to add to a channel

- Add only the most recent release to a channel (rather than adding all the one not added yet)
- Avoid attempting to ad the version twice in case that version is already present in multiple upper branches

lib/branches/get-tags.js

@@ -1,4 +1,4 @@
-const {template, escapeRegExp} = require('lodash');
+const {template, escapeRegExp, flatMap} = require('lodash');
 const semver = require('semver');
 const pReduce = require('p-reduce');
 const debug = require('debug')('semantic-release:get-tags');
@@ -14,10 +14,21 @@ module.exports = async ({cwd, env, options: {tagFormat}}, branches) => {
   return pReduce(
     branches,
     async (branches, branch) => {
-      const branchTags = (await getTags(branch.name, {cwd, env})).reduce((tags, tag) => {
+      const versions = (await getTags(branch.name, {cwd, env})).reduce((versions, tag) => {
         const [, version, channel] = tag.match(tagRegexp) || [];
-        return version && semver.valid(semver.clean(version)) ? [...tags, {gitTag: tag, version, channel}] : tags;
-      }, []);
+        if (version && semver.valid(semver.clean(version))) {
+          return {
+            ...versions,
+            [version]: versions[version]
+              ? {...versions[version], channels: [...versions[version].channels, channel]}
+              : {gitTag: tag, version, channels: [channel]},
+          };
+        }
+
+        return versions;
+      }, {});
+
+      const branchTags = flatMap(versions);
 
       debug('found tags for branch %s: %o', branch.name, branchTags);
       return [...branches, {...branch, tags: branchTags}];

lib/get-last-release.js

@@ -27,16 +27,17 @@ const {makeTag, isSameChannel} = require('./utils');
  * @return {LastRelease} The last tagged release or empty object if none is found.
  */
 module.exports = ({branch, options: {tagFormat}}, {before} = {}) => {
-  const [{version, gitTag, channel} = {}] = branch.tags
+  const [{version, gitTag, channels} = {}] = branch.tags
     .filter(
       tag =>
-        (branch.type === 'prerelease' && isSameChannel(branch.channel, tag.channel)) || !semver.prerelease(tag.version)
+        (branch.type === 'prerelease' && tag.channels.some(channel => isSameChannel(branch.channel, channel))) ||
+        !semver.prerelease(tag.version)
     )
     .filter(tag => isUndefined(before) || semver.lt(tag.version, before))
     .sort((a, b) => semver.rcompare(a.version, b.version));
 
   if (gitTag) {
-    return {version, gitTag, channel, gitHead: gitTag, name: makeTag(tagFormat, version)};
+    return {version, gitTag, channels, gitHead: gitTag, name: makeTag(tagFormat, version)};
   }
 
   return {};

lib/get-next-version.js

@@ -8,7 +8,8 @@ module.exports = ({branch, nextRelease: {type, channel}, lastRelease, logger}) =
     const {major, minor, patch} = semver.parse(lastRelease.version);
     version =
       branch.type === 'prerelease'
-        ? semver.prerelease(lastRelease.version) && isSameChannel(lastRelease.channel, channel)
+        ? semver.prerelease(lastRelease.version) &&
+          lastRelease.channels.some(lastReleaseChannel => isSameChannel(lastReleaseChannel, channel))
           ? semver.inc(lastRelease.version, 'prerelease')
           : `${semver.inc(`${major}.${minor}.${patch}`, type)}-${branch.prerelease}.${FIRSTPRERELEASE}`
         : semver.inc(lastRelease.version, type);

lib/get-release-to-add.js

@@ -0,0 +1,60 @@
+const {uniqBy, intersection} = require('lodash');
+const semver = require('semver');
+const semverDiff = require('semver-diff');
+const getLastRelease = require('./get-last-release');
+const {makeTag, getLowerBound} = require('./utils');
+
+/**
+ * Find releases that have been merged from from a higher branch but not added on the channel of the current branch.
+ *
+ * @param {Object} context semantic-release context.
+ *
+ * @return {Array<Object>} Last release and next release to be added on the channel of the current branch.
+ */
+module.exports = context => {
+  const {
+    branch,
+    branches,
+    options: {tagFormat},
+  } = context;
+
+  const higherChannels = branches
+    // Consider only releases of higher branches
+    .slice(branches.findIndex(({name}) => name === branch.name) + 1)
+    // Exclude prerelease branches
+    .filter(({type}) => type !== 'prerelease')
+    .map(({channel}) => channel);
+
+  const versiontoAdd = uniqBy(
+    branch.tags.filter(
+      ({channels, version}) =>
+        !channels.includes(branch.channel) &&
+        intersection(channels, higherChannels).length > 0 &&
+        (branch.type !== 'maintenance' || semver.gte(version, getLowerBound(branch.mergeRange)))
+    ),
+    'version'
+  ).sort((a, b) => semver.compare(b.version, a.version))[0];
+
+  if (versiontoAdd) {
+    const {version, gitTag, channels} = versiontoAdd;
+    const lastRelease = getLastRelease(context, {before: version});
+    if (semver.gt(getLastRelease(context).version, version)) {
+      return;
+    }
+
+    const type = lastRelease.version ? semverDiff(lastRelease.version, version) : 'major';
+    const name = makeTag(tagFormat, version);
+    return {
+      lastRelease,
+      currentRelease: {type, version, channels, gitTag, name, gitHead: gitTag},
+      nextRelease: {
+        type,
+        version,
+        channel: branch.channel,
+        gitTag: makeTag(tagFormat, version, branch.channel),
+        name,
+        gitHead: gitTag,
+      },
+    };
+  }
+};

lib/get-releases-to-add.js

@@ -1,71 +0,0 @@
-const {uniq} = require('lodash');
-const semver = require('semver');
-const semverDiff = require('semver-diff');
-const getLastRelease = require('./get-last-release');
-const {makeTag, getLowerBound} = require('./utils');
-
-/**
- * Find releases that have been merged from from a higher branch but not added on the channel of the current branch.
- *
- * @param {Object} context semantic-release context.
- *
- * @return {Array<Object>} Last release and next release to be added on the channel of the current branch.
- */
-module.exports = context => {
-  const {
-    branch,
-    branches,
-    options: {tagFormat},
-  } = context;
-
-  return (
-    branches
-      // Consider only releases of higher branches
-      .slice(branches.findIndex(({name}) => name === branch.name) + 1)
-      // Exclude prerelease branches
-      .filter(({type}) => type !== 'prerelease')
-      // Find higher branch releases merged to building branch but not released on associated channel
-      .reduce(
-        (releases, higherBranch) => [
-          ...releases,
-          // For all unique release version of the higher branch merged on current branch, excluding lower than start range version for maintenance branches
-          ...uniq(
-            branch.tags.filter(
-              ({channel, version}) =>
-                channel === higherBranch.channel &&
-                channel !== branch.channel &&
-                (branch.type !== 'maintenance' || semver.gte(version, getLowerBound(branch.mergeRange)))
-            )
-          )
-            // Find ones that are not released on the building branch channel
-            .filter(tag =>
-              branch.tags.every(
-                ({version, channel}) =>
-                  version !== tag.version || channel === higherBranch.channel || channel !== branch.channel
-              )
-            )
-            // Sort in ascending order to add the most recent release last
-            .sort((a, b) => semver.compare(a.version, b.version))
-            // Construct the last and next release to add to the building branch channel
-            .map(({version, gitTag}) => {
-              const lastRelease = getLastRelease(context, {before: version});
-              const type = lastRelease.version ? semverDiff(lastRelease.version, version) : 'major';
-              const name = makeTag(tagFormat, version);
-              return {
-                lastRelease,
-                currentRelease: {type, version, channel: higherBranch.channel, gitTag, name, gitHead: gitTag},
-                nextRelease: {
-                  type,
-                  version,
-                  channel: branch.channel,
-                  gitTag: makeTag(tagFormat, version, branch.channel),
-                  name,
-                  gitHead: gitTag,
-                },
-              };
-            }),
-        ],
-        []
-      )
-  );
-};