Add tags in Azure DevOps based on GitHub issue labels (#358)

* Add code to map GH labels to AzDo Tags

Add a config  option to map from GitHub label to Azure DevOps tag.

When creating a new Azure DevOps work item, add any tags from matching GitHub labels.

* a little formatting

Author: BillWagner

actions/sequester/ImportIssues/Program.cs

@@ -115,6 +115,7 @@ private static async Task<QuestGitHubService> CreateService(ImportOptions option
                 options.ImportTriggerLabel,
                 options.ImportedLabel,
                 options.DefaultParentNode,
-                options.ParentNodes);
+                options.ParentNodes,
+                options.WorkItemTags);
     }
 }

actions/sequester/Quest2GitHub/Models/IssueExtensions.cs

@@ -91,4 +91,22 @@ month descending
         }
         return default;
     }
+
+    /// <summary>
+    /// Return tags for a given issue
+    /// </summary>
+    /// <param name="issue">The GitHub issue or pull request</param>
+    /// <param name="tags">The mapping from issue to tag</param>
+    /// <returns>An enumerable of tags</returns>
+    public static IEnumerable<string> WorkItemTagsForIssue(this QuestIssueOrPullRequest issue, IEnumerable<LabelToTagMap> tags)
+    {
+        foreach (var label in issue.Labels)
+        {
+            var tag = tags.FirstOrDefault(t => t.Label == label.Name);
+            if (tag.Tag is not null)
+            {
+                yield return tag.Tag;
+            }
+        }
+    }
 }

actions/sequester/Quest2GitHub/Models/QuestWorkItem.cs

@@ -88,6 +88,8 @@ public class QuestWorkItem
     /// </remarks>
     public required int? ParentRelationIndex { get; init; }
 
+    public required IEnumerable<string> Tags { get; init; }
+
     /// <summary>
     /// Create a work item object from the ID
     /// </summary>
@@ -110,6 +112,8 @@ public static async Task<QuestWorkItem> QueryWorkItem(QuestClient client, int wo
     /// <param name="path">The path component for the area path.</param>
     /// <param name="currentIteration">The current AzDo iteration</param>
     /// <param name="allIterations">The set of all iterations to search</param>
+    /// <param name="requestLabelNodeId">The ID of the request label</param>
+    /// <param name="tagMap">The map of GH label to tags</param>
     /// <returns>The newly created linked Quest work item.</returns>
     /// <remarks>
     /// Fill in the Json patch document from the GitHub issue.
@@ -124,7 +128,8 @@ public static async Task<QuestWorkItem> CreateWorkItemAsync(QuestIssueOrPullRequ
         string path,
         string? requestLabelNodeId,
         QuestIteration currentIteration,
-        IEnumerable<QuestIteration> allIterations)
+        IEnumerable<QuestIteration> allIterations,
+        IEnumerable<LabelToTagMap> tagMap)
     {
         string areaPath = $"""{questClient.QuestProject}\{path}""";
 
@@ -212,6 +217,17 @@ public static async Task<QuestWorkItem> CreateWorkItemAsync(QuestIssueOrPullRequ
             });
         }
 
+        var tags = issue.WorkItemTagsForIssue(tagMap);
+        if (tags.Any())
+        {
+            string azDoTags = string.Join(";", tags);
+            patchDocument.Add(new JsonPatchDocument
+            {
+                Operation = Op.Add,
+                Path = "/fields/System.Tags",
+                Value = azDoTags
+            });
+        }
         /* This is ignored by Azure DevOps. It uses the PAT of the 
          * account running the code.
         var creator = await issue.AuthorMicrosoftPreferredName(ospoClient);
@@ -360,6 +376,9 @@ public static QuestWorkItem WorkItemFromJson(JsonElement root)
             (int)double.Truncate(storyPointNode.GetDouble()) : null;
         string? assignedID = (assignedNode.ValueKind is JsonValueKind.String) ?
             assignedNode.GetString() : null;
+        string tagElement = fields.TryGetProperty("System.Tags", out JsonElement tagsNode) ?
+            tagsNode.GetString()! : string.Empty;
+        IEnumerable<string> tags = [..tagElement.Split(';').Select(s => s.Trim())];
         return new QuestWorkItem
         {
             Id = id,
@@ -371,7 +390,8 @@ public static QuestWorkItem WorkItemFromJson(JsonElement root)
             AreaPath = areaPath,
             IterationPath = iterationPath,
             AssignedToId = (assignedID is not null) ? new Guid(assignedID) : null,
-            StoryPoints = storyPoints
+            StoryPoints = storyPoints,
+            Tags = tags
         };
     }
 

actions/sequester/Quest2GitHub/Options/ImportOptions.cs

@@ -2,6 +2,8 @@
 
 public record struct ParentForLabel(string Label, int ParentNodeId);
 
+public record struct LabelToTagMap(string Label, string Tag);
+
 public sealed record class ImportOptions
 {
     /// <summary>
@@ -64,4 +66,13 @@ public sealed record class ImportOptions
     /// the default parent node is set for the work item.
     /// </remarks>
     public int DefaultParentNode { get; init; }
+
+    /// <summary>
+    /// A map of GitHub labels to Azure DevOps tags.
+    /// </summary>
+    /// <remarks>
+    /// If an issue has the matching label, add the corresponding tag to
+    /// the mapped AzureDevOps item.
+    /// </remarks>
+    public List<LabelToTagMap> WorkItemTags { get; init; } = [];
 }

actions/sequester/Quest2GitHub/QuestGitHubService.cs

@@ -37,7 +37,8 @@ public class QuestGitHubService(
     string importTriggerLabelText,
     string importedLabelText,
     int defaultParentNode,
-    List<ParentForLabel> parentNodes) : IDisposable
+    List<ParentForLabel> parentNodes,
+    IEnumerable<LabelToTagMap> tagMap) : IDisposable
 {
     private const string LinkedWorkItemComment = "Associated WorkItem - ";
     private readonly QuestClient _azdoClient = new(azdoKey, questOrg, questProject);
@@ -95,7 +96,7 @@ async Task ProcessItems(IAsyncEnumerable<QuestIssueOrPullRequest> items)
                     {
                         if (questItem != null)
                         {
-                            await UpdateWorkItemAsync(questItem, item, _allIterations);
+                            await UpdateWorkItemAsync(questItem, item, _allIterations, tagMap);
                         }
                         else
                         {
@@ -183,7 +184,7 @@ public async Task ProcessIssue(string gitHubOrganization, string gitHubRepositor
             {
                 // This allows a human to force a manual update: just add the trigger label.
                 // Note that it updates even if the item is closed.
-                await UpdateWorkItemAsync(questItem, ghIssue, _allIterations);
+                await UpdateWorkItemAsync(questItem, ghIssue, _allIterations, tagMap);
 
             }
             // Next, if the item is already linked, consider any updates.
@@ -194,7 +195,7 @@ public async Task ProcessIssue(string gitHubOrganization, string gitHubRepositor
         }
         else if (sequestered && questItem is not null)
         {
-            await UpdateWorkItemAsync(questItem, ghIssue, _allIterations);
+            await UpdateWorkItemAsync(questItem, ghIssue, _allIterations, tagMap);
         }
     }
 
@@ -244,15 +245,15 @@ private async Task<QuestIteration[]> RetrieveIterationLabelsAsync()
         return [.. iterations];
     }
 
-
     private async Task<QuestWorkItem?> LinkIssueAsync(QuestIssueOrPullRequest issueOrPullRequest, QuestIteration currentIteration, IEnumerable<QuestIteration> allIterations)
     {
         int? workItem = LinkedQuestId(issueOrPullRequest);
         int parentId = parentIdFromIssue(issueOrPullRequest);
         if (workItem is null)
         {
             // Create work item:
-            QuestWorkItem questItem = await QuestWorkItem.CreateWorkItemAsync(issueOrPullRequest, parentId, _azdoClient, _ospoClient, areaPath, _importTriggerLabel?.Id, currentIteration, allIterations);
+            QuestWorkItem questItem = await QuestWorkItem.CreateWorkItemAsync(issueOrPullRequest, parentId, _azdoClient, _ospoClient, areaPath,
+                _importTriggerLabel?.Id, currentIteration, allIterations, tagMap);
 
             string linkText = $"[{LinkedWorkItemComment}{questItem.Id}]({_questLinkString}{questItem.Id})";
             string updatedBody = $"""
@@ -291,7 +292,10 @@ private async Task RetrieveLabelIdsAsync(string org, string repo)
         }
     }
 
-    private async Task<QuestWorkItem?> UpdateWorkItemAsync(QuestWorkItem questItem, QuestIssueOrPullRequest ghIssue, IEnumerable<QuestIteration> allIterations)
+    private async Task<QuestWorkItem?> UpdateWorkItemAsync(QuestWorkItem questItem,
+        QuestIssueOrPullRequest ghIssue,
+        IEnumerable<QuestIteration> allIterations,
+        IEnumerable<LabelToTagMap> tagMap)
     {
         int parentId = parentIdFromIssue(ghIssue);
         string? ghAssigneeEmailAddress = await ghIssue.QueryAssignedMicrosoftEmailAddressAsync(_ospoClient);
@@ -392,6 +396,20 @@ private async Task RetrieveLabelIdsAsync(string org, string repo)
                 Value = iterationSize.QuestStoryPoint(),
             });
         }
+        var tags = from t in ghIssue.WorkItemTagsForIssue(tagMap)
+                   where !questItem.Tags.Contains(t)
+                   select t;
+        if (tags.Any())
+        {
+            string azDoTags = string.Join(";", tags);
+            patchDocument.Add(new JsonPatchDocument
+            {
+                Operation = Op.Add,
+                Path = "/fields/System.Tags",
+                Value = azDoTags
+            });
+        }
+
         QuestWorkItem? newItem = default;
         if (patchDocument.Count != 0)
         {