(#89) Include contributors in release notes

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.

Author: Jericho

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" />

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>();
             }
         }

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

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; }
     }
 }

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;
+    }
+}

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>

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();
         }
     }
 }

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; }
     }
 }

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; }
     }
 }

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; }
+    }
+}