Adjust behavior of --nextVersion parameter for prepare-release command

Previously, the value of the nextVersion parameter would completely override the version from version.json. With this change the nextVersion parameter only sets the "version part" of the next version and retains the prerelease tags from version.json respectively the firstUnstableTag setting

Author: ap0llo

doc/nbgv-cli.md

@@ -87,7 +87,7 @@ or override the version increment setting.
 To explicitly set the next version, run
 
 ```ps1
-nbgv prepare-release --nextVersion 2.0-beta
+nbgv prepare-release --nextVersion 2.0
 ```
 
 To override the `versionIncrement` setting from `version.json`, run

src/NerdBank.GitVersioning.Tests/ReleaseManagerTests.cs

@@ -11,6 +11,7 @@
 using ReleasePreparationError = Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationError;
 using ReleasePreparationException = Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException;
 using ReleaseVersionIncrement = Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement;
+using Version = System.Version;
 
 public class ReleaseManagerTests : RepoTestBase
 {
@@ -232,11 +233,11 @@ public void PrepeareRelease_ReleaseBranchWithVersionDecrement(string initialVers
     // versions without prerelease tags
     [InlineData("1.2", null, ReleaseVersionIncrement.Minor, "alpha", null, null, null, "v1.2", "1.2", "1.3-alpha")]
     [InlineData("1.2", null, ReleaseVersionIncrement.Major, "alpha", null, null, null, "v1.2", "1.2", "2.0-alpha")]
-    // explicitly set next version (firstUnstableTag setting will be ignored)
-    [InlineData("1.2-beta", null, null, null, null, "4.5", null, "v1.2", "1.2", "4.5")]
-    [InlineData("1.2-beta", null, null, null, null, "4.5-pre", null, "v1.2", "1.2", "4.5-pre")]
-    [InlineData("1.2-beta.{height}", null, null, null, null, "4.5-pre.{height}", null, "v1.2", "1.2", "4.5-pre.{height}")]
-    // explicitly set version increment overriding the setting from version.json    
+    // explicitly set next version
+    [InlineData("1.2-beta", null, null, null, null, "4.5", null, "v1.2", "1.2", "4.5-alpha")]
+    [InlineData("1.2-beta.{height}", null, null, null, null, "4.5", null, "v1.2", "1.2", "4.5-alpha.{height}")]
+    [InlineData("1.2-beta.{height}", null, null, "pre", null, "4.5.6", null, "v1.2", "1.2", "4.5.6-pre.{height}")]
+    // explicitly set version increment overriding the setting from ReleaseOptions 
     [InlineData("1.2-beta", null, ReleaseVersionIncrement.Minor, null, null, null, ReleaseVersionIncrement.Major, "v1.2", "1.2", "2.0-alpha")]
     [InlineData("1.2.3-beta", null, ReleaseVersionIncrement.Minor, null, null, null, ReleaseVersionIncrement.Build, "v1.2.3", "1.2.3", "1.2.4-alpha")]
     public void PrepareRelease_Master(
@@ -299,7 +300,7 @@ public void PrepareRelease_Master(
 
         // prepare release
         var releaseManager = new ReleaseManager();
-        releaseManager.PrepareRelease(this.RepoPath, releaseUnstableTag, (nextVersion == null ? null : SemanticVersion.Parse(nextVersion)), parameterVersionIncrement);
+        releaseManager.PrepareRelease(this.RepoPath, releaseUnstableTag, (nextVersion == null ? null : Version.Parse(nextVersion)), parameterVersionIncrement);
 
         // check if a branch was created
         Assert.Contains(this.Repo.Branches, branch => branch.FriendlyName == expectedBranchName);
@@ -375,7 +376,7 @@ public void PrepareRelease_MasterWithVersionDecrement(string initialVersion, str
         // running PrepareRelease should result in an error
         // because we're trying to add a prerelease tag to a version without prerelease tag
         this.AssertError(
-            () => new ReleaseManager().PrepareRelease(this.RepoPath, releaseUnstableTag, (nextVersion == null ? null : SemanticVersion.Parse(nextVersion))),
+            () => new ReleaseManager().PrepareRelease(this.RepoPath, releaseUnstableTag, (nextVersion == null ? null : Version.Parse(nextVersion))),
             ReleasePreparationError.VersionDecrement);
     }
 

src/NerdBank.GitVersioning/ReleaseManager.cs

@@ -3,9 +3,9 @@
     using System;
     using System.Collections.Generic;
     using System.IO;
-    using System.Linq;
     using LibGit2Sharp;
     using Validation;
+    using Version = System.Version;
     using static Nerdbank.GitVersioning.VersionOptions;
 
     /// <summary>
@@ -116,7 +116,7 @@ public ReleaseManager(TextWriter outputWriter = null, TextWriter errorWriter = n
         /// If specified, value will be used instead of the increment specified in <c>version.json</c>.
         /// Parameter will be ignored if the current branch is a release branch.
         /// </param>
-        public void PrepareRelease(string projectDirectory, string releaseUnstableTag = null, SemanticVersion nextVersion = null, ReleaseVersionIncrement? versionIncrement = null)
+        public void PrepareRelease(string projectDirectory, string releaseUnstableTag = null, Version nextVersion = null, ReleaseVersionIncrement? versionIncrement = null)
         {
             Requires.NotNull(projectDirectory, nameof(projectDirectory));            
 
@@ -142,7 +142,6 @@ public void PrepareRelease(string projectDirectory, string releaseUnstableTag =
             var releaseVersion = string.IsNullOrEmpty(releaseUnstableTag)
                 ? versionOptions.Version.WithoutPrepreleaseTags()
                 : versionOptions.Version.SetFirstPrereleaseTag(releaseUnstableTag);
-            var nextDevVersion = this.GetNextDevVersion(versionOptions, nextVersion, versionIncrement);
 
             // check if the current branch is the release branch
             if (string.Equals(originalBranchName, releaseBranchName, StringComparison.OrdinalIgnoreCase))
@@ -152,6 +151,8 @@ public void PrepareRelease(string projectDirectory, string releaseUnstableTag =
                 return;
             }
 
+            var nextDevVersion = this.GetNextDevVersion(versionOptions, nextVersion, versionIncrement);
+
             // check if the release branch already exists
             if (repository.Branches[releaseBranchName] != null)
             {
@@ -279,31 +280,38 @@ private static bool IsVersionDecrement(SemanticVersion oldVersion, SemanticVersi
             }
         }
 
-        private SemanticVersion GetNextDevVersion(VersionOptions versionOptions, SemanticVersion nextVersion, ReleaseVersionIncrement? versionIncrementOverride)
+        private SemanticVersion GetNextDevVersion(VersionOptions versionOptions, Version nextVersionOverride, ReleaseVersionIncrement? versionIncrementOverride)
         {
-            if (nextVersion != null)
-                return nextVersion;
+            var currentVersion = versionOptions.Version;
 
-            // determine the increment to use. 
-            // Use parameter if it has a value, otherwise use setting from version.json
-            var versionIncrement = versionIncrementOverride ?? versionOptions.ReleaseOrDefault.VersionIncrementOrDefault;
-
-            // 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 = versionIncrement != ReleaseVersionIncrement.Build ||
-                                   versionOptions.Version.Version.Build >= 0;
-
-            // increment is ignored when the next version was specified explicitly
-            if (!isValidIncrement)
+            SemanticVersion nextDevVersion;
+            if(nextVersionOverride != null)
             {
-                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);
+                nextDevVersion = new SemanticVersion(nextVersionOverride, currentVersion.Prerelease, currentVersion.BuildMetadata);
+            }
+            else
+            {
+                // determine the increment to use. 
+                // Use parameter if it has a value, otherwise use setting from version.json
+                var versionIncrement = versionIncrementOverride ?? versionOptions.ReleaseOrDefault.VersionIncrementOrDefault;
+
+                // 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 = versionIncrement != 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);
+                }
+
+                nextDevVersion = currentVersion.Increment(versionIncrement);
             }
 
-            return versionOptions.Version
-                        .Increment(versionIncrement)
-                        .SetFirstPrereleaseTag(versionOptions.ReleaseOrDefault.FirstUnstableTagOrDefault);
+            return nextDevVersion.SetFirstPrereleaseTag(versionOptions.ReleaseOrDefault.FirstUnstableTagOrDefault);
         }
     }
 }

src/nbgv/Program.cs

@@ -592,12 +592,12 @@ private static ExitCodes OnPrepareReleaseCommand(string projectPath, string prer
             }
 
             // parse nextVersion if parameter was specified
-            SemanticVersion nextVersionParsed = default;
+            Version nextVersionParsed = default;
             if (!string.IsNullOrEmpty(nextVersion))
             {
-                if (!SemanticVersion.TryParse(nextVersion, out nextVersionParsed))
+                if (!Version.TryParse(nextVersion, out nextVersionParsed))
                 {
-                    Console.Error.WriteLine($"\"{nextVersion}\" is not a semver-compliant version spec.");
+                    Console.Error.WriteLine($"\"{nextVersion}\" is not a valid version spec.");
                     return ExitCodes.InvalidVersionSpec;
                 }
             }