From b93b163728226d7a8e39abfe34f72ff436eccca9 Mon Sep 17 00:00:00 2001
From: jericho <desautelsj@hotmail.com>
Date: Thu, 2 Nov 2023 12:18:01 -0400
Subject: [PATCH 1/2] =?UTF-8?q?=EF=BB=BF(#89)=20Include=20contributors=20i?=
 =?UTF-8?q?n=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This commit adds the ability to query for, and add, information about
the contributors for linked issues and PR's into the generated release
notes.

This is made possible via a new `include-contributors` option in the
create section of the GitReleaseManager.yaml file.  This is false by
default.

In addition, a new scriban template has been created, so allow complete
segregation between release notes that have contributors, and those that
don't. This was done mainly to allow better maintainability going
forward, and to reduce the complexity of the default template.

This has been implemented for both GitHug and GitLab.  For GitHub, it
was necessary to use GraphQL to get the necessary information, where as
with GitLab, the required information could be returned via the REST API.
---
 src/Directory.Packages.props                  |   2 +
 src/GitReleaseManager.Cli/Program.cs          |   8 ++
 .../Configuration/Config.cs                   |   1 +
 .../Configuration/CreateConfig.cs             |   3 +
 .../Extensions/JsonExtensions.cs              |  84 +++++++++++++
 .../GitReleaseManager.Core.csproj             |   2 +
 .../MappingProfiles/GitHubProfile.cs          |  28 ++++-
 src/GitReleaseManager.Core/Model/Issue.cs     |   4 +
 .../Model/IssueComment.cs                     |   5 +
 src/GitReleaseManager.Core/Model/User.cs      |  11 ++
 .../Provider/GitHubProvider.cs                | 114 ++++++++++++++++++
 .../Provider/GitLabProvider.cs                |  19 +++
 .../Provider/IVcsProvider.cs                  |   4 +-
 .../ReleaseNotes/ReleaseNotesBuilder.cs       |  39 ++++++
 .../contributors/contributor-details.sbn      |   1 +
 .../Templates/contributors/contributors.sbn   |   9 ++
 .../Templates/contributors/create/footer.sbn  |  10 ++
 .../Templates/contributors/index.sbn          |  13 ++
 .../Templates/contributors/issue-details.sbn  |   5 +
 .../Templates/contributors/issue-note.sbn     |  45 +++++++
 .../Templates/contributors/issues.sbn         |   3 +
 .../Templates/contributors/milestone.sbn      |   2 +
 .../Templates/contributors/release-info.sbn   |  10 ++
 src/GitReleaseManager.Core/VcsService.cs      |   4 +-
 .../GitHubProviderIntegrationTests.cs         |  41 ++++++-
 .../ReleaseNotesBuilderIntegrationTests.cs    |  42 +++++--
 26 files changed, 496 insertions(+), 13 deletions(-)
 create mode 100644 src/GitReleaseManager.Core/Extensions/JsonExtensions.cs
 create mode 100644 src/GitReleaseManager.Core/Model/User.cs
 create mode 100644 src/GitReleaseManager.Core/Templates/contributors/contributor-details.sbn
 create mode 100644 src/GitReleaseManager.Core/Templates/contributors/contributors.sbn
 create mode 100644 src/GitReleaseManager.Core/Templates/contributors/create/footer.sbn
 create mode 100644 src/GitReleaseManager.Core/Templates/contributors/index.sbn
 create mode 100644 src/GitReleaseManager.Core/Templates/contributors/issue-details.sbn
 create mode 100644 src/GitReleaseManager.Core/Templates/contributors/issue-note.sbn
 create mode 100644 src/GitReleaseManager.Core/Templates/contributors/issues.sbn
 create mode 100644 src/GitReleaseManager.Core/Templates/contributors/milestone.sbn
 create mode 100644 src/GitReleaseManager.Core/Templates/contributors/release-info.sbn

diff --git a/src/Directory.Packages.props b/src/Directory.Packages.props
index ae2c6696..82a68959 100644
--- a/src/Directory.Packages.props
+++ b/src/Directory.Packages.props
@@ -10,6 +10,8 @@
     <PackageVersion Include="CommandLineParser" Version="2.9.1" />
     <PackageVersion Include="coverlet.msbuild" Version="6.0.4" />
     <PackageVersion Include="Destructurama.Attributed" Version="5.1.0" />
+    <PackageVersion Include="GraphQL.Client" Version="6.0.1" />
+    <PackageVersion Include="GraphQL.Client.Serializer.SystemTextJson" Version="6.0.1" />
     <PackageVersion Include="IDisposableAnalyzers" Version="4.0.8" />
     <PackageVersion Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="9.0.0" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="9.0.2" />
diff --git a/src/GitReleaseManager.Cli/Program.cs b/src/GitReleaseManager.Cli/Program.cs
index dc44e89c..96280e1c 100644
--- a/src/GitReleaseManager.Cli/Program.cs
+++ b/src/GitReleaseManager.Cli/Program.cs
@@ -13,6 +13,8 @@
 using GitReleaseManager.Core.Provider;
 using GitReleaseManager.Core.ReleaseNotes;
 using GitReleaseManager.Core.Templates;
+using GraphQL.Client.Http;
+using GraphQL.Client.Serializer.SystemTextJson;
 using Microsoft.Extensions.DependencyInjection;
 using NGitLab;
 using Octokit;
@@ -211,6 +213,12 @@ private static void RegisterVcsProvider(BaseVcsOptions vcsOptions, IServiceColle
                 // default to Github
                 serviceCollection
                     .AddSingleton<IGitHubClient>((_) => new GitHubClient(new ProductHeaderValue("GitReleaseManager")) { Credentials = new Credentials(vcsOptions.Token) })
+                    .AddSingleton<GraphQL.Client.Abstractions.IGraphQLClient>(_ =>
+                    {
+                        var client = new GraphQLHttpClient(new GraphQLHttpClientOptions { EndPoint = new Uri("https://api.github.com/graphql") }, new SystemTextJsonSerializer());
+                        client.HttpClient.DefaultRequestHeaders.Add("Authorization", $"bearer {vcsOptions.Token}");
+                        return client;
+                    })
                     .AddSingleton<IVcsProvider, GitHubProvider>();
             }
         }
diff --git a/src/GitReleaseManager.Core/Configuration/Config.cs b/src/GitReleaseManager.Core/Configuration/Config.cs
index 149e7fe6..262c12bc 100644
--- a/src/GitReleaseManager.Core/Configuration/Config.cs
+++ b/src/GitReleaseManager.Core/Configuration/Config.cs
@@ -27,6 +27,7 @@ public Config()
                 ShaSectionHeading = "SHA256 Hashes of the release artifacts",
                 ShaSectionLineFormat = "- `{1}\t{0}`",
                 AllowUpdateToPublishedRelease = false,
+                IncludeContributors = false,
             };
 
             Export = new ExportConfig
diff --git a/src/GitReleaseManager.Core/Configuration/CreateConfig.cs b/src/GitReleaseManager.Core/Configuration/CreateConfig.cs
index 512e4a28..00baed7d 100644
--- a/src/GitReleaseManager.Core/Configuration/CreateConfig.cs
+++ b/src/GitReleaseManager.Core/Configuration/CreateConfig.cs
@@ -34,5 +34,8 @@ public class CreateConfig
 
         [YamlMember(Alias = "allow-update-to-published")]
         public bool AllowUpdateToPublishedRelease { get; set; }
+
+        [YamlMember(Alias = "include-contributors")]
+        public bool IncludeContributors { get; set; }
     }
 }
\ No newline at end of file
diff --git a/src/GitReleaseManager.Core/Extensions/JsonExtensions.cs b/src/GitReleaseManager.Core/Extensions/JsonExtensions.cs
new file mode 100644
index 00000000..d8920c65
--- /dev/null
+++ b/src/GitReleaseManager.Core/Extensions/JsonExtensions.cs
@@ -0,0 +1,84 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text.Json;
+
+namespace GitReleaseManager.Core.Extensions
+{
+    internal static class JsonExtensions
+    {
+        /// <summary>
+        /// Get a JsonElement from a path. Each level in the path is seperated by a dot.
+        /// </summary>
+        /// <param name="jsonElement">The parent Json element.</param>
+        /// <param name="path">The path of the desired child element.</param>
+        /// <returns>The child element.</returns>
+        public static JsonElement GetJsonElement(this JsonElement jsonElement, string path)
+        {
+            if (jsonElement.ValueKind is JsonValueKind.Null || jsonElement.ValueKind is JsonValueKind.Undefined)
+            {
+                return default(JsonElement);
+            }
+
+            string[] segments = path.Split(new[] { '.' }, StringSplitOptions.RemoveEmptyEntries);
+
+            foreach (var segment in segments)
+            {
+                if (int.TryParse(segment, out var index) && jsonElement.ValueKind == JsonValueKind.Array)
+                {
+                    jsonElement = jsonElement.EnumerateArray().ElementAtOrDefault(index);
+                    if (jsonElement.ValueKind is JsonValueKind.Null || jsonElement.ValueKind is JsonValueKind.Undefined)
+                    {
+                        return default(JsonElement);
+                    }
+
+                    continue;
+                }
+
+                jsonElement = jsonElement.TryGetProperty(segment, out var value) ? value : default;
+
+                if (jsonElement.ValueKind is JsonValueKind.Null || jsonElement.ValueKind is JsonValueKind.Undefined)
+                {
+                    return default(JsonElement);
+                }
+            }
+
+            return jsonElement;
+        }
+
+        /// <summary>
+        /// Get the first JsonElement matching a path from the provided list of paths.
+        /// </summary>
+        /// <param name="jsonElement">The parent Json element.</param>
+        /// <param name="paths">The path of the desired child element.</param>
+        /// <returns>The child element.</returns>
+        public static JsonElement GetFirstJsonElement(this JsonElement jsonElement, IEnumerable<string> paths)
+        {
+            if (jsonElement.ValueKind is JsonValueKind.Null || jsonElement.ValueKind is JsonValueKind.Undefined)
+            {
+                return default(JsonElement);
+            }
+
+            var element = default(JsonElement);
+
+            foreach (var path in paths)
+            {
+                element = jsonElement.GetJsonElement(path);
+
+                if (element.ValueKind is JsonValueKind.Null || element.ValueKind is JsonValueKind.Undefined)
+                {
+                    continue;
+                }
+
+                break;
+            }
+
+            return element;
+        }
+
+        public static string GetJsonElementValue(this JsonElement jsonElement) => jsonElement.ValueKind != JsonValueKind.Null &&
+                                                                                   jsonElement.ValueKind != JsonValueKind.Undefined
+            ? jsonElement.ToString()
+            : default;
+    }
+}
diff --git a/src/GitReleaseManager.Core/GitReleaseManager.Core.csproj b/src/GitReleaseManager.Core/GitReleaseManager.Core.csproj
index 350a0959..7e614e0c 100644
--- a/src/GitReleaseManager.Core/GitReleaseManager.Core.csproj
+++ b/src/GitReleaseManager.Core/GitReleaseManager.Core.csproj
@@ -19,6 +19,8 @@
     <ItemGroup>
         <PackageReference Include="CommandLineParser" />
         <PackageReference Include="Destructurama.Attributed" />
+        <PackageReference Include="GraphQL.Client" />
+        <PackageReference Include="GraphQL.Client.Serializer.SystemTextJson" />
         <PackageReference Include="Microsoft.SourceLink.GitHub">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
diff --git a/src/GitReleaseManager.Core/MappingProfiles/GitHubProfile.cs b/src/GitReleaseManager.Core/MappingProfiles/GitHubProfile.cs
index dff999dc..11e90526 100644
--- a/src/GitReleaseManager.Core/MappingProfiles/GitHubProfile.cs
+++ b/src/GitReleaseManager.Core/MappingProfiles/GitHubProfile.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Text.Json;
 using AutoMapper;
 using GitReleaseManager.Core.Extensions;
 
@@ -8,10 +9,11 @@ public class GitHubProfile : Profile
     {
         public GitHubProfile()
         {
+            // These mappings convert the result of Octokit queries to model classes
             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.IndexOf("/pull/", StringComparison.OrdinalIgnoreCase) >= 0))
+                .ForMember(dest => dest.IsPullRequest, act => act.MapFrom(src => src.HtmlUrl.Contains("/pull/", StringComparison.OrdinalIgnoreCase)))
                 .ReverseMap();
             CreateMap<Model.IssueComment, Octokit.IssueComment>().ReverseMap();
             CreateMap<Model.ItemState, Octokit.ItemState>().ReverseMap();
@@ -23,11 +25,35 @@ public GitHubProfile()
             CreateMap<Model.ReleaseAssetUpload, Octokit.ReleaseAssetUpload>().ReverseMap();
             CreateMap<Model.Label, Octokit.Label>().ReverseMap();
             CreateMap<Model.Label, Octokit.NewLabel>().ReverseMap();
+            CreateMap<Model.User, Octokit.User>().ReverseMap();
             CreateMap<Model.Milestone, Octokit.Milestone>();
             CreateMap<Octokit.Milestone, Model.Milestone>()
                 .ForMember(dest => dest.PublicNumber, act => act.MapFrom(src => src.Number))
                 .ForMember(dest => dest.InternalNumber, act => act.MapFrom(src => src.Number))
                 .AfterMap((src, dest) => dest.Version = src.Version());
+
+            // These mappings convert the result of GraphQL queries to model classes
+            CreateMap<JsonElement, Model.Issue>()
+                .ForMember(dest => dest.PublicNumber, act => act.MapFrom(src => src.GetProperty("number").GetInt32()))
+                .ForMember(dest => dest.InternalNumber, act => act.MapFrom(src => -1)) // Not available in graphQL (there's a "id" property but it contains a string which represents the Node ID of the object).
+                .ForMember(dest => dest.Title, act => act.MapFrom(src => src.GetProperty("title").GetString()))
+                .ForMember(dest => dest.HtmlUrl, act => act.MapFrom(src => src.GetProperty("url").GetString()))
+                .ForMember(dest => dest.IsPullRequest, act => act.MapFrom(src => src.GetProperty("url").GetString().Contains("/pull/", StringComparison.OrdinalIgnoreCase)))
+                .ForMember(dest => dest.User, act => act.MapFrom(src => src.GetProperty("author")))
+                .ForMember(dest => dest.Labels, act => act.MapFrom(src => src.GetJsonElement("labels.nodes").EnumerateArray()))
+                .ReverseMap();
+
+            CreateMap<JsonElement, Model.Label>()
+                .ForMember(dest => dest.Name, act => act.MapFrom(src => src.GetProperty("name").GetString()))
+                .ForMember(dest => dest.Color, act => act.MapFrom(src => src.GetProperty("color").GetString()))
+                .ForMember(dest => dest.Description, act => act.MapFrom(src => src.GetProperty("description").GetString()))
+                .ReverseMap();
+
+            CreateMap<JsonElement, Model.User>()
+                .ForMember(dest => dest.Login, act => act.MapFrom(src => src.GetProperty("login").GetString()))
+                .ForMember(dest => dest.HtmlUrl, act => act.MapFrom(src => $"https://github.com{src.GetProperty("resourcePath").GetString()}")) // The resourcePath contains a value similar to "/jericho". That's why we must manually prepend "https://github.com
+                .ForMember(dest => dest.AvatarUrl, act => act.MapFrom(src => src.GetProperty("avatarUrl").GetString()))
+                .ReverseMap();
         }
     }
 }
\ No newline at end of file
diff --git a/src/GitReleaseManager.Core/Model/Issue.cs b/src/GitReleaseManager.Core/Model/Issue.cs
index 222d8eb9..5ad73c7c 100644
--- a/src/GitReleaseManager.Core/Model/Issue.cs
+++ b/src/GitReleaseManager.Core/Model/Issue.cs
@@ -15,5 +15,9 @@ public sealed class Issue
         public IReadOnlyList<Label> Labels { get; set; }
 
         public bool IsPullRequest { get; set; }
+
+        public User User { get; set; }
+
+        public IReadOnlyList<Issue> LinkedIssues { get; set; }
     }
 }
\ No newline at end of file
diff --git a/src/GitReleaseManager.Core/Model/IssueComment.cs b/src/GitReleaseManager.Core/Model/IssueComment.cs
index a1596a34..d2e5c944 100644
--- a/src/GitReleaseManager.Core/Model/IssueComment.cs
+++ b/src/GitReleaseManager.Core/Model/IssueComment.cs
@@ -11,5 +11,10 @@ public class IssueComment
         /// Gets or sets details about the issue comment.
         /// </summary>
         public string Body { get; set; }
+
+        /// <summary>
+        /// Gets or sets information about the user who made the comment.
+        /// </summary>
+        public User User { get; set; }
     }
 }
\ No newline at end of file
diff --git a/src/GitReleaseManager.Core/Model/User.cs b/src/GitReleaseManager.Core/Model/User.cs
new file mode 100644
index 00000000..c880942c
--- /dev/null
+++ b/src/GitReleaseManager.Core/Model/User.cs
@@ -0,0 +1,11 @@
+namespace GitReleaseManager.Core.Model
+{
+    public sealed class User
+    {
+        public string Login { get; set; }
+
+        public string HtmlUrl { get; set; }
+
+        public string AvatarUrl { get; set; }
+    }
+}
\ No newline at end of file
diff --git a/src/GitReleaseManager.Core/Provider/GitHubProvider.cs b/src/GitReleaseManager.Core/Provider/GitHubProvider.cs
index 81a0d3d3..07bbfbef 100644
--- a/src/GitReleaseManager.Core/Provider/GitHubProvider.cs
+++ b/src/GitReleaseManager.Core/Provider/GitHubProvider.cs
@@ -2,8 +2,12 @@
 using System.Collections.Generic;
 using System.Globalization;
 using System.Linq;
+using System.Text.Json;
 using System.Threading.Tasks;
 using AutoMapper;
+using GitReleaseManager.Core.Extensions;
+using GraphQL.Client.Abstractions;
+using GraphQL.Client.Http;
 using Octokit;
 using ApiException = GitReleaseManager.Core.Exceptions.ApiException;
 using ForbiddenException = GitReleaseManager.Core.Exceptions.ForbiddenException;
@@ -26,8 +30,79 @@ public class GitHubProvider : IVcsProvider
         private const int PAGE_SIZE = 100;
         private const string NOT_FOUND_MESSGAE = "NotFound";
 
+        // This query fragment will be executed for issues and pull requests
+        // because we don't know whether issueNumber refers to an issue or a PR
+        private const string CLOSING_ISSUES_AND_PULLREQUESTS_GRAPHQL_QUERY = @"
+        query ClosingIssuesAndPullRequests($repoName: String!, $repoOwner: String!, $issueNumber: Int!, $pageSize: Int!) {
+	        repository(name: $repoName, owner: $repoOwner) {
+                issue(number: $issueNumber) {
+                    title
+                    id
+                    number
+                    url
+                    labels(first: 100) {
+                        nodes {
+                            name
+                            color
+                            description
+                        }
+                    }
+                    author {
+                        login
+                        avatarUrl
+                        resourcePath
+                    }
+                    closedByPullRequestsReferences(userLinkedOnly: false, includeClosedPrs: true, first: $pageSize) {
+                        nodes {
+                            title
+                            id
+                            number
+                            url
+                            labels(first: 100) {
+                                nodes {
+                                    name
+                                    color
+                                    description
+                                }
+                            }
+                            author {
+                                login
+                                avatarUrl
+                                resourcePath
+                            }
+                        }
+                    }
+                }
+                pullRequest(number: $issueNumber) {
+                    number
+                    title
+                    closingIssuesReferences(userLinkedOnly: false, first: $pageSize) {
+                        nodes {
+                            title
+                            id
+                            number
+                            url
+                            labels(first: 100) {
+                                nodes {
+                                    name
+                                    color
+                                    description
+                                }
+                            }
+                            author {
+                                login
+                                avatarUrl
+                                resourcePath
+                            }
+                        }
+                    }
+                }
+    	    }
+        }";
+
         private readonly IGitHubClient _gitHubClient;
         private readonly IMapper _mapper;
+        private readonly IGraphQLClient _graphQLClient;
 
         public GitHubProvider(IGitHubClient gitHubClient, IMapper mapper)
         {
@@ -35,6 +110,12 @@ public GitHubProvider(IGitHubClient gitHubClient, IMapper mapper)
             _mapper = mapper;
         }
 
+        public GitHubProvider(IGitHubClient gitHubClient, IMapper mapper, IGraphQLClient graphQLClient)
+            : this(gitHubClient, mapper)
+        {
+            _graphQLClient = graphQLClient;
+        }
+
         public Task DeleteAssetAsync(string owner, string repository, ReleaseAsset asset)
         {
             return GitHubProvider.ExecuteAsync(async () =>
@@ -356,6 +437,39 @@ public string GetIssueType(Issue issue)
             return issue.IsPullRequest ? "Pull Request" : "Issue";
         }
 
+        public async Task<Issue[]> GetLinkedIssuesAsync(string owner, string repository, Issue issue)
+        {
+            ArgumentNullException.ThrowIfNull(_graphQLClient, nameof(_graphQLClient));
+            ArgumentNullException.ThrowIfNull(issue, nameof(issue));
+
+            var request = new GraphQLHttpRequest
+            {
+                Query = CLOSING_ISSUES_AND_PULLREQUESTS_GRAPHQL_QUERY.Replace("\r\n", string.Empty, StringComparison.OrdinalIgnoreCase),
+                Variables = new
+                {
+                    pageSize = PAGE_SIZE,
+                    repoName = repository,
+                    repoOwner = owner,
+                    issueNumber = issue.PublicNumber,
+                },
+            };
+
+            var graphQLResponse = await _graphQLClient.SendQueryAsync<dynamic>(request).ConfigureAwait(false);
+
+            var nodes = ((JsonElement)graphQLResponse.Data).GetFirstJsonElement(new[]
+            {
+                "repository.issue.closedByPullRequestsReferences.nodes", // If issue.PublicNumber represents an issue, retrieve the linked PRs
+                "repository.pullRequest.closingIssuesReferences.nodes", // If issue.PublicNumber represents a PR, retrieve the linked issues
+            });
+
+            using var enumerator = nodes.EnumerateArray();
+            var linkedIssues = enumerator
+                .Select(element => _mapper.Map<Issue>(element))
+                .ToArray();
+
+            return linkedIssues;
+        }
+
         private static async Task ExecuteAsync(Func<Task> action)
         {
             try
diff --git a/src/GitReleaseManager.Core/Provider/GitLabProvider.cs b/src/GitReleaseManager.Core/Provider/GitLabProvider.cs
index 2d89b2ec..062bc9e0 100644
--- a/src/GitReleaseManager.Core/Provider/GitLabProvider.cs
+++ b/src/GitReleaseManager.Core/Provider/GitLabProvider.cs
@@ -396,6 +396,25 @@ public string GetIssueType(Issue issue)
             return issue.IsPullRequest ? "Merge Request" : "Issue";
         }
 
+        public Task<Issue[]> GetLinkedIssuesAsync(string owner, string repository, Issue issue)
+        {
+            return ExecuteAsync(() =>
+            {
+                if (issue.IsPullRequest)
+                {
+                    var closes = _gitLabClient.MergeRequests.ClosesIssues(issue.PublicNumber);
+                    var issues = _mapper.Map<IEnumerable<Issue>>(closes);
+                    return Task.FromResult(issues.ToArray());
+                }
+                else
+                {
+                    var relatedTo = _gitLabClient.Issues.RelatedTo(GetGitLabProjectId(owner, repository), issue.PublicNumber);
+                    var issues = _mapper.Map<IEnumerable<Issue>>(relatedTo);
+                    return Task.FromResult(issues.ToArray());
+                }
+            });
+        }
+
         private long GetGitLabProjectId(string owner, string repository)
         {
             if (_projectId.HasValue)
diff --git a/src/GitReleaseManager.Core/Provider/IVcsProvider.cs b/src/GitReleaseManager.Core/Provider/IVcsProvider.cs
index a7bf82a8..ea2523cd 100644
--- a/src/GitReleaseManager.Core/Provider/IVcsProvider.cs
+++ b/src/GitReleaseManager.Core/Provider/IVcsProvider.cs
@@ -16,7 +16,7 @@ public interface IVcsProvider
 
         Task CreateIssueCommentAsync(string owner, string repository, Issue issue, string comment);
 
-        Task<IEnumerable<Issue>> GetIssuesAsync(string owner, string repository, Milestone milstone, ItemStateFilter itemStateFilter = ItemStateFilter.All);
+        Task<IEnumerable<Issue>> GetIssuesAsync(string owner, string repository, Milestone milestone, ItemStateFilter itemStateFilter = ItemStateFilter.All);
 
         Task<IEnumerable<IssueComment>> GetIssueCommentsAsync(string owner, string repository, Issue issue);
 
@@ -49,5 +49,7 @@ public interface IVcsProvider
         string GetMilestoneQueryString();
 
         string GetIssueType(Issue issue);
+
+        Task<Issue[]> GetLinkedIssuesAsync(string owner, string repository, Issue issue);
     }
 }
\ No newline at end of file
diff --git a/src/GitReleaseManager.Core/ReleaseNotes/ReleaseNotesBuilder.cs b/src/GitReleaseManager.Core/ReleaseNotes/ReleaseNotesBuilder.cs
index ec08fec0..163c7dbc 100644
--- a/src/GitReleaseManager.Core/ReleaseNotes/ReleaseNotesBuilder.cs
+++ b/src/GitReleaseManager.Core/ReleaseNotes/ReleaseNotesBuilder.cs
@@ -67,6 +67,26 @@ public async Task<string> BuildReleaseNotesAsync(string user, string repository,
             var commitsLink = _vcsProvider.GetCommitsUrl(_user, _repository, _targetMilestone?.Title, previousMilestone?.Title);
 
             var issuesDict = GetIssuesDict(issues);
+            var distinctValidIssues = issuesDict.SelectMany(kvp => kvp.Value).DistinctBy(i => i.PublicNumber);
+
+            foreach (var issue in distinctValidIssues)
+            {
+                // Linked issues are only necessary for figuring out who contributed to a given issue.
+                // Therefore, we only need to fetch linked issues if IncludeContributors is enabled.
+                if (_configuration.Create.IncludeContributors)
+                {
+                    var linkedIssues = await _vcsProvider.GetLinkedIssuesAsync(_user, _repository, issue).ConfigureAwait(false);
+                    issue.LinkedIssues = Array.AsReadOnly(linkedIssues ?? Array.Empty<Issue>());
+                }
+                else
+                {
+                    issue.LinkedIssues = Array.AsReadOnly(Array.Empty<Issue>());
+                }
+            }
+
+            var contributors = _configuration.Create.IncludeContributors
+                ? GetContributors(distinctValidIssues)
+                : Array.Empty<User>();
 
             var milestoneQueryString = _vcsProvider.GetMilestoneQueryString();
 
@@ -77,6 +97,11 @@ public async Task<string> BuildReleaseNotesAsync(string user, string repository,
                     issues.Count,
                     Items = issuesDict,
                 },
+                Contributors = new
+                {
+                    Count = contributors.Length,
+                    Items = contributors,
+                },
                 Commits = new
                 {
                     Count = numberOfCommits,
@@ -114,6 +139,20 @@ private Dictionary<string, List<Issue>> GetIssuesDict(List<Issue> issues)
             return issuesByLabel;
         }
 
+        private static User[] GetContributors(IEnumerable<Issue> issues)
+        {
+            var contributors = issues.Select(i => i.User);
+            var linkedContributors = issues.SelectMany(i => i.LinkedIssues).Select(i => i.User);
+
+            var allContributors = contributors
+                .Union(linkedContributors)
+                .Where(u => u != null)
+                .DistinctBy(u => u.Login)
+                .ToArray();
+
+            return allContributors;
+        }
+
         private string GetValidLabel(string label, int issuesCount)
         {
             var alias = _configuration.LabelAliases.FirstOrDefault(x => x.Name.Equals(label, StringComparison.OrdinalIgnoreCase));
diff --git a/src/GitReleaseManager.Core/Templates/contributors/contributor-details.sbn b/src/GitReleaseManager.Core/Templates/contributors/contributor-details.sbn
new file mode 100644
index 00000000..bd21d0a8
--- /dev/null
+++ b/src/GitReleaseManager.Core/Templates/contributors/contributor-details.sbn
@@ -0,0 +1 @@
+<a href="{{contributor.html_url}}"><img src="{{contributor.avatar_url}}" alt="{{contributor.login}}" height="32" width="32"/></a> 
\ No newline at end of file
diff --git a/src/GitReleaseManager.Core/Templates/contributors/contributors.sbn b/src/GitReleaseManager.Core/Templates/contributors/contributors.sbn
new file mode 100644
index 00000000..d1238cdb
--- /dev/null
+++ b/src/GitReleaseManager.Core/Templates/contributors/contributors.sbn
@@ -0,0 +1,9 @@
+
+
+__Contributors__
+
+{{ contributors.count }} contributors made this release possible.
+
+{{ for contributor in contributors.items
+    include 'contributor-details'
+end }}
\ No newline at end of file
diff --git a/src/GitReleaseManager.Core/Templates/contributors/create/footer.sbn b/src/GitReleaseManager.Core/Templates/contributors/create/footer.sbn
new file mode 100644
index 00000000..b1b08303
--- /dev/null
+++ b/src/GitReleaseManager.Core/Templates/contributors/create/footer.sbn
@@ -0,0 +1,10 @@
+{{ if config.create.include_footer }}
+
+### {{ config.create.footer_heading }}
+
+{{  if config.create.milestone_replace_text
+        replace_milestone_title config.create.footer_content config.create.milestone_replace_text milestone.target.title
+    else
+        config.create.footer_content
+    end
+end }}
diff --git a/src/GitReleaseManager.Core/Templates/contributors/index.sbn b/src/GitReleaseManager.Core/Templates/contributors/index.sbn
new file mode 100644
index 00000000..fe306967
--- /dev/null
+++ b/src/GitReleaseManager.Core/Templates/contributors/index.sbn
@@ -0,0 +1,13 @@
+{{-
+    include 'release-info'
+    if milestone.target.description
+        include 'milestone'
+    end
+    include 'issues' | string.rstrip
+    if contributors.count > 0
+        include 'contributors'
+    end
+    if template_kind == "CREATE"
+        include 'create/footer'
+    end
+~}}
diff --git a/src/GitReleaseManager.Core/Templates/contributors/issue-details.sbn b/src/GitReleaseManager.Core/Templates/contributors/issue-details.sbn
new file mode 100644
index 00000000..70183381
--- /dev/null
+++ b/src/GitReleaseManager.Core/Templates/contributors/issue-details.sbn
@@ -0,0 +1,5 @@
+
+__{{ issue_label }}__
+{{ for issue in issues.items[issue_label]
+    include 'issue-note'
+end }}
diff --git a/src/GitReleaseManager.Core/Templates/contributors/issue-note.sbn b/src/GitReleaseManager.Core/Templates/contributors/issue-note.sbn
new file mode 100644
index 00000000..ac7a11a1
--- /dev/null
+++ b/src/GitReleaseManager.Core/Templates/contributors/issue-note.sbn
@@ -0,0 +1,45 @@
+{{
+func IssueDescription
+    if $0.is_pull_request
+        $description = "[__!" + $0.public_number + "__]"
+    else
+        $description = "[__#" + $0.public_number + "__]"
+    end
+    $description = $description + "(" + $0.html_url + ")"
+    if $1
+        $description = $description + " " + $0.title
+    end
+    if $0.user
+        $description = $description + " by [" + $0.user.login + "](" + $0.user.html_url + ")"
+    end
+    if $0.linked_issues
+        $description = $description + LinkedIssuesDescription($0.linked_issues)
+    end
+    ret $description
+end
+func LinkedIssuesDescription
+    $countPRs = 0
+    $countIssues = 0
+    for linkedIssue in $0
+        if linkedIssue.is_pull_request
+            if $countPRs == 0
+                $resolvedBy = " resolved in "
+            else
+                $resolvedBy = $resolvedBy + ", "
+            end
+            $resolvedBy = $resolvedBy + IssueDescription(linkedIssue, false)
+            $countPRs = $countPRs + 1
+        else
+            if $countIssues == 0
+                $raisedIn = " raised in "
+            else
+                $raisedIn = $raisedIn + ", "
+            end
+            $raisedIn = $raisedIn + IssueDescription(linkedIssue, false)
+            $countIssues = $countIssues + 1
+        end
+    end
+    ret $raisedIn + $resolvedBy
+end
+}}
+- {{ IssueDescription(issue, true) }}
\ No newline at end of file
diff --git a/src/GitReleaseManager.Core/Templates/contributors/issues.sbn b/src/GitReleaseManager.Core/Templates/contributors/issues.sbn
new file mode 100644
index 00000000..d8f323f4
--- /dev/null
+++ b/src/GitReleaseManager.Core/Templates/contributors/issues.sbn
@@ -0,0 +1,3 @@
+{{ for issue_label in issue_labels
+    include 'issue-details'
+end }}
\ No newline at end of file
diff --git a/src/GitReleaseManager.Core/Templates/contributors/milestone.sbn b/src/GitReleaseManager.Core/Templates/contributors/milestone.sbn
new file mode 100644
index 00000000..b3459681
--- /dev/null
+++ b/src/GitReleaseManager.Core/Templates/contributors/milestone.sbn
@@ -0,0 +1,2 @@
+
+{{ milestone.target.description }}
diff --git a/src/GitReleaseManager.Core/Templates/contributors/release-info.sbn b/src/GitReleaseManager.Core/Templates/contributors/release-info.sbn
new file mode 100644
index 00000000..c8f7e8e2
--- /dev/null
+++ b/src/GitReleaseManager.Core/Templates/contributors/release-info.sbn
@@ -0,0 +1,10 @@
+{{
+    if issues.count > 0
+        if commits.count > 0
+}}As part of this release we had [{{ commits.count }} {{ commits.count | string.pluralize "commit" "commits" }}]({{ commits.html_url }}) which resulted in [{{ issues.count }} {{ issues.count | string.pluralize "issue" "issues" }}]({{ milestone.target.html_url }}?{{ milestone.query_string }}) being closed.
+{{      else
+}}As part of this release we had [{{ issues.count }} {{ issues.count | string.pluralize "issue" "issues" }}]({{ milestone.target.html_url }}?{{ milestone.query_string }}) closed.
+{{      end
+    else if commits.count > 0
+}}As part of this release we had [{{ commits.count }} {{ commits.count | string.pluralize "commit" "commits" }}]({{ commits.html_url }}).
+{{  end -}}
diff --git a/src/GitReleaseManager.Core/VcsService.cs b/src/GitReleaseManager.Core/VcsService.cs
index d70f750d..d86e1990 100644
--- a/src/GitReleaseManager.Core/VcsService.cs
+++ b/src/GitReleaseManager.Core/VcsService.cs
@@ -46,7 +46,9 @@ public async Task<Release> CreateEmptyReleaseAsync(string owner, string reposito
 
         public async Task<Release> CreateReleaseFromMilestoneAsync(string owner, string repository, string milestone, string releaseName, string targetCommitish, IList<string> assets, bool prerelease, string templateFilePath)
         {
-            var templatePath = ReleaseTemplates.DEFAULT_NAME;
+            var templatePath = _configuration.Create.IncludeContributors
+                ? ReleaseTemplates.CONTRIBUTORS_NAME
+                : ReleaseTemplates.DEFAULT_NAME;
 
             if (!string.IsNullOrWhiteSpace(templateFilePath))
             {
diff --git a/src/GitReleaseManager.IntegrationTests/GitHubProviderIntegrationTests.cs b/src/GitReleaseManager.IntegrationTests/GitHubProviderIntegrationTests.cs
index 9c7483ad..8fa9691f 100644
--- a/src/GitReleaseManager.IntegrationTests/GitHubProviderIntegrationTests.cs
+++ b/src/GitReleaseManager.IntegrationTests/GitHubProviderIntegrationTests.cs
@@ -4,6 +4,9 @@
 using AutoMapper;
 using GitReleaseManager.Core;
 using GitReleaseManager.Core.Provider;
+using GraphQL.Client.Abstractions;
+using GraphQL.Client.Http;
+using GraphQL.Client.Serializer.SystemTextJson;
 using NUnit.Framework;
 using Octokit;
 using Shouldly;
@@ -22,6 +25,7 @@ public class GitHubProviderIntegrationTests
 
         private GitHubProvider _gitHubProvider;
         private IGitHubClient _gitHubClient;
+        private IGraphQLClient _graphQlClient;
         private IMapper _mapper;
 
         private string _token;
@@ -40,9 +44,18 @@ public void OneTimeSetUp()
                 Assert.Inconclusive("Unable to locate credentials for accessing GitHub API");
             }
 
+            _graphQlClient = new GraphQLHttpClient(new GraphQLHttpClientOptions { EndPoint = new Uri("https://api.github.com/graphql") }, new SystemTextJsonSerializer());
+            ((GraphQLHttpClient)_graphQlClient).HttpClient.DefaultRequestHeaders.Add("Authorization", $"bearer {_token}");
+
             _mapper = AutoMapperConfiguration.Configure();
             _gitHubClient = new GitHubClient(new ProductHeaderValue("GitReleaseManager")) { Credentials = new Credentials(_token) };
-            _gitHubProvider = new GitHubProvider(_gitHubClient, _mapper);
+            _gitHubProvider = new GitHubProvider(_gitHubClient, _mapper, _graphQlClient);
+        }
+
+        [OneTimeTearDown]
+        public void OneTimeTearDown()
+        {
+            ((IDisposable)_graphQlClient)?.Dispose();
         }
 
         [Test]
@@ -101,5 +114,31 @@ public async Task Should_Get_Commits_Count()
             var result = await _gitHubProvider.GetCommitsCountAsync(OWNER, REPOSITORY, _releaseBaseTag, _releaseHeadTag).ConfigureAwait(false);
             result.ShouldBeGreaterThan(0);
         }
+
+        [Test]
+        public async Task GetLinkedIssues()
+        {
+            // Assert that issue 113 in the GitTools/GitReleaseManager repo is linked to pull request 369
+            var result0 = await _gitHubProvider.GetLinkedIssuesAsync("GitTools", "GitReleaseManager", new Issue() { PublicNumber = 113 }).ConfigureAwait(false);
+            Assert.That(result0, Is.Not.Null);
+            Assert.That(result0.Length, Is.EqualTo(1));
+            Assert.That(result0.Count(r => r.PublicNumber == 369), Is.EqualTo(1));
+
+            // Assert that pull request 43 in the jericho/_testing repo is linked to issues 42, 107 and 108
+            var result1 = await _gitHubProvider.GetLinkedIssuesAsync("jericho", "_testing", new Issue() { PublicNumber = 43 }).ConfigureAwait(false);
+            Assert.That(result1, Is.Not.Null);
+            Assert.That(result1.Length, Is.EqualTo(3));
+            Assert.That(result1.Count(r => r.PublicNumber == 42), Is.EqualTo(1));
+            Assert.That(result1.Count(r => r.PublicNumber == 107), Is.EqualTo(1));
+            Assert.That(result1.Count(r => r.PublicNumber == 108), Is.EqualTo(1));
+
+            // Assert that issue 108 in the jericho/_testing repo is linked to pull request 7, 43 and 109
+            var result2 = await _gitHubProvider.GetLinkedIssuesAsync("jericho", "_testing", new Issue() { PublicNumber = 108 }).ConfigureAwait(false);
+            Assert.That(result2, Is.Not.Null);
+            Assert.That(result2.Length, Is.EqualTo(3));
+            Assert.That(result2.Count(r => r.PublicNumber == 7), Is.EqualTo(1));
+            Assert.That(result2.Count(r => r.PublicNumber == 43), Is.EqualTo(1));
+            Assert.That(result2.Count(r => r.PublicNumber == 109), Is.EqualTo(1));
+        }
     }
 }
\ No newline at end of file
diff --git a/src/GitReleaseManager.IntegrationTests/ReleaseNotesBuilderIntegrationTests.cs b/src/GitReleaseManager.IntegrationTests/ReleaseNotesBuilderIntegrationTests.cs
index 9defd7f7..296c81f8 100644
--- a/src/GitReleaseManager.IntegrationTests/ReleaseNotesBuilderIntegrationTests.cs
+++ b/src/GitReleaseManager.IntegrationTests/ReleaseNotesBuilderIntegrationTests.cs
@@ -9,6 +9,9 @@
 using GitReleaseManager.Core.Provider;
 using GitReleaseManager.Core.ReleaseNotes;
 using GitReleaseManager.Core.Templates;
+using GraphQL.Client.Abstractions;
+using GraphQL.Client.Http;
+using GraphQL.Client.Serializer.SystemTextJson;
 using NUnit.Framework;
 using Octokit;
 using Serilog;
@@ -20,6 +23,7 @@ namespace GitReleaseManager.IntegrationTests
     public class ReleaseNotesBuilderIntegrationTests
     {
         private IGitHubClient _gitHubClient;
+        private IGraphQLClient _graphQlClient;
 #pragma warning disable NUnit1032 // An IDisposable field/property should be Disposed in a TearDown method
         private ILogger _logger;
 #pragma warning restore NUnit1032 // An IDisposable field/property should be Disposed in a TearDown method
@@ -42,6 +46,8 @@ public void Configure()
             }
 
             _gitHubClient = new GitHubClient(new ProductHeaderValue("GitReleaseManager")) { Credentials = new Credentials(_token) };
+            _graphQlClient = new GraphQLHttpClient(new GraphQLHttpClientOptions { EndPoint = new Uri("https://api.github.com/graphql") }, new SystemTextJsonSerializer());
+            ((GraphQLHttpClient)_graphQlClient).HttpClient.DefaultRequestHeaders.Add("Authorization", $"bearer {_token}");
         }
 
         [OneTimeTearDown]
@@ -49,21 +55,39 @@ public void TearDown()
         {
             Log.CloseAndFlush();
             (_logger as IDisposable)?.Dispose();
+            ((IDisposable)_graphQlClient)?.Dispose();
         }
 
         [Test]
         [Explicit]
         public async Task SingleMilestone()
         {
-            var fileSystem = new FileSystem(new CreateSubOptions());
-            var currentDirectory = Environment.CurrentDirectory;
-            var configuration = ConfigurationProvider.Provide(currentDirectory, fileSystem);
+            if (string.IsNullOrWhiteSpace(_token))
+            {
+                Assert.Inconclusive("Unable to locate credentials for accessing GitHub API");
+            }
+            else
+            {
+                var fileSystem = new FileSystem(new CreateSubOptions());
+                var currentDirectory = Environment.CurrentDirectory;
 
-            var vcsProvider = new GitHubProvider(_gitHubClient, _mapper);
-            var releaseNotesBuilder = new ReleaseNotesBuilder(vcsProvider, _logger, fileSystem, configuration, new TemplateFactory(fileSystem, configuration, TemplateKind.Create));
-            var result = await releaseNotesBuilder.BuildReleaseNotesAsync("Chocolatey", "ChocolateyGUI", "0.12.4", ReleaseTemplates.DEFAULT_NAME).ConfigureAwait(false);
-            Debug.WriteLine(result);
-            ClipBoardHelper.SetClipboard(result);
+                var configuration = ConfigurationProvider.Provide(currentDirectory, fileSystem);
+                configuration.IssueLabelsExclude.Add("Internal Refactoring"); // This is necessary to generate the release notes for GitReleaseManager version 0.12.0
+
+                // Indicate whether you want to include the 'Contributors' section in the release notes
+                configuration.Create.IncludeContributors = true;
+
+                // Pick the template based on whether you want to include the 'Contributors' section in the release notes
+                var templatePath = configuration.Create.IncludeContributors
+                    ? ReleaseTemplates.CONTRIBUTORS_NAME
+                    : ReleaseTemplates.DEFAULT_NAME;
+
+                var vcsProvider = new GitHubProvider(_gitHubClient, _mapper, _graphQlClient);
+                var releaseNotesBuilder = new ReleaseNotesBuilder(vcsProvider, _logger, fileSystem, configuration, new TemplateFactory(fileSystem, configuration, TemplateKind.Create));
+                var result = await releaseNotesBuilder.BuildReleaseNotesAsync("GitTools", "GitReleaseManager", "0.12.0", templatePath).ConfigureAwait(false); // 0.12.0 contains a mix of issues and PRs
+                Debug.WriteLine(result);
+                ClipBoardHelper.SetClipboard(result);
+            }
         }
 
         [Test]
@@ -74,7 +98,7 @@ public async Task SingleMilestone3()
             var currentDirectory = Environment.CurrentDirectory;
             var configuration = ConfigurationProvider.Provide(currentDirectory, fileSystem);
 
-            var vcsProvider = new GitHubProvider(_gitHubClient, _mapper);
+            var vcsProvider = new GitHubProvider(_gitHubClient, _mapper, _graphQlClient);
             var releaseNotesBuilder = new ReleaseNotesBuilder(vcsProvider, _logger, fileSystem, configuration, new TemplateFactory(fileSystem, configuration, TemplateKind.Create));
             var result = await releaseNotesBuilder.BuildReleaseNotesAsync("Chocolatey", "ChocolateyGUI", "0.13.0", ReleaseTemplates.DEFAULT_NAME).ConfigureAwait(false);
             Debug.WriteLine(result);

From c1cb26d2b0636ce97ffbc0a65e1fcbcac2647b96 Mon Sep 17 00:00:00 2001
From: Gary Ewan Park <gep13@gep13.co.uk>
Date: Thu, 20 Feb 2025 14:55:34 +0000
Subject: [PATCH 2/2] (#89) Add required mappings for GitLab models

During testing, it was found that release notes containing contributors
could not be created, since there was an exception thrown when trying
to map models.  Digging into the problem, there were some missing
mappings, and also some required translations between properties with
different names.

Once these addition mappings were in place, it was possible to create
release notes, with contributors, in both GitHub and GitLab.
---
 .../MappingProfiles/GitLabProfile.cs                 | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/GitReleaseManager.Core/MappingProfiles/GitLabProfile.cs b/src/GitReleaseManager.Core/MappingProfiles/GitLabProfile.cs
index e8d3aad4..0fad81b0 100644
--- a/src/GitReleaseManager.Core/MappingProfiles/GitLabProfile.cs
+++ b/src/GitReleaseManager.Core/MappingProfiles/GitLabProfile.cs
@@ -23,12 +23,14 @@ public GitLabProfile()
                 .ForMember(dest => dest.PublicNumber, act => act.MapFrom(src => src.IssueId))
                 .ForMember(dest => dest.HtmlUrl, act => act.MapFrom(src => src.WebUrl))
                 .ForMember(dest => dest.IsPullRequest, act => act.MapFrom(src => false))
+                .ForMember(dest => dest.User, act => act.MapFrom(src => src.Author))
                 .ReverseMap();
             CreateMap<NGitLab.Models.MergeRequest, Model.Issue>()
                 .ForMember(dest => dest.InternalNumber, act => act.MapFrom(src => src.Id))
                 .ForMember(dest => dest.PublicNumber, act => act.MapFrom(src => src.Iid))
                 .ForMember(dest => dest.HtmlUrl, act => act.MapFrom(src => src.WebUrl))
                 .ForMember(dest => dest.IsPullRequest, act => act.MapFrom(src => true))
+                .ForMember(dest => dest.User, act => act.MapFrom(src => src.Author))
                 .ReverseMap();
             CreateMap<string, Model.Label>().ForMember(dest => dest.Name, act => act.MapFrom(src => src));
             CreateMap<Model.Release, NGitLab.Models.ReleaseCreate>()
@@ -43,6 +45,16 @@ public GitLabProfile()
                 .ReverseMap();
             CreateMap<NGitLab.Models.MergeRequestComment, Model.IssueComment>()
                 .ReverseMap();
+            CreateMap<Model.User, NGitLab.Models.User>()
+                .ForMember(dest => dest.Username, act => act.MapFrom(src => src.Login))
+                .ForMember(dest => dest.WebURL, act => act.MapFrom(src => src.HtmlUrl))
+                .ForMember(dest => dest.AvatarURL, act => act.MapFrom(src => src.AvatarUrl))
+                .ReverseMap();
+            CreateMap<Model.User, NGitLab.Models.Author>()
+                .ForMember(dest => dest.Username, act => act.MapFrom(src => src.Login))
+                .ForMember(dest => dest.WebUrl, act => act.MapFrom(src => src.HtmlUrl))
+                .ForMember(dest => dest.AvatarUrl, act => act.MapFrom(src => src.AvatarUrl))
+                .ReverseMap();
         }
     }
 }
\ No newline at end of file