Merge pull request #572 from mikepenz/feature/571

New API to transform tag names prior to sorting | Fix tag filter

dist/index.js

@@ -174,7 +174,8 @@ exports.DefaultConfiguration = {
     tag_resolver: {
         // defines the logic on how to resolve the previous tag, only relevant if `fromTag` is not specified
         method: 'semver',
-        filter: undefined // filter out all tags not matching the regex
+        filter: undefined,
+        transformer: undefined // transforms the tag name using the regex, run after the filter
     },
     base_branches: [] // target branches for the merged PR ignoring PRs with different target branch, by default it will get all PRs
 };
@@ -891,6 +892,7 @@ const github = __importStar(__nccwpck_require__(5438));
 const semver = __importStar(__nccwpck_require__(1383));
 const semver_1 = __nccwpck_require__(1383);
 const gitHelper_1 = __nccwpck_require__(353);
+const transform_1 = __nccwpck_require__(1644);
 class Tags {
     constructor(octokit) {
         this.octokit = octokit;
@@ -973,7 +975,32 @@ class Tags {
     retrieveRange(repositoryPath, owner, repo, fromTag, toTag, ignorePreReleases, maxTagsToFetch, tagResolver) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const tags = sortTags(yield this.getTags(owner, repo, maxTagsToFetch), tagResolver);
+            // filter out tags not matching the specified filter
+            const filteredTags = filterTags(
+            // retrieve the tags from the API
+            yield this.getTags(owner, repo, maxTagsToFetch), tagResolver);
+            // check if a transformer was defined
+            const tagTransformer = (0, transform_1.validateTransformer)(tagResolver.transformer);
+            let transformedTags;
+            if (tagTransformer != null) {
+                core.debug(`ℹ️ Using configured tagTransformer`);
+                transformedTags = transformTags(filteredTags, tagTransformer);
+            }
+            else {
+                transformedTags = filteredTags;
+            }
+            let tags = sortTags(transformedTags, tagResolver);
+            if (tagTransformer != null) {
+                // restore the original name, after sorting
+                tags = filteredTags.map(function (tag) {
+                    if (tag.hasOwnProperty('tmp')) {
+                        return { name: tag.tmp, commit: tag.commit };
+                    }
+                    else {
+                        return tag;
+                    }
+                });
+            }
             let resultToTag;
             let resultFromTag;
             // ensure to resolve the toTag if it was not provided
@@ -1041,13 +1068,34 @@ function filterTags(tags, tagResolver) {
     const filter = tagResolver.filter;
     if (filter !== undefined) {
         const regex = new RegExp(filter.pattern.replace('\\\\', '\\'), (_a = filter.flags) !== null && _a !== void 0 ? _a : 'gu');
-        return tags.filter(tag => tag.name.match(regex) !== null);
+        const filteredTags = tags.filter(tag => tag.name.match(regex) !== null);
+        core.debug(`ℹ️ Filtered tags count: ${filteredTags.length}, original count: ${tags.length}`);
+        return filteredTags;
     }
     else {
         return tags;
     }
 }
 exports.filterTags = filterTags;
+/**
+ * Helper function to transform the tag name given the transformer
+ */
+function transformTags(tags, transformer) {
+    return tags.map(function (tag) {
+        if (transformer.pattern) {
+            const transformedName = tag.name.replace(transformer.pattern, transformer.target);
+            core.debug(`ℹ️ Transformed ${tag.name} to ${transformedName}`);
+            return {
+                tmp: tag.name,
+                name: transformedName,
+                commit: tag.commit
+            };
+        }
+        else {
+            return tag;
+        }
+    });
+}
 /*
   Sorts an array of tags as shown below:
   
@@ -1142,7 +1190,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.fillAdditionalPlaceholders = exports.buildChangelog = void 0;
+exports.validateTransformer = exports.fillAdditionalPlaceholders = exports.buildChangelog = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const configuration_1 = __nccwpck_require__(5527);
 const pullRequests_1 = __nccwpck_require__(4217);
@@ -1361,6 +1409,7 @@ function validateTransformer(transformer) {
         return null;
     }
 }
+exports.validateTransformer = validateTransformer;
 function extractValues(pr, extractor, extractor_usecase) {
     if (extractor.pattern == null) {
         return null;

src/configuration.ts

@@ -38,7 +38,8 @@ export interface Extractor extends Transformer {
 
 export interface TagResolver {
   method: string // semver, sort
-  filter?: Regex // the regex to filter the tags
+  filter?: Regex // the regex to filter the tags, prior to sorting
+  transformer?: Transformer // transforms the tag name using the regex, run after the filter
 }
 
 export const DefaultConfiguration: Configuration = {
@@ -71,7 +72,8 @@ export const DefaultConfiguration: Configuration = {
   tag_resolver: {
     // defines the logic on how to resolve the previous tag, only relevant if `fromTag` is not specified
     method: 'semver', // defines which method to use, by default it will use `semver` (dropping all non matching tags). Alternative `sort` is also available.
-    filter: undefined // filter out all tags not matching the regex
+    filter: undefined, // filter out all tags not matching the regex
+    transformer: undefined // transforms the tag name using the regex, run after the filter
   },
   base_branches: [] // target branches for the merged PR ignoring PRs with different target branch, by default it will get all PRs
 }

src/tags.ts

@@ -5,6 +5,7 @@ import {Octokit, RestEndpointMethodTypes} from '@octokit/rest'
 import {SemVer} from 'semver'
 import {TagResolver} from './configuration'
 import {createCommandManager} from './gitHelper'
+import {RegexTransformer, validateTransformer} from './transform'
 
 export interface TagResult {
   from: TagInfo | null
@@ -16,6 +17,10 @@ export interface TagInfo {
   commit: string
 }
 
+export interface SortableTagInfo extends TagInfo {
+  tmp: string
+}
+
 export class Tags {
   constructor(private octokit: Octokit) {}
 
@@ -114,11 +119,37 @@ export class Tags {
     maxTagsToFetch: number,
     tagResolver: TagResolver
   ): Promise<TagResult> {
-    const tags = sortTags(
+    // filter out tags not matching the specified filter
+    const filteredTags = filterTags(
+      // retrieve the tags from the API
       await this.getTags(owner, repo, maxTagsToFetch),
       tagResolver
     )
 
+    // check if a transformer was defined
+    const tagTransformer = validateTransformer(tagResolver.transformer)
+
+    let transformedTags: TagInfo[]
+    if (tagTransformer != null) {
+      core.debug(`ℹ️ Using configured tagTransformer`)
+      transformedTags = transformTags(filteredTags, tagTransformer)
+    } else {
+      transformedTags = filteredTags
+    }
+
+    let tags = sortTags(transformedTags, tagResolver)
+
+    if (tagTransformer != null) {
+      // restore the original name, after sorting
+      tags = filteredTags.map(function (tag) {
+        if (tag.hasOwnProperty('tmp')) {
+          return {name: (tag as SortableTagInfo).tmp, commit: tag.commit}
+        } else {
+          return tag
+        }
+      })
+    }
+
     let resultToTag: TagInfo | null
     let resultFromTag: TagInfo | null
 
@@ -205,12 +236,41 @@ export function filterTags(
       filter.pattern.replace('\\\\', '\\'),
       filter.flags ?? 'gu'
     )
-    return tags.filter(tag => tag.name.match(regex) !== null)
+    const filteredTags = tags.filter(tag => tag.name.match(regex) !== null)
+    core.debug(
+      `ℹ️ Filtered tags count: ${filteredTags.length}, original count: ${tags.length}`
+    )
+    return filteredTags
   } else {
     return tags
   }
 }
 
+/**
+ * Helper function to transform the tag name given the transformer
+ */
+function transformTags(
+  tags: TagInfo[],
+  transformer: RegexTransformer
+): TagInfo[] {
+  return tags.map(function (tag) {
+    if (transformer.pattern) {
+      const transformedName = tag.name.replace(
+        transformer.pattern,
+        transformer.target
+      )
+      core.debug(`ℹ️ Transformed ${tag.name} to ${transformedName}`)
+      return {
+        tmp: tag.name, // remember the original name
+        name: transformedName,
+        commit: tag.commit
+      }
+    } else {
+      return tag
+    }
+  })
+}
+
 /*
   Sorts an array of tags as shown below:
   

src/transform.ts

@@ -293,7 +293,7 @@ function validateTransformers(
     })
 }
 
-function validateTransformer(
+export function validateTransformer(
   transformer?: Transformer
 ): RegexTransformer | null {
   if (transformer === undefined) {
@@ -359,7 +359,7 @@ function extractValues(
   return null
 }
 
-interface RegexTransformer {
+export interface RegexTransformer {
   pattern: RegExp | null
   target: string
   onProperty?: 'title' | 'author' | 'milestone' | 'body' | undefined