Merge pull request #355 from AArnott/fix302

Add g back as a prefix to semver2 versions

Author: AArnott

src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs

@@ -1013,8 +1013,7 @@ private void AssertStandardProperties(VersionOptions versionOptions, BuildResult
 
         string GetPkgVersionSuffix(bool useSemVer2)
         {
-            string semVer1CommitPrefix = useSemVer2 ? string.Empty : "g";
-            string pkgVersionSuffix = buildResult.PublicRelease ? string.Empty : $"-{semVer1CommitPrefix}{commitIdShort}";
+            string pkgVersionSuffix = buildResult.PublicRelease ? string.Empty : $"-g{commitIdShort}";
             if (useSemVer2)
             {
                 pkgVersionSuffix += expectedBuildMetadataWithoutCommitId;

src/NerdBank.GitVersioning.Tests/VersionOracleTests.cs

@@ -174,7 +174,7 @@ public void SemVerStableNonPublicVersion()
         var oracle = VersionOracle.Create(this.RepoPath);
         oracle.PublicRelease = false;
         Assert.Matches(@"^2.3.1-[^g]{10}$", oracle.SemVer1);
-        Assert.Matches(@"^2.3.1-[^g]{10}$", oracle.SemVer2);
+        Assert.Matches(@"^2.3.1-g[a-f0-9]{10}$", oracle.SemVer2);
         Assert.Matches(@"^2.3.1-g[a-f0-9]{10}$", oracle.NuGetPackageVersion);
         Assert.Matches(@"^2.3.1-g[a-f0-9]{10}$", oracle.ChocolateyPackageVersion);
     }
@@ -192,7 +192,7 @@ public void SemVerStableNonPublicVersionShortened()
         var oracle = VersionOracle.Create(this.RepoPath);
         oracle.PublicRelease = false;
         Assert.Matches(@"^2.3.1-[^g]{7}$", oracle.SemVer1);
-        Assert.Matches(@"^2.3.1-[^g]{7}$", oracle.SemVer2);
+        Assert.Matches(@"^2.3.1-g[a-f0-9]{7}$", oracle.SemVer2);
         Assert.Matches(@"^2.3.1-g[a-f0-9]{7}$", oracle.NuGetPackageVersion);
         Assert.Matches(@"^2.3.1-g[a-f0-9]{7}$", oracle.ChocolateyPackageVersion);
     }
@@ -275,7 +275,7 @@ public void CanSetSemVer2ForNuGetPackageVersionNonPublicRelease()
         this.InitializeSourceControl();
         var oracle = VersionOracle.Create(this.RepoPath);
         oracle.PublicRelease = false;
-        Assert.Equal($"7.8.9-foo.25.{this.CommitIdShort}", oracle.NuGetPackageVersion);
+        Assert.Equal($"7.8.9-foo.25.g{this.CommitIdShort}", oracle.NuGetPackageVersion);
     }
 
     [Fact]

src/NerdBank.GitVersioning/VersionOracle.cs

@@ -424,7 +424,14 @@ public IDictionary<string, string> CloudBuildVersionVars
 
         private string PrereleaseVersionSemVer1 => SemanticVersionExtensions.MakePrereleaseSemVer1Compliant(this.PrereleaseVersion, this.SemVer1NumericIdentifierPadding);
 
-        private string GitCommitIdShortForNonPublicPrereleaseTag => (string.IsNullOrEmpty(this.PrereleaseVersion) ? "-" : ".") + this.GitCommitIdShort;
+        /// <summary>
+        /// Gets the -gc0ffee or .gc0ffee suffix for the version.
+        /// </summary>
+        /// <remarks>
+        /// The `g` prefix to the commit ID is to remain SemVer2 compliant particularly when the partial commit ID we use is made up entirely of numerals.
+        /// SemVer2 forbids numerals to begin with leading zeros, but a git commit just might, so we begin with `g` always to avoid failures when the commit ID happens to be problematic.
+        /// </remarks>
+        private string GitCommitIdShortForNonPublicPrereleaseTag => (string.IsNullOrEmpty(this.PrereleaseVersion) ? "-" : ".") + "g" + this.GitCommitIdShort;
 
         private VersionOptions.CloudBuildNumberOptions CloudBuildNumberOptions { get; }