Contributors

Author: Jericho

src/GitReleaseManager.Core/Extensions/LinqExtensions.cs

@@ -0,0 +1,21 @@
+using System;
+using System.Collections.Generic;
+
+namespace GitReleaseManager.Core.Extensions
+{
+    internal static class LinqExtensions
+    {
+        // This is the equivalent of DistinctBy which is available in .NET 6
+        public static IEnumerable<TSource> DistinctBy<TSource, TKey>(this IEnumerable<TSource> source, Func<TSource, TKey> keySelector)
+        {
+            HashSet<TKey> seenKeys = new HashSet<TKey>();
+            foreach (TSource element in source)
+            {
+                if (seenKeys.Add(keySelector(element)))
+                {
+                    yield return element;
+                }
+            }
+        }
+    }
+}

src/GitReleaseManager.Core/ReleaseNotes/ReleaseNotesBuilder.cs

@@ -5,6 +5,7 @@
 using System.Threading.Tasks;
 using GitReleaseManager.Core.Configuration;
 using GitReleaseManager.Core.Exceptions;
+using GitReleaseManager.Core.Extensions;
 using GitReleaseManager.Core.Helpers;
 using GitReleaseManager.Core.Model;
 using GitReleaseManager.Core.Provider;
@@ -66,12 +67,19 @@ public async Task<string> BuildReleaseNotesAsync(string user, string repository,
 
             var commitsLink = _vcsProvider.GetCommitsUrl(_user, _repository, _targetMilestone?.Title, previousMilestone?.Title);
 
-            foreach (var issue in issues)
+            var issuesDict = GetIssuesDict(issues);
+
+            // The call to GetIssuesDict above will filter out the issues that are not taged with one of the configured tags.
+            // Therefore it's more efficient to fetch the linked issues AFTER GetIssuesDict has been invoked.
+            foreach (var kvp in issuesDict)
             {
-                issue.LinkedIssue = await _vcsProvider.GetLinkedIssueAsync(_user, _repository, issue.Number).ConfigureAwait(false);
+                foreach (var issue in kvp.Value)
+                {
+                    issue.LinkedIssue = await _vcsProvider.GetLinkedIssueAsync(_user, _repository, issue.Number).ConfigureAwait(false);
+                }
             }
 
-            var issuesDict = GetIssuesDict(issues);
+            var contributors = GetContributors(issues);
 
             var milestoneQueryString = _vcsProvider.GetMilestoneQueryString();
 
@@ -82,6 +90,11 @@ public async Task<string> BuildReleaseNotesAsync(string user, string repository,
                     issues.Count,
                     Items = issuesDict,
                 },
+                Contributors = new
+                {
+                    Count = contributors.Count,
+                    Items = contributors,
+                },
                 Commits = new
                 {
                     Count = numberOfCommits,
@@ -116,6 +129,18 @@ private Dictionary<string, List<Issue>> GetIssuesDict(List<Issue> issues)
             return issuesByLabel;
         }
 
+        private static List<User> GetContributors(List<Issue> issues)
+        {
+            var contributors = issues
+                .Select(i => i.User)
+                .Union(issues.Select(i => i.LinkedIssue?.User))
+                .Where(u => u != null)
+                .DistinctBy(u => u.Login)
+                .ToList();
+
+            return contributors;
+        }
+
         private string GetValidLabel(string label, int issuesCount)
         {
             var alias = _configuration.LabelAliases.FirstOrDefault(x => x.Name.Equals(label, StringComparison.OrdinalIgnoreCase));

src/GitReleaseManager.Core/Templates/default/contributor-details.sbn

@@ -0,0 +1 @@
+<img src="{{contributor.avatar_url}}" alt="{{contributor.login}}" height="32" width="32"/> 

src/GitReleaseManager.Core/Templates/default/contributors.sbn

@@ -0,0 +1,10 @@
+
+
+__Contributors__
+
+{{ contributors.count }} contributors made this release possible.
+
+{{ for contributor in contributors.items
+    include 'contributor-details'
+end }}
+

src/GitReleaseManager.Core/Templates/default/index.sbn

@@ -4,6 +4,7 @@
         include 'milestone'
     end
     include 'issues' | string.rstrip
+    include 'contributors'
     if template_kind == "CREATE"
         include 'create/footer'
     end

src/GitReleaseManager.IntegrationTests/ReleaseNotesBuilderIntegrationTests.cs

@@ -55,11 +55,13 @@ public async Task SingleMilestone()
             {
                 var fileSystem = new FileSystem(new CreateSubOptions());
                 var currentDirectory = Environment.CurrentDirectory;
+
                 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
 
                 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);
+                var result = await releaseNotesBuilder.BuildReleaseNotesAsync("GitTools", "GitReleaseManager", "0.12.0", ReleaseTemplates.DEFAULT_NAME).ConfigureAwait(false); // 0.12.0 contains a mix of issues and PRs
                 Debug.WriteLine(result);
                 ClipBoardHelper.SetClipboard(result);
             }