Merge branch 'develop' into release/0.12.0

* develop:
  (build) Remove error action preference from build script
  Bump YamlDotNet from 11.0.1 to 11.1.1 in /src
  (#112) Updated docs with new command option
  (#112) Add new method for creating empty release

build.ps1

@@ -1,6 +1,4 @@
-$ErrorActionPreference = 'Stop'
-
-$SCRIPT_NAME = "recipe.cake"
+$SCRIPT_NAME = "recipe.cake"
 
 Write-Host "Restoring .NET Core tools"
 dotnet tool restore

docs/input/docs/commands/create.md

@@ -6,10 +6,11 @@ Title: Create
 This is the main command of GitReleaseManager and it is used to create a draft
 set of release notes based on a milestone, which has been set up in GitHub.
 
-There are two modes of operation when creating a Release. GitReleaseManager can
+There are three modes of operation when creating a Release. GitReleaseManager can
 take as an input the name of the milestone to generate the release notes from.
 Or, it can take as an input the name of a file which contains the release notes
 to include in the Release.
+Or, it can create a release that doesn't contain any release notes, i.e. it is empty.
 
 ## **Required Parameters**
 
@@ -35,6 +36,8 @@ to include in the Release.
     logging to console.
 - `-t, --template`: The path to the file to be used as the template for the
     release notes.
+- `--allowEmpty`: Allow the creation of an empty set of release notes. In this
+mode, milestone and input file path will be ignored.
 
 ## **Template**
 
@@ -61,3 +64,9 @@ gitreleasemanager.exe create -i c:\temp\releasenotes.md -n 0.1.0 --token fsdfsf6
 
 gitreleasemanager.exe create --inputFilePath c:\temp\releasenotes.md --name 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
 ```
+
+Use GitReleaseManager to create an empty release:
+
+```bash
+gitreleasemanager.exe create -n 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo --allowEmpty
+```

src/GitReleaseManager.Core.Tests/Commands/CreateCommandTests.cs

@@ -27,6 +27,31 @@ public void Setup()
             _command = new CreateCommand(_vcsService, _logger);
         }
 
+        public async Task Should_Create_Empty_Release()
+        {
+            var options = new CreateSubOptions
+            {
+                RepositoryOwner = "owner",
+                RepositoryName = "repository",
+                TargetCommitish = "target commitish",
+                Prerelease = false,
+                AllowEmpty = true,
+            };
+
+            var releaseName = options.Name ?? options.Milestone;
+
+            _vcsService.CreateEmptyReleaseAsync(options.RepositoryOwner, options.RepositoryName, options.Name, options.TargetCommitish, options.Prerelease)
+                .Returns(_release);
+
+            var result = await _command.Execute(options).ConfigureAwait(false);
+            result.ShouldBe(0);
+
+            await _vcsService.Received(1).CreateEmptyReleaseAsync(options.RepositoryOwner, options.RepositoryName, releaseName, options.TargetCommitish, options.Prerelease).ConfigureAwait(false);
+            _logger.Received(1).Information(Arg.Any<string>());
+            _logger.Received(1).Information(Arg.Any<string>(), _release.HtmlUrl);
+            _logger.Received(1).Verbose(Arg.Any<string>(), _release.Body);
+        }
+
         [TestCase(null, 2)]
         [TestCase("release", 1)]
         public async Task Should_Create_Release_From_Milestone(string name, int logVerboseCount)

src/GitReleaseManager.Core/Commands/CreateCommand.cs

@@ -22,7 +22,12 @@ public async Task<int> Execute(CreateSubOptions options)
 
             Release release;
 
-            if (!string.IsNullOrEmpty(options.Milestone))
+            if (options.AllowEmpty)
+            {
+                _logger.Verbose("The AllowEmpty option has been passed, so an empty release will now be created");
+                release = await _vcsService.CreateEmptyReleaseAsync(options.RepositoryOwner, options.RepositoryName, options.Name, options.TargetCommitish, options.Prerelease).ConfigureAwait(false);
+            }
+            else if (!string.IsNullOrEmpty(options.Milestone))
             {
                 _logger.Verbose("Milestone {Milestone} was specified", options.Milestone);
                 var releaseName = options.Name;

src/GitReleaseManager.Core/GitReleaseManager.Core.csproj

@@ -26,7 +26,7 @@
         <PackageReference Include="Octokit" Version="0.50.0" />
         <PackageReference Include="Scriban" Version="3.6.0" />
         <PackageReference Include="seriloganalyzer" Version="0.15.0" />
-        <PackageReference Include="YamlDotNet" Version="11.0.1" />
+        <PackageReference Include="YamlDotNet" Version="11.1.1" />
         <PackageReference Include="AutoMapper" Version="10.1.1" />
     </ItemGroup>
     <ItemGroup>

src/GitReleaseManager.Core/IVcsService.cs

@@ -6,6 +6,8 @@ namespace GitReleaseManager.Core
 {
     public interface IVcsService
     {
+        Task<Release> CreateEmptyReleaseAsync(string owner, string repository, string name, string targetCommitish, bool prerelease);
+
         Task<Release> CreateReleaseFromMilestoneAsync(string owner, string repository, string milestone, string releaseName, string targetCommitish, IList<string> assets, bool prerelease, string templateFilePath);
 
         Task<Release> CreateReleaseFromInputFileAsync(string owner, string repository, string name, string inputFilePath, string targetCommitish, IList<string> assets, bool prerelease);

src/GitReleaseManager.Core/Options/CreateSubOptions.cs

@@ -26,5 +26,8 @@ public class CreateSubOptions : BaseVcsOptions
 
         [Option('e', "pre", Required = false, HelpText = "Creates the release as a pre-release.")]
         public bool Prerelease { get; set; }
+
+        [Option("allowEmpty", Required = false, HelpText = "Allow the creation of an empty set of release notes. In this mode, milestone and input file path will be ignored.")]
+        public bool AllowEmpty { get; set; }
     }
 }

src/GitReleaseManager.Core/VcsService.cs

@@ -37,6 +37,12 @@ public VcsService(IVcsProvider vcsProvider, ILogger logger, IReleaseNotesBuilder
             _configuration = configuration;
         }
 
+        public async Task<Release> CreateEmptyReleaseAsync(string owner, string repository, string name, string targetCommitish, bool prerelease)
+        {
+            var release = await CreateReleaseAsync(owner, repository, name, name, string.Empty, prerelease, targetCommitish, null).ConfigureAwait(false);
+            return release;
+        }
+
         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;

src/GitReleaseManager.Tests/VcsServiceMock.cs

@@ -25,6 +25,11 @@ public VcsServiceMock()
 
         public int NumberOfCommits { get; set; }
 
+        public Task<Release> CreateEmptyReleaseAsync(string owner, string repository, string name, string targetCommitish, bool prerelease)
+        {
+            throw new System.NotImplementedException();
+        }
+
         public Task<Release> CreateReleaseFromMilestoneAsync(string owner, string repository, string milestone, string releaseName, string targetCommitish, IList<string> assets, bool prerelease, string templateFilePath)
         {
             throw new System.NotImplementedException();