(GitToolsGH-495) Create a template used when a milestone does not have any associated issues AND the developer has indicated they want to allow milestones without issues.

Author: Jericho

src/GitReleaseManager.Core/ReleaseNotes/ReleaseNotesBuilder.cs

@@ -35,7 +35,7 @@ public ReleaseNotesBuilder(IVcsProvider vcsProvider, ILogger logger, IFileSystem
             _templateFactory = templateFactory;
         }
 
-        public async Task<string> BuildReleaseNotesAsync(string user, string repository, string milestoneTitle, string template)
+        public async Task<string> BuildReleaseNotesAsync(string user, string repository, string milestoneTitle, string customTemplate)
         {
             _user = user;
             _repository = repository;
@@ -64,6 +64,25 @@ public async Task<string> BuildReleaseNotesAsync(string user, string repository,
                 throw new InvalidOperationException(logMessage);
             }
 
+            // By default we use the custom template, if it was provided.
+            // Otherwise, we determine which template we should use.
+            var template = customTemplate;
+            if (string.IsNullOrWhiteSpace(template))
+            {
+                if (issues.Count == 0)
+                {
+                    template = ReleaseTemplates.NO_ISSUES_NAME;
+                }
+                else if (_configuration.Create.IncludeContributors)
+                {
+                    template = ReleaseTemplates.CONTRIBUTORS_NAME;
+                }
+                else
+                {
+                    template = ReleaseTemplates.DEFAULT_NAME;
+                }
+            }
+
             var commitsLink = _vcsProvider.GetCommitsUrl(_user, _repository, _targetMilestone?.Title, previousMilestone?.Title);
 
             var issuesDict = GetIssuesDict(issues);

src/GitReleaseManager.Core/Templates/no_issues/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 }}

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

@@ -0,0 +1,10 @@
+{{-
+    include 'release-info'
+    if milestone.target.description
+        include 'milestone'
+    end
+    include 'issues' | string.rstrip
+    if template_kind == "CREATE"
+        include 'create/footer'
+    end
+~}}

src/GitReleaseManager.Core/Templates/no_issues/issues.sbn

@@ -0,0 +1,2 @@
+
+This release had no issues associated with it

src/GitReleaseManager.Core/Templates/no_issues/milestone.sbn

@@ -0,0 +1,2 @@
+
+{{ milestone.target.description }}

src/GitReleaseManager.Core/Templates/no_issues/release-info.sbn

@@ -0,0 +1,4 @@
+{{
+    if commits.count > 0
+}}As part of this release we had [{{ commits.count }} {{ commits.count | string.pluralize "commit" "commits" }}]({{ commits.html_url }}).
+{{  end -}}

src/GitReleaseManager.Core/VcsService.cs

@@ -13,7 +13,6 @@
 using GitReleaseManager.Core.Model;
 using GitReleaseManager.Core.Provider;
 using GitReleaseManager.Core.ReleaseNotes;
-using GitReleaseManager.Core.Templates;
 using Serilog;
 
 namespace GitReleaseManager.Core
@@ -46,16 +45,7 @@ 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 = _configuration.Create.IncludeContributors
-                ? ReleaseTemplates.CONTRIBUTORS_NAME
-                : ReleaseTemplates.DEFAULT_NAME;
-
-            if (!string.IsNullOrWhiteSpace(templateFilePath))
-            {
-                templatePath = templateFilePath;
-            }
-
-            var releaseNotes = await _releaseNotesBuilder.BuildReleaseNotesAsync(owner, repository, milestone, templatePath).ConfigureAwait(false);
+            var releaseNotes = await _releaseNotesBuilder.BuildReleaseNotesAsync(owner, repository, milestone, templateFilePath).ConfigureAwait(false);
             var release = await CreateReleaseAsync(owner, repository, releaseName, milestone, releaseNotes, prerelease, targetCommitish, assets).ConfigureAwait(false);
 
             return release;
@@ -67,7 +57,7 @@ public async Task<Release> CreateReleaseFromInputFileAsync(string owner, string
 
             _logger.Verbose("Reading release notes from: '{FilePath}'", inputFilePath);
 
-            var releaseNotes = File.ReadAllText(inputFilePath);
+            var releaseNotes = await File.ReadAllTextAsync(inputFilePath).ConfigureAwait(false);
             var release = await CreateReleaseAsync(owner, repository, name, name, releaseNotes, prerelease, targetCommitish, assets).ConfigureAwait(false);
 
             return release;

src/GitReleaseManager.IntegrationTests/ReleaseNotesBuilderIntegrationTests.cs

@@ -39,7 +39,7 @@ public void Configure()
             _logger = new LoggerConfiguration().WriteTo.Console().CreateLogger();
             Log.Logger = _logger;
 
-            _token = Environment.GetEnvironmentVariable("GITTOOLS_GITHUB_TOKEN");
+            _token = Environment.GetEnvironmentVariable("GITHUB_TOKEN");
             if (string.IsNullOrWhiteSpace(_token))
             {
                 Assert.Inconclusive("Unable to locate credentials for accessing GitHub API");
@@ -74,17 +74,38 @@ public async Task SingleMilestone()
                 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
+                // Indicate that we 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", string.Empty).ConfigureAwait(false); // 0.12.0 contains a mix of issues and PRs
+                Debug.WriteLine(result);
+                ClipBoardHelper.SetClipboard(result);
+            }
+        }
+
+        [Test]
+        [Explicit]
+        public async Task MilestoneWithoutIssues()
+        {
+            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 configuration = ConfigurationProvider.Provide(currentDirectory, fileSystem);
+
+                // Indicate that we allow milestones without issues
+                configuration.Create.AllowMilestonesWithoutIssues = true;
 
                 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
+                var result = await releaseNotesBuilder.BuildReleaseNotesAsync("jericho", "_testing", "0.1.0", string.Empty).ConfigureAwait(false); // There are no issues associated with milestone 0.1.0 in my testing repo.
                 Debug.WriteLine(result);
                 ClipBoardHelper.SetClipboard(result);
             }