(#146) Introduce the concept of IsPullRequest

Within GitHub, an issue and a pull request are essentially the same thing, at least in terms of how GRM uses them. However, in GitLab, they are uniquely different, and have their own unique numbers, where as in GitHub an issue or pull request just get the next number for the repository. So that we don't have to change too many things in GRM, let's introduce the concept of an IsPullRequest property to the issue model, that way the VcsProvider can provide this information if required, and then use the information to do the right thing when it comes to fetching and updating the information, but internally, GRM will just have a collection of issues, which it then acts on when required.
gep13 · Sep 26, 2023 · daafa32 · daafa32
1 parent eca8e33
commit daafa32
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 3 deletions.
diff --git a/src/GitReleaseManager.Core/MappingProfiles/GitHubProfile.cs b/src/GitReleaseManager.Core/MappingProfiles/GitHubProfile.cs
@@ -10,6 +10,7 @@ public GitHubProfile()
             CreateMap<Octokit.Issue, Model.Issue>()
                 .ForMember(dest => dest.PublicNumber, act => act.MapFrom(src => src.Number))
                 .ForMember(dest => dest.InternalNumber, act => act.MapFrom(src => src.Id))
+                .ForMember(dest => dest.IsPullRequest, act => act.MapFrom(src => src.HtmlUrl.Contains("/pull/")))
                 .ReverseMap();
             CreateMap<Model.IssueComment, Octokit.IssueComment>().ReverseMap();
             CreateMap<Model.ItemState, Octokit.ItemState>().ReverseMap();

diff --git a/src/GitReleaseManager.Core/Model/Issue.cs b/src/GitReleaseManager.Core/Model/Issue.cs
@@ -13,5 +13,7 @@ public sealed class Issue
         public string HtmlUrl { get; set; }
 
         public IReadOnlyList<Label> Labels { get; set; }
+
+        public bool IsPullRequest { get; set; }
     }
 }
diff --git a/src/GitReleaseManager.Core/Provider/GitHubProvider.cs b/src/GitReleaseManager.Core/Provider/GitHubProvider.cs
@@ -351,6 +351,11 @@ public string GetMilestoneQueryString()
             return "closed=1";
         }
 
+        public string GetIssueType(Issue issue)
+        {
+            return issue.IsPullRequest ? "Pull Request" : "Issue";
+        }
+
         private async Task ExecuteAsync(Func<Task> action)
         {
             try

diff --git a/src/GitReleaseManager.Core/Provider/IVcsProvider.cs b/src/GitReleaseManager.Core/Provider/IVcsProvider.cs
@@ -47,5 +47,7 @@ public interface IVcsProvider
         RateLimit GetRateLimit();
 
         string GetMilestoneQueryString();
+
+        string GetIssueType(Issue issue);
     }
 }
diff --git a/src/GitReleaseManager.Core/Templates/default/issue-note.sbn b/src/GitReleaseManager.Core/Templates/default/issue-note.sbn
@@ -1 +1,6 @@
-- [__#{{ issue.public_number }}__]({{ issue.html_url }}) {{ issue.title }}
+{{
+    if issue.is_pull_request
+}}- [__!{{ issue.public_number }}__]({{ issue.html_url }}) {{ issue.title }}
+{{  else
+}}- [__#{{ issue.public_number }}__]({{ issue.html_url }}) {{ issue.title }}
+{{  end -}}
diff --git a/src/GitReleaseManager.Core/VcsService.cs b/src/GitReleaseManager.Core/VcsService.cs
@@ -383,14 +383,15 @@ private async Task AddIssueCommentsAsync(string owner, string repository, Milest
 
                 try
                 {
+                    var issueType = _vcsProvider.GetIssueType(issue);
                     if (!await CommentsIncludeStringAsync(owner, repository, issue, detectionComment).ConfigureAwait(false))
                     {
-                        _logger.Information("Adding release comment for issue #{IssueNumber}", issue.Number);
+                        _logger.Information("Adding release comment for {IssueType} #{IssueNumber}", issueType, issue.PublicNumber);
                         await _vcsProvider.CreateIssueCommentAsync(owner, repository, issue, issueComment).ConfigureAwait(false);
                     }
                     else
                     {
-                        _logger.Information("Issue #{IssueNumber} already contains release comment, skipping...", issue.Number);
+                        _logger.Information("{IssueType} #{IssueNumber} already contains release comment, skipping...", issueType, issue.PublicNumber);
                     }
                 }
                 catch (ForbiddenException)