Merge pull request #301 from ap0llo/master

Allow incrementing the "build" of the version in the prepare-release command

Author: AArnott

doc/nbgv-cli.md

@@ -103,11 +103,11 @@ The behaviour of the `prepare-release` command can be customized in
 }
 ```
 
-| Property         | Default value        | Description                                                                                                                                |
-|------------------|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
-| branchName       | `v{version}`         | Defines the format of release branch names. The value must include a `{version}` placeholder.                                              |
-| versionIncremnt  | `minor`              | Specifies which part of the version on the current branch is incremented when preparing a release. Allowed values are `minor` and `major`. |
-| firstUnstableTag | `alpha`              | Specified the unstable tag to use for the main branch.                                                                                     |
+| Property         | Default value        | Description                                                                                                                                         |
+|------------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
+| branchName       | `v{version}`         | Defines the format of release branch names. The value must include a `{version}` placeholder.                                                       |
+| versionIncremnt  | `minor`              | Specifies which part of the version on the current branch is incremented when preparing a release. Allowed values are `major`, `minor` and `build`. |
+| firstUnstableTag | `alpha`              | Specified the unstable tag to use for the main branch.                                                                                              |
 
 ## Learn more
 

src/NerdBank.GitVersioning.Tests/ReleaseManagerTests.cs

@@ -209,11 +209,16 @@ public void PrepeareRelease_ReleaseBranchWithVersionDecrement(string initialVers
     [InlineData("1.2-beta", "v{version}release", ReleaseVersionIncrement.Minor, "alpha", "rc", null, "v1.2release", "1.2-rc", "1.3-alpha")]
     [InlineData("1.2-beta.{height}", "v{version}release", ReleaseVersionIncrement.Minor, "alpha", null, null, "v1.2release", "1.2", "1.3-alpha.{height}")]
     [InlineData("1.2-beta.{height}", "v{version}release", ReleaseVersionIncrement.Minor, "alpha", "rc", null, "v1.2release", "1.2-rc.{height}", "1.3-alpha.{height}")]
-    // modify release.versionIncrement
+    // modify release.versionIncrement: "Major"
     [InlineData("1.2-beta", null, ReleaseVersionIncrement.Major, "alpha", null, null, "v1.2", "1.2", "2.0-alpha")]
     [InlineData("1.2-beta", null, ReleaseVersionIncrement.Major, "alpha", "rc", null, "v1.2", "1.2-rc", "2.0-alpha")]
     [InlineData("1.2-beta.{height}", null, ReleaseVersionIncrement.Major, "alpha", null, null, "v1.2", "1.2", "2.0-alpha.{height}")]
     [InlineData("1.2-beta.{height}", null, ReleaseVersionIncrement.Major, "alpha", "rc", null, "v1.2", "1.2-rc.{height}", "2.0-alpha.{height}")]
+    // modify release.versionIncrement: "Build"
+    [InlineData("1.2.3-beta", null, ReleaseVersionIncrement.Build, "alpha", null, null, "v1.2.3", "1.2.3", "1.2.4-alpha")]
+    [InlineData("1.2.3-beta", null, ReleaseVersionIncrement.Build, "alpha", "rc", null, "v1.2.3", "1.2.3-rc", "1.2.4-alpha")]
+    [InlineData("1.2.3-beta.{height}", null, ReleaseVersionIncrement.Build, "alpha", null, null, "v1.2.3", "1.2.3", "1.2.4-alpha.{height}")]
+    [InlineData("1.2.3-beta.{height}", null, ReleaseVersionIncrement.Build, "alpha", "rc", null, "v1.2.3", "1.2.3-rc.{height}", "1.2.4-alpha.{height}")]
     // modify release.firstUnstableTag
     [InlineData("1.2-beta", null, ReleaseVersionIncrement.Minor, "preview", null, null, "v1.2", "1.2", "1.3-preview")]
     [InlineData("1.2-beta", null, ReleaseVersionIncrement.Minor, "preview", "rc", null, "v1.2", "1.2-rc", "1.3-preview")]
@@ -380,6 +385,27 @@ public void PrepareRelease_DetachedHead()
         Assert.Equal(ReleasePreparationError.DetachedHead, ex.Error);
     }
 
+    [Fact]
+    public void PrepareRelease_InvalidVersionIncrement()
+    {
+        // create and configure repository
+        this.InitializeSourceControl();
+        this.Repo.Config.Set("user.name", this.Signer.Name, ConfigurationLevel.Local);
+        this.Repo.Config.Set("user.email", this.Signer.Email, ConfigurationLevel.Local);
+
+        // create version.json
+        var versionOptions = new VersionOptions()
+        {
+            Version = SemanticVersion.Parse("1.2"),
+            Release = new ReleaseOptions() { VersionIncrement = ReleaseVersionIncrement.Build }
+        };
+        this.WriteVersionFile(versionOptions);
+
+        // running PrepareRelease should result in an error
+        // because a 2-segment version is incompatibale with a increment setting of "build"
+        this.AssertError(() => new ReleaseManager().PrepareRelease(this.RepoPath), ReleasePreparationError.InvalidVersionIncrementSetting);
+    }
+
     private void AssertError(Action testCode, ReleasePreparationError expectedError)
     {
         var ex = Assert.Throws<ReleasePreparationException>(testCode);

src/NerdBank.GitVersioning.Tests/SemanticVersionExtensionsTests.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Reflection;
 using Nerdbank.GitVersioning;
 using Xunit;
@@ -26,7 +27,13 @@ public class SemanticVersionExtensionsTests
     [InlineData("1.2.3", ReleaseVersionIncrement.Major, "2.0.0")]
     [InlineData("1.2.3.4", ReleaseVersionIncrement.Minor, "1.3.0.0")]
     [InlineData("1.2.3.4", ReleaseVersionIncrement.Major, "2.0.0.0")]
-    public void IncrementVersion(string currentVersionString, ReleaseVersionIncrement increment, string expectedVersionString)
+    [InlineData("1.2.3", ReleaseVersionIncrement.Build, "1.2.4")]
+    [InlineData("1.2.3.4", ReleaseVersionIncrement.Build, "1.2.4.0")]
+    [InlineData("1.2.3-tag", ReleaseVersionIncrement.Build, "1.2.4-tag")]
+    [InlineData("1.2.3-tag+metadata", ReleaseVersionIncrement.Build, "1.2.4-tag+metadata")]
+    [InlineData("1.2.3.4-tag", ReleaseVersionIncrement.Build, "1.2.4.0-tag")]
+    [InlineData("1.2.3.4-tag+metadata", ReleaseVersionIncrement.Build, "1.2.4.0-tag+metadata")]
+    public void Increment(string currentVersionString, ReleaseVersionIncrement increment, string expectedVersionString)
     {
         var currentVersion = SemanticVersion.Parse(currentVersionString);
         var expectedVersion = SemanticVersion.Parse(expectedVersionString);
@@ -36,6 +43,15 @@ public void IncrementVersion(string currentVersionString, ReleaseVersionIncremen
         Assert.Equal(expectedVersion, actualVersion);
     }
 
+    [Theory]
+    [InlineData("1.0", ReleaseVersionIncrement.Build)]
+    public void Increment_InvalidIncrement(string currentVersionString, ReleaseVersionIncrement increment)
+    {
+        var currentVersion = SemanticVersion.Parse(currentVersionString);
+
+        Assert.Throws<ArgumentException>(() => currentVersion.Increment(increment));
+    }
+
     [Theory]
     // no prerelease tag in input version
     [InlineData("1.2", "pre", "1.2-pre")]

src/NerdBank.GitVersioning.Tests/VersionSchemaTests.cs

@@ -87,11 +87,12 @@ public void Inherit_AllowsOmissionOfVersion()
 
     [Theory]
     [InlineData(@"{ ""version"": ""2.3"", ""release"":  { } }")]
-    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""{0}"" } }")]
-    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""release/v{0}"" } }")]
-    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""prefix{0}suffix"" } }")]
-    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""{0}"", ""versionIncrement"" : ""major"" } }")]
-    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""{0}"", ""versionIncrement"" : ""minor"" } }")]
+    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""{version}"" } }")]
+    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""release/v{version}"" } }")]
+    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""prefix{version}suffix"" } }")]
+    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""{version}"", ""versionIncrement"" : ""major"" } }")]
+    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""{version}"", ""versionIncrement"" : ""minor"" } }")]
+    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""{version}"", ""versionIncrement"" : ""build"" } }")]
     [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""firstUnstableTag"" : ""pre"" } }")]
     public void ReleaseProperty_ValidJson(string json)
     {
@@ -100,9 +101,10 @@ public void ReleaseProperty_ValidJson(string json)
     }
 
     [Theory]
-    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""versionIncrement"" : ""build"" } }")]
+    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""versionIncrement"" : ""revision"" } }")]
     [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""formatWithoutPlaceholder"" } }")]
-    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""unknownProperty"" : ""value"" } }")]
+    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""branchName"" : ""formatWithoutPlaceholder{0}"" } }")]
+    [InlineData(@"{ ""version"": ""2.3"", ""release"":  { ""unknownProperty"" : ""value"" } }")]    
     public void ReleaseProperty_InvalidJson(string json)
     {
         this.json = JObject.Parse(json);

src/NerdBank.GitVersioning/ReleaseManager.cs

@@ -56,6 +56,11 @@ public enum ReleasePreparationError
             /// HEAD is detached. A branch must be checked out first.
             /// </summary>
             DetachedHead,
+
+            /// <summary>
+            /// The versionIncrement setting cannot be applied to the current version.
+            /// </summary>
+            InvalidVersionIncrementSetting,
         }
 
         /// <summary>
@@ -125,14 +130,13 @@ public void PrepareRelease(string projectDirectory, string releaseUnstableTag =
                 this.stderr.WriteLine($"Failed to load version file for directory '{projectDirectory}'.");
                 throw new ReleasePreparationException(ReleasePreparationError.NoVersionFile);
             }
-
-            var releaseOptions = versionOptions.ReleaseOrDefault;
-
+            
             var releaseBranchName = this.GetReleaseBranchName(versionOptions);
             var originalBranchName = repository.Head.FriendlyName;
             var releaseVersion = string.IsNullOrEmpty(releaseUnstableTag)
                 ? versionOptions.Version.WithoutPrepreleaseTags()
                 : versionOptions.Version.SetFirstPrereleaseTag(releaseUnstableTag);
+            var nextDevVersion = this.GetNextDevVersion(versionOptions, nextVersion);
 
             // check if the current branch is the release branch
             if (string.Equals(originalBranchName, releaseBranchName, StringComparison.OrdinalIgnoreCase))
@@ -157,10 +161,6 @@ public void PrepareRelease(string projectDirectory, string releaseUnstableTag =
 
             // update version on main branch
             Commands.Checkout(repository, originalBranchName);
-            var nextDevVersion = nextVersion ??
-                    versionOptions.Version
-                        .Increment(releaseOptions.VersionIncrementOrDefault)
-                        .SetFirstPrereleaseTag(releaseOptions.FirstUnstableTagOrDefault);
             this.UpdateVersion(projectDirectory, repository, versionOptions.Version, nextDevVersion);
             this.stdout.WriteLine($"{originalBranchName} branch now tracks v{nextDevVersion} development.");
 
@@ -272,5 +272,30 @@ private static bool IsVersionDecrement(SemanticVersion oldVersion, SemanticVersi
                 return true;
             }
         }
+
+        private SemanticVersion GetNextDevVersion(VersionOptions versionOptions, SemanticVersion nextVersion)
+        {
+            if (nextVersion != null)
+                return nextVersion;
+
+            var releaseOptions = versionOptions.ReleaseOrDefault;
+
+            // the increment is only valid if the current version has the required precision
+            // increment settings "Major" and "Minor" are always valid
+            // increment setting "Build" is only valid if the version has at lease three segments
+            var isValidIncrement = releaseOptions.VersionIncrementOrDefault != VersionOptions.ReleaseVersionIncrement.Build ||
+                                   versionOptions.Version.Version.Build >= 0;
+
+            // increment is ignored when the next version was specified explicitly
+            if (!isValidIncrement)
+            {
+                this.stderr.WriteLine($"Cannot apply version increment 'build' to version '{versionOptions.Version}' because it only has major and minor segments");
+                throw new ReleasePreparationException(ReleasePreparationError.InvalidVersionIncrementSetting);
+            }
+
+            return versionOptions.Version
+                        .Increment(releaseOptions.VersionIncrementOrDefault)
+                        .SetFirstPrereleaseTag(releaseOptions.FirstUnstableTagOrDefault);
+        }
     }
 }

src/NerdBank.GitVersioning/SemanticVersionExtensions.cs

@@ -17,19 +17,29 @@ internal static class SemanticVersionExtensions
         internal static SemanticVersion Increment(this SemanticVersion currentVersion, VersionOptions.ReleaseVersionIncrement increment)
         {
             Requires.NotNull(currentVersion, nameof(currentVersion));
+            Requires.That(increment != VersionOptions.ReleaseVersionIncrement.Build || currentVersion.Version.Build >= 0, nameof(increment), 
+                          "Cannot apply version increment '{0}' to version '{1}'", increment, currentVersion);
 
             var major = currentVersion.Version.Major;
             var minor = currentVersion.Version.Minor;
+            var build = currentVersion.Version.Build;
 
             switch (increment)
             {
                 case VersionOptions.ReleaseVersionIncrement.Major:
                     major += 1;
                     minor = 0;
+                    build = 0;
                     break;
                 case VersionOptions.ReleaseVersionIncrement.Minor:
                     minor += 1;
+                    build = 0;
                     break;
+
+                case VersionOptions.ReleaseVersionIncrement.Build:
+                    build += 1;
+                    break;
+
                 default:
                     throw new ArgumentOutOfRangeException(nameof(increment));
             }
@@ -40,12 +50,12 @@ internal static SemanticVersion Increment(this SemanticVersion currentVersion, V
             if (currentVersion.Version.Build >= 0 && currentVersion.Version.Revision > 0)
             {
                 // 4 segment version
-                newVersion = new Version(major, minor, 0, 0);
+                newVersion = new Version(major, minor, build, 0);
             }
             else if (currentVersion.Version.Build >= 0)
             {
                 // 3 segment version
-                newVersion = new Version(major, minor, 0);
+                newVersion = new Version(major, minor, build);
             }
             else
             {

src/NerdBank.GitVersioning/VersionOptions.cs

@@ -1139,7 +1139,12 @@ public enum ReleaseVersionIncrement
             /// <summary>
             /// Increment the minor version after creating a release branch
             /// </summary>
-            Minor
+            Minor,
+
+            /// <summary>
+            /// Increment the build number (the third number in a version) after creating a release branch.
+            /// </summary>
+            Build,
         }
     }
 }

src/NerdBank.GitVersioning/version.schema.json

@@ -142,13 +142,13 @@
             "branchName": {
               "description": "Defines the format of release branch names. Format must include a placeholder '{version}' for the version",
               "type": "string",
-              "pattern": ".*\\{0\\}.*",
+              "pattern": ".*\\{version\\}.*",
               "default": "v{version}"
             },
             "versionIncrement": {
               "description": "Specifies which part of the version on the current branch is incremented when preparing a release.",
               "type": "string",
-              "enum": [ "major", "minor" ],
+              "enum": [ "major", "minor", "build" ],
               "default": "minor"
             },
             "firstUnstableTag": {

src/nbgv/Program.cs

@@ -45,6 +45,7 @@ private enum ExitCodes
             BranchAlreadyExists,
             UserNotConfigured,
             DetachedHead,
+            InvalidVersionIncrementSetting,
         }
 
         private static ExitCodes exitCode;
@@ -606,6 +607,8 @@ private static ExitCodes OnPrepareReleaseCommand(string projectPath, string prer
                         return ExitCodes.UserNotConfigured;
                     case ReleaseManager.ReleasePreparationError.DetachedHead:
                         return ExitCodes.DetachedHead;
+                    case ReleaseManager.ReleasePreparationError.InvalidVersionIncrementSetting:
+                        return ExitCodes.InvalidVersionIncrementSetting;
                     default:
                         Report.Fail($"{nameof(ReleaseManager.ReleasePreparationError)}: {ex.Error}");
                         return (ExitCodes)(-1);