feat: add tagFormat option to customize Git tag name

lib/get-last-release.js

@@ -1,3 +1,4 @@
+const {escapeRegExp, template} = require('lodash');
 const semver = require('semver');
 const pLocate = require('p-locate');
 const debug = require('debug')('semantic-release:get-last-release');
@@ -15,21 +16,36 @@ const {gitTags, isRefInHistory, gitTagHead} = require('./git');
  * Determine the Git tag and version of the last tagged release.
  *
  * - Obtain all the tags referencing commits in the current branch history
- * - Filter out the ones that are not valid semantic version
- * - Sort the tags
- * - Retrive the highest tag
+ * - Filter out the ones that are not valid semantic version or doesn't match the `tagFormat`
+ * - Sort the versions
+ * - Retrive the highest version
  *
  * @param {Object} logger Global logger.
  * @return {Promise<LastRelease>} The last tagged release or `undefined` if none is found.
  */
-module.exports = async logger => {
-  const tags = (await gitTags()).filter(tag => semver.valid(semver.clean(tag))).sort(semver.rcompare);
+module.exports = async (tagFormat, logger) => {
+  // Generate a regex to parse tags formatted with `tagFormat`
+  // by replacing the `version` variable in the template by `(.+)`.
+  // The `tagFormat` is compiled with space as the `version` as it's an invalid tag character,
+  // so it's guaranteed to no be present in the `tagFormat`.
+  const tagRegexp = escapeRegExp(template(tagFormat)({version: ' '})).replace(' ', '(.+)');
+  const tags = (await gitTags())
+    .map(tag => {
+      return {gitTag: tag, version: (tag.match(tagRegexp) || new Array(2))[1]};
+    })
+    .filter(tag => tag.version && semver.valid(semver.clean(tag.version)))
+    .sort((a, b) => semver.rcompare(a.version, b.version));
+
   debug('found tags: %o', tags);
 
   if (tags.length > 0) {
-    const gitTag = await pLocate(tags, tag => isRefInHistory(tag), {concurrency: 1, preserveOrder: true});
-    logger.log('Found git tag version %s', gitTag);
-    return {gitTag, gitHead: await gitTagHead(gitTag), version: semver.valid(semver.clean(gitTag))};
+    const {gitTag, version} = await pLocate(tags, tag => isRefInHistory(tag.gitTag), {
+      concurrency: 1,
+      preserveOrder: true,
+    });
+    logger.log('Found git tag %s associated with version %s', gitTag, version);
+
+    return {gitHead: await gitTagHead(gitTag), gitTag, version};
   }
 
   logger.log('No git tag version found');