Merge pull request #511 from dotnet/resetVersionOffset

Reset versionHeightOffset in `nbgv prepare-release`

Author: pr-autocomplete[bot]

src/NerdBank.GitVersioning.Tests/ReleaseManagerTests.cs

@@ -552,6 +552,44 @@ public void PrepareRelease_JsonOutputWhenUpdatingReleaseBranch()
         }
     }
 
+    [Fact]
+    public void PrepareRelease_ResetsVersionHeightOffset()
+    {
+        // create and configure repository
+        this.InitializeSourceControl();
+
+        var initialVersionOptions = new VersionOptions()
+        {
+            Version = SemanticVersion.Parse("1.0-beta"),
+            VersionHeightOffset = 5,
+        };
+
+        var expectedReleaseVersionOptions = new VersionOptions()
+        {
+            Version = SemanticVersion.Parse("1.0"),
+            VersionHeightOffset = 5,
+        };
+
+        var expectedMainVersionOptions = new VersionOptions()
+        {
+            Version = SemanticVersion.Parse("1.1-alpha"),
+        };
+
+        // create version.json
+        this.WriteVersionFile(initialVersionOptions);
+
+        var tipBeforePrepareRelease = this.Repo.Head.Tip;
+
+        var releaseManager = new ReleaseManager();
+        releaseManager.PrepareRelease(this.RepoPath);
+
+        var newVersion = VersionFile.GetVersion(this.RepoPath);
+        Assert.Equal(expectedMainVersionOptions, newVersion);
+
+        var releaseVersion = VersionFile.GetVersion(this.Repo.Branches["v1.0"].Tip);
+        Assert.Equal(expectedReleaseVersionOptions, releaseVersion);
+    }
+
     protected override void InitializeSourceControl()
     {
         base.InitializeSourceControl();

src/NerdBank.GitVersioning/GitExtensions.cs

@@ -2,6 +2,7 @@
 {
     using System;
     using System.Collections.Generic;
+    using System.Globalization;
     using System.IO;
     using System.Linq;
     using System.Runtime.InteropServices;
@@ -485,6 +486,71 @@ public static Repository OpenGitRepo(string pathUnderGitRepo, bool useDefaultCon
             return gitDir == null ? null : new Repository(gitDir);
         }
 
+        /// <summary>
+        /// Tests whether two <see cref="VersionOptions" /> instances are compatible enough that version height is not reset
+        /// when progressing from one to the next.
+        /// </summary>
+        /// <param name="first">One set of version options.</param>
+        /// <param name="second">Another set of version options.</param>
+        /// <returns><c>true</c> if transitioning from one version to the next should reset the version height; <c>false</c> otherwise.</returns>
+        internal static bool WillVersionChangeResetVersionHeight(VersionOptions first, VersionOptions second)
+        {
+            Requires.NotNull(first, nameof(first));
+            Requires.NotNull(second, nameof(second));
+
+            // If the version height position moved, that's an automatic reset in version height.
+            if (first.VersionHeightPosition != second.VersionHeightPosition)
+            {
+                return true;
+            }
+
+            if (!first.VersionHeightPosition.HasValue)
+            {
+                // There's no version height anywhere, so go ahead and say it would be reset.
+                // This is useful to our `nbgv prepare-release` command to know that it can remove the version height adjustment property.
+                return true;
+            }
+
+            return WillVersionChangeResetVersionHeight(first.Version, second.Version, first.VersionHeightPosition.Value);
+        }
+
+        /// <summary>
+        /// Tests whether two <see cref="SemanticVersion" /> instances are compatible enough that version height is not reset
+        /// when progressing from one to the next.
+        /// </summary>
+        /// <param name="first">The first semantic version.</param>
+        /// <param name="second">The second semantic version.</param>
+        /// <param name="versionHeightPosition">The position within the version where height is tracked.</param>
+        /// <returns><c>true</c> if transitioning from one version to the next should reset the version height; <c>false</c> otherwise.</returns>
+        internal static bool WillVersionChangeResetVersionHeight(SemanticVersion first, SemanticVersion second, SemanticVersion.Position versionHeightPosition)
+        {
+            Requires.NotNull(first, nameof(first));
+            Requires.NotNull(second, nameof(second));
+
+            if (first == second)
+            {
+                return false;
+            }
+
+            if (versionHeightPosition == SemanticVersion.Position.Prerelease)
+            {
+                // The entire version spec must match exactly.
+                return !first.Equals(second);
+            }
+
+            for (SemanticVersion.Position position = SemanticVersion.Position.Major; position <= versionHeightPosition; position++)
+            {
+                int expectedValue = ReadVersionPosition(second.Version, position);
+                int actualValue = ReadVersionPosition(first.Version, position);
+                if (expectedValue != actualValue)
+                {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
         /// <summary>
         /// Tests whether a commit is of a specified version, comparing major and minor components
         /// with the version.txt file defined by that commit.
@@ -512,23 +578,7 @@ private static bool CommitMatchesVersion(this Commit commit, SemanticVersion exp
                 return false;
             }
 
-            if (comparisonPrecision == SemanticVersion.Position.Prerelease)
-            {
-                // The entire version spec must match exactly.
-                return semVerFromFile?.Equals(expectedVersion) ?? false;
-            }
-
-            for (SemanticVersion.Position position = SemanticVersion.Position.Major; position <= comparisonPrecision; position++)
-            {
-                int expectedValue = ReadVersionPosition(expectedVersion.Version, position);
-                int actualValue = ReadVersionPosition(semVerFromFile.Version, position);
-                if (expectedValue != actualValue)
-                {
-                    return false;
-                }
-            }
-
-            return true;
+            return !WillVersionChangeResetVersionHeight(commitVersionData.Version, expectedVersion, comparisonPrecision);
         }
 
         /// <summary>

src/NerdBank.GitVersioning/ReleaseManager.cs

@@ -337,6 +337,12 @@ private void UpdateVersion(string projectDirectory, Repository repository, Seman
 
             if (!EqualityComparer<SemanticVersion>.Default.Equals(versionOptions.Version, newVersion))
             {
+                if (versionOptions.VersionHeightPosition.HasValue && GitExtensions.WillVersionChangeResetVersionHeight(versionOptions.Version, newVersion, versionOptions.VersionHeightPosition.Value))
+                {
+                    // The version will be reset by this change, so remove the version height offset property.
+                    versionOptions.VersionHeightOffset = null;
+                }
+
                 versionOptions.Version = newVersion;
                 var filePath = VersionFile.SetVersion(projectDirectory, versionOptions, includeSchemaProperty: true);