Merge pull request #615 from Jericho/allow_milestone_without_issues

(#495) Allow milestones without issues

Author: gep13

docs/input/docs/configuration/default-configuration.md

@@ -21,6 +21,7 @@ create:
  sha-section-line-format: "- `{1}\t{0}`"
  allow-update-to-published: false
  include-contributors: false
+ allow-milestone-without-issues: false
 export:
  include-created-date-in-title: false
  created-date-string-format: ''
@@ -142,6 +143,11 @@ control the look and feel of the generated release notes.
  in the release notes. A contributor is defined as someone who opened an issue
  or submitted a PR. **NOTE:** This configuration option was added in version
  0.19.0 of GitReleaseManager.
+- **allow-milestone-without-issues**
+ - A boolean value which indicates whether an empty release will be created, when
+ no issues are found to be associated with a milestone. The contents of the
+ empty release can be controlled via the associated Scriban template.
+ **NOTE:** This configuration option was added in version 0.20.0 of GitReleaseManager.
 
 See the [example create configuration section](create-configuration) to see an
 example of how a footer can be configured.

src/GitReleaseManager.Core.Tests/VcsServiceTests.cs

@@ -8,7 +8,6 @@
 using GitReleaseManager.Core.Model;
 using GitReleaseManager.Core.Provider;
 using GitReleaseManager.Core.ReleaseNotes;
-using GitReleaseManager.Core.Templates;
 using NSubstitute;
 using NUnit.Framework;
 using Serilog;
@@ -303,7 +302,7 @@ public async Task Should_Create_Release_From_Milestone()
  {
  var release = new Release();
 
- _releaseNotesBuilder.BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, ReleaseTemplates.DEFAULT_NAME)
+ _releaseNotesBuilder.BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, null)
  .Returns(Task.FromResult(RELEASE_NOTES));
 
  _vcsProvider.GetReleaseAsync(OWNER, REPOSITORY, MILESTONE_TITLE)
@@ -315,7 +314,7 @@ public async Task Should_Create_Release_From_Milestone()
  var result = await _vcsService.CreateReleaseFromMilestoneAsync(OWNER, REPOSITORY, MILESTONE_TITLE, MILESTONE_TITLE, null, null, false, null).ConfigureAwait(false);
  result.ShouldBeSameAs(release);
 
- await _releaseNotesBuilder.Received(1).BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, ReleaseTemplates.DEFAULT_NAME).ConfigureAwait(false);
+ await _releaseNotesBuilder.Received(1).BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, null).ConfigureAwait(false);
  await _vcsProvider.Received(1).GetReleaseAsync(OWNER, REPOSITORY, MILESTONE_TITLE).ConfigureAwait(false);
  await _vcsProvider.Received(1).CreateReleaseAsync(OWNER, REPOSITORY, Arg.Is<Release>(o =>
  o.Body == RELEASE_NOTES &&
@@ -333,7 +332,7 @@ public async Task Should_Create_Release_From_Milestone_With_Assets()
 
  var assetsCount = _assets.Count;
 
- _releaseNotesBuilder.BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, ReleaseTemplates.DEFAULT_NAME)
+ _releaseNotesBuilder.BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, null)
  .Returns(Task.FromResult(RELEASE_NOTES));
 
  _vcsProvider.GetReleaseAsync(OWNER, REPOSITORY, MILESTONE_TITLE)
@@ -353,7 +352,7 @@ public async Task Should_Create_Release_From_Milestone_With_Assets()
  null).ConfigureAwait(false);
  result.ShouldBeSameAs(release);
 
- await _releaseNotesBuilder.Received(1).BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, ReleaseTemplates.DEFAULT_NAME).ConfigureAwait(false);
+ await _releaseNotesBuilder.Received(1).BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, null).ConfigureAwait(false);
  await _vcsProvider.Received(1).GetReleaseAsync(OWNER, REPOSITORY, MILESTONE_TITLE).ConfigureAwait(false);
  await _vcsProvider.Received(1).CreateReleaseAsync(OWNER, REPOSITORY, Arg.Is<Release>(o =>
  o.Body == RELEASE_NOTES &&
@@ -430,7 +429,7 @@ public async Task Should_Update_Published_Release_On_Creating_Release_From_Miles
 
  _configuration.Create.AllowUpdateToPublishedRelease = updatePublishedRelease;
 
- _releaseNotesBuilder.BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, ReleaseTemplates.DEFAULT_NAME)
+ _releaseNotesBuilder.BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, null)
  .Returns(Task.FromResult(RELEASE_NOTES));
 
  _vcsProvider.GetReleaseAsync(OWNER, REPOSITORY, MILESTONE_TITLE)
@@ -442,7 +441,7 @@ public async Task Should_Update_Published_Release_On_Creating_Release_From_Miles
  var result = await _vcsService.CreateReleaseFromMilestoneAsync(OWNER, REPOSITORY, MILESTONE_TITLE, MILESTONE_TITLE, null, null, false, null).ConfigureAwait(false);
  result.ShouldBeSameAs(release);
 
- await _releaseNotesBuilder.Received(1).BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, ReleaseTemplates.DEFAULT_NAME).ConfigureAwait(false);
+ await _releaseNotesBuilder.Received(1).BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, null).ConfigureAwait(false);
  await _vcsProvider.Received(1).GetReleaseAsync(OWNER, REPOSITORY, MILESTONE_TITLE).ConfigureAwait(false);
  await _vcsProvider.Received(1).UpdateReleaseAsync(OWNER, REPOSITORY, release).ConfigureAwait(false);
 
@@ -458,7 +457,7 @@ public async Task Should_Throw_Exception_While_Updating_Published_Release_On_Cre
 
  _configuration.Create.AllowUpdateToPublishedRelease = false;
 
- _releaseNotesBuilder.BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, ReleaseTemplates.DEFAULT_NAME)
+ _releaseNotesBuilder.BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, null)
  .Returns(Task.FromResult(RELEASE_NOTES));
 
  _vcsProvider.GetReleaseAsync(OWNER, REPOSITORY, MILESTONE_TITLE)
@@ -467,7 +466,7 @@ public async Task Should_Throw_Exception_While_Updating_Published_Release_On_Cre
  var ex = await Should.ThrowAsync<InvalidOperationException>(() => _vcsService.CreateReleaseFromMilestoneAsync(OWNER, REPOSITORY, MILESTONE_TITLE, MILESTONE_TITLE, null, null, false, null)).ConfigureAwait(false);
  ex.Message.ShouldBe($"Release with tag '{MILESTONE_TITLE}' not in draft state, so not updating");
 
- await _releaseNotesBuilder.Received(1).BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, ReleaseTemplates.DEFAULT_NAME).ConfigureAwait(false);
+ await _releaseNotesBuilder.Received(1).BuildReleaseNotesAsync(OWNER, REPOSITORY, MILESTONE_TITLE, null).ConfigureAwait(false);
  await _vcsProvider.Received(1).GetReleaseAsync(OWNER, REPOSITORY, MILESTONE_TITLE).ConfigureAwait(false);
  }
 

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,
+ AllowMilestonesWithoutIssues = false,
  IncludeContributors = false,
  };
 

src/GitReleaseManager.Core/Configuration/CreateConfig.cs

@@ -35,6 +35,9 @@ public class CreateConfig
  [YamlMember(Alias = "allow-update-to-published")]
  public bool AllowUpdateToPublishedRelease { get; set; }
 
+ [YamlMember(Alias = "allow-milestone-without-issues")]
+ public bool AllowMilestonesWithoutIssues { get; set; }
+
  [YamlMember(Alias = "include-contributors")]
  public bool IncludeContributors { get; set; }
  }

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;
@@ -58,12 +58,31 @@ public async Task<string> BuildReleaseNotesAsync(string user, string repository,
 
  var numberOfCommits = await _vcsProvider.GetCommitsCountAsync(_user, _repository, @base, head).ConfigureAwait(false);
 
- if (issues.Count == 0)
+ if (issues.Count == 0 && !_configuration.Create.AllowMilestonesWithoutIssues)
  {
  var logMessage = string.Format(CultureInfo.CurrentCulture, "No closed issues have been found for milestone {0}, or all assigned issues are meant to be excluded from release notes, aborting release creation.", _milestoneTitle);
  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 -}}