Tag Filters: GitHub Release Task

Tasks/GitHubReleaseV0/main.ts

@@ -46,9 +46,12 @@ class Main {
                 const githubReleaseAssetInputPatterns = tl.getDelimitedInput(Inputs.assets, Delimiters.newLine);
 
                 if (action === ActionType.create) {
+                    //Get task inputs specific to create release
+                    const tagPattern = tl.getInput(Inputs.tagPattern) || undefined;
+
                     // Get tag to create release if tag source is gitTag/auto
                     if (Utility.isTagSourceAuto(tagSource)) {
-                        tag = await helper.getTagForCommitTarget(githubEndpointToken, repositoryName, target);
+                        tag = await helper.getTagForCommitTarget(githubEndpointToken, repositoryName, target, tagPattern);
                     }
 
                     if (!!tag) {

Tasks/GitHubReleaseV0/operations/Constants.ts

@@ -16,4 +16,5 @@ export class Inputs {
     public static readonly releaseNotes = "releaseNotes";
     public static readonly addChangeLog = "addChangeLog";
     public static readonly deleteExistingAssets = "deleteExistingAssets";
+    public static readonly tagPattern = "tagPattern";
 }

Tasks/GitHubReleaseV0/operations/Helper.ts

@@ -24,6 +24,7 @@ export class Helper {
 
     /**
      * Returns tag name to be used for creating a release.
+     * If tagPattern is specified, returns tag matching the given pattern
      * If user has specified tag, then use it 
      * else if $(Build.SourceBranch) is referencing to a tag, then parse tag name and use it
      * else fetch tag from the target specified by user
@@ -34,8 +35,9 @@ export class Helper {
      * @param repositoryName 
      * @param target 
      * @param tag 
+     * @param tagPattern
      */
-    public async getTagForCommitTarget(githubEndpointToken: string, repositoryName: string, target: string): Promise<string> {
+    public async getTagForCommitTarget(githubEndpointToken: string, repositoryName: string, target: string, tagPattern: string = null): Promise<string> {
         console.log(tl.loc("FetchTagForTarget", target));
         let tag = undefined; 
 
@@ -45,7 +47,7 @@ export class Helper {
 
         // If the buildSourceVersion and user specified target does not match, then prefer user specified target
         if (commit_sha !== buildSourceVersion) {
-            tag = await this._getTagForCommit(githubEndpointToken, repositoryName, commit_sha);
+            tag = await this._getTagForCommit(githubEndpointToken, repositoryName, commit_sha, tagPattern);
         }
         else {
             let buildSourceBranch = tl.getVariable(AzureDevOpsVariables.buildSourceBranch);
@@ -55,9 +57,13 @@ export class Helper {
             // Else fetch tag from commit
             if (!!normalizedBranch) {
                 tag = normalizedBranch;
+                if (!!tagPattern && !Utility.isTagMatches(tag, tagPattern)) {
+                    tag = null;
+                    tl.warning(tl.loc("NoMatchingTagsFound", tagPattern));
+                }
             }
             else {
-                tag = await this._getTagForCommit(githubEndpointToken, repositoryName, commit_sha);
+                tag = await this._getTagForCommit(githubEndpointToken, repositoryName, commit_sha, tagPattern);
             }
         }
 
@@ -238,16 +244,29 @@ export class Helper {
 
     /**
      * Returns tag name associated with the commit.
+     * If tagPattern is specified returns tag name
      * If 0 tag found return undefined
      * else if 1 tag found return tag name
      * else throw error
      * @param githubEndpointToken 
      * @param repositoryName 
      * @param commit_sha 
      */
-    private async _getTagForCommit(githubEndpointToken: string, repositoryName: string, commit_sha: string): Promise<string> {
-        let filteredTag: any = await this.filterTag(githubEndpointToken, repositoryName, commit_sha, this._filterTagsByCommitSha);
+    private async _getTagForCommit(githubEndpointToken: string, repositoryName: string, commit_sha: string, tagPattern: string = null): Promise<string> {
+        let filteredTag: any;
 
+        if (!tagPattern) {
+            filteredTag = await this.filterTag(githubEndpointToken, repositoryName, commit_sha, this._filterTagsByCommitSha);
+        }
+        else {
+            let filterTagsbyCommitShaAndTagPattern = (tagsList: any[], commit_sha: string): any[] => {
+                tagsList = this._filterTagsByCommitSha(tagsList, commit_sha);
+                return tagsList.filter((tag: any) => Utility.isTagMatches(tag[GitHubAttributes.nameAttribute], tagPattern));
+            }
+
+            filteredTag = await this.filterTag(githubEndpointToken, repositoryName, commit_sha, filterTagsbyCommitShaAndTagPattern);
+        }
+
         return filteredTag && filteredTag[GitHubAttributes.nameAttribute];
     }
 

Tasks/GitHubReleaseV0/operations/Utility.ts

@@ -239,6 +239,11 @@ export class Utility {
 
     }
 
+    public static isTagMatches(tag: string, tagPattern: string): boolean {
+        let tagPatternRegex = new RegExp("^" + tagPattern + "$");
+        return tagPatternRegex.test(tag);
+    }
+
     private static readonly _onlyFirstLine = new RegExp("^.*$", "m");
     private static readonly _githubPaginatedLinkRegex = new RegExp("^<(.*)>$");
     private static readonly _githubPaginatedRelRegex = new RegExp('^rel="(.*)"$');

Tasks/GitHubReleaseV0/task.json

@@ -14,7 +14,7 @@
     "preview": true,
     "version": {
         "Major": 0,
-        "Minor": 153,
+        "Minor": 154,
         "Patch": 0
     },
     "demands": [],
@@ -75,6 +75,14 @@
                 "manual": "User specified tag"
             }
         },
+        {
+            "name": "tagPattern",
+            "type": "string",
+            "label": "Tag Pattern",
+            "required": false,
+            "visibleRule": "tagSource = auto",
+            "helpMarkDown": "Specify the regex for tag to be used for release creation."
+        },
         {
             "name": "tag",
             "type": "string",
@@ -261,6 +269,7 @@
         "TagRequiredCreateAction": "Tag source is set to manual- please specify a tag for create action. For yaml syntax see: https://aka.ms/AA3m1bq",
         "NoFileFoundMatchingPattern": "No files found matching '%s'. Nothing to upload.",
         "PatternIsADirectory": "'%s' cannot be uploaded as it is a directory. Please specify a file.",
-        "SearchingFileMatchingPattern": "Searching for file(s) matching '%s'."
+        "SearchingFileMatchingPattern": "Searching for file(s) matching '%s'.",
+        "NoMatchingTagsFound": "No Matching tags found for given regex: %s  Unable to perform the action."
     }
 }