Merge pull request #269 from AArnott/fix260

Remove the `g` prefix in commit IDs almost everywhere

Author: AArnott

src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs

@@ -176,7 +176,7 @@ public async Task GetBuildVersion_In_Git_But_Head_Lacks_VersionFile()
         Assumes.True(repo.Index[VersionFile.JsonFileName] == null);
         var buildResult = await this.BuildAsync();
         Assert.Equal("3.4.0." + repo.Head.Commits.First().GetIdAsVersion().Revision, buildResult.BuildVersion);
-        Assert.Equal("3.4.0+g" + repo.Head.Commits.First().Id.Sha.Substring(0, 10), buildResult.AssemblyInformationalVersion);
+        Assert.Equal("3.4.0+" + repo.Head.Commits.First().Id.Sha.Substring(0, 10), buildResult.AssemblyInformationalVersion);
     }
 
     [Fact]
@@ -201,7 +201,7 @@ public async Task GetBuildVersion_In_Git_No_VersionFile_At_All()
         repo.Commit("empty", this.Signer, this.Signer, new CommitOptions { AllowEmptyCommit = true });
         var buildResult = await this.BuildAsync();
         Assert.Equal("0.0.1." + repo.Head.Commits.First().GetIdAsVersion().Revision, buildResult.BuildVersion);
-        Assert.Equal("0.0.1+g" + repo.Head.Commits.First().Id.Sha.Substring(0, 10), buildResult.AssemblyInformationalVersion);
+        Assert.Equal("0.0.1+" + repo.Head.Commits.First().Id.Sha.Substring(0, 10), buildResult.AssemblyInformationalVersion);
     }
 
     [Fact]
@@ -915,7 +915,7 @@ private void AssertStandardProperties(VersionOptions versionOptions, BuildResult
         Version assemblyVersion = GetExpectedAssemblyVersion(versionOptions, version);
         var additionalBuildMetadata = from item in buildResult.BuildResult.ProjectStateAfterBuild.GetItems("BuildMetadata")
                                       select item.EvaluatedInclude;
-        var expectedBuildMetadata = $"+g{commitIdShort}";
+        var expectedBuildMetadata = $"+{commitIdShort}";
         if (additionalBuildMetadata.Any())
         {
             expectedBuildMetadata += "." + string.Join(".", additionalBuildMetadata);
@@ -944,7 +944,8 @@ private void AssertStandardProperties(VersionOptions versionOptions, BuildResult
 
         // NuGet is now SemVer 2.0 and will pass additional build metadata if provided
         bool semVer2 = versionOptions?.NuGetPackageVersionOrDefault.SemVer == 2;
-        string pkgVersionSuffix = buildResult.PublicRelease ? string.Empty : $"-g{commitIdShort}";
+        string semVer1CommitPrefix = semVer2 ? string.Empty : "g";
+        string pkgVersionSuffix = buildResult.PublicRelease ? string.Empty : $"-{semVer1CommitPrefix}{commitIdShort}";
         if (semVer2)
         {
             pkgVersionSuffix += expectedBuildMetadataWithoutCommitId;
@@ -965,7 +966,7 @@ private void AssertStandardProperties(VersionOptions versionOptions, BuildResult
             Assert.Equal(expectedVersion, buildNumberSemVer.Version);
             Assert.Equal(buildResult.PrereleaseVersion, buildNumberSemVer.Prerelease);
             string expectedBuildNumberMetadata = hasCommitData && commitIdOptions.WhereOrDefault == VersionOptions.CloudBuildNumberCommitWhere.BuildMetadata
-                ? $"+g{commitIdShort}"
+                ? $"+{commitIdShort}"
                 : string.Empty;
             if (additionalBuildMetadata.Any())
             {

src/NerdBank.GitVersioning.Tests/VersionOracleTests.cs

@@ -240,7 +240,7 @@ public void CanSetSemVer2ForNuGetPackageVersionNonPublicRelease()
         this.InitializeSourceControl();
         var oracle = VersionOracle.Create(this.RepoPath);
         oracle.PublicRelease = false;
-        Assert.Equal($"7.8.9-foo.25.g{this.CommitIdShort}", oracle.NuGetPackageVersion);
+        Assert.Equal($"7.8.9-foo.25.{this.CommitIdShort}", oracle.NuGetPackageVersion);
     }
 
     [Fact]

src/NerdBank.GitVersioning/VersionOracle.cs

@@ -143,7 +143,7 @@ public IEnumerable<string> BuildMetadataWithCommitId
             {
                 if (!string.IsNullOrEmpty(this.GitCommitId))
                 {
-                    yield return $"g{this.GitCommitId.Substring(0, 10)}";
+                    yield return this.GitCommitId.Substring(0, 10);
                 }
 
                 foreach (string identifier in this.BuildMetadata)
@@ -335,22 +335,22 @@ public IDictionary<string, string> CloudBuildVersionVars
         /// <summary>
         /// Gets the version to use for NuGet packages.
         /// </summary>
-        public string NuGetPackageVersion => this.VersionOptions?.NuGetPackageVersionOrDefault.SemVerOrDefault == 1 ? this.SemVer1 : this.SemVer2;
+        public string NuGetPackageVersion => this.VersionOptions?.NuGetPackageVersionOrDefault.SemVerOrDefault == 1 ? this.NuGetSemVer1 : this.SemVer2;
 
         /// <summary>
         /// Gets the version to use for NPM packages.
         /// </summary>
         public string NpmPackageVersion => this.SemVer2;
 
         /// <summary>
-        /// Gets a SemVer 1.0 compliant string that represents this version, including the -gCOMMITID suffix
+        /// Gets a SemVer 1.0 compliant string that represents this version, including the -COMMITID suffix
         /// when <see cref="PublicRelease"/> is <c>false</c>.
         /// </summary>
         public string SemVer1 =>
             $"{this.Version.ToStringSafe(3)}{this.PrereleaseVersionSemVer1}{this.SemVer1BuildMetadata}";
 
         /// <summary>
-        /// Gets a SemVer 2.0 compliant string that represents this version, including a +gCOMMITID suffix
+        /// Gets a SemVer 2.0 compliant string that represents this version, including a +COMMITID suffix
         /// when <see cref="PublicRelease"/> is <c>false</c>.
         /// </summary>
         public string SemVer2 =>
@@ -361,9 +361,31 @@ public IDictionary<string, string> CloudBuildVersionVars
         /// </summary>
         public int SemVer1NumericIdentifierPadding => this.VersionOptions?.SemVer1NumericIdentifierPaddingOrDefault ?? 4;
 
-        private string SemVer1BuildMetadata =>
+        /// <summary>
+        /// Gets the build metadata, compliant to the NuGet-compatible subset of SemVer 1.0.
+        /// </summary>
+        /// <remarks>
+        /// When adding the git commit ID in a -prerelease tag, prefix a `g` because
+        /// older NuGet clients (the ones that support only a subset of semver 1.0)
+        /// cannot handle prerelease tags that begin with a number (which a git commit ID might).
+        /// See <see href="https://github.com/AArnott/Nerdbank.GitVersioning/issues/260#issuecomment-445511898">this discussion</see>.
+        /// </remarks>
+        private string NuGetSemVer1BuildMetadata =>
             this.PublicRelease ? string.Empty : $"-g{this.GitCommitIdShort}";
 
+        /// <summary>
+        /// Gets the build metadata, compliant to SemVer 1.0.
+        /// </summary>
+        private string SemVer1BuildMetadata =>
+            this.PublicRelease ? string.Empty : this.GitCommitIdShort;
+
+        /// <summary>
+        /// Gets a SemVer 1.0 compliant string that represents this version, including the -gCOMMITID suffix
+        /// when <see cref="PublicRelease"/> is <c>false</c>.
+        /// </summary>
+        private string NuGetSemVer1 =>
+            $"{this.Version.ToStringSafe(3)}{this.PrereleaseVersionSemVer1}{this.NuGetSemVer1BuildMetadata}";
+
         /// <summary>
         /// Gets the build metadata that is appropriate for SemVer2 use.
         /// </summary>
@@ -377,7 +399,7 @@ public IDictionary<string, string> CloudBuildVersionVars
 
         private string PrereleaseVersionSemVer1 => MakePrereleaseSemVer1Compliant(this.PrereleaseVersion, this.SemVer1NumericIdentifierPadding);
 
-        private string GitCommitIdShortForNonPublicPrereleaseTag => (string.IsNullOrEmpty(this.PrereleaseVersion) ? "-" : ".") + $"g{this.GitCommitIdShort}";
+        private string GitCommitIdShortForNonPublicPrereleaseTag => (string.IsNullOrEmpty(this.PrereleaseVersion) ? "-" : ".") + this.GitCommitIdShort;
 
         private VersionOptions.CloudBuildNumberOptions CloudBuildNumberOptions { get; }