Add GitCommitIdPrefix

Author: vchirikov

src/NerdBank.GitVersioning.Tests/VersionFileTests.cs

@@ -146,6 +146,7 @@ public void SetVersion_WritesSimplestFile(string version, string assemblyVersion
     [InlineData(@"{""release"":{""increment"":""minor""}}", @"{}")]
     [InlineData(@"{""release"":{""branchName"":""v{version}""}}", @"{}")]
     [InlineData(@"{""release"":{""firstUnstableTag"":""alpha""}}", @"{}")]
+    [InlineData(@"{""release"":{""gitCommitIdPrefix"":""g""}}", @"{}")]
     [InlineData(@"{""release"":{""firstUnstableTag"":""tag""}}", @"{""release"":{""firstUnstableTag"":""tag""}}")]
     [InlineData(@"{""release"":{""branchName"":""v{version}"",""versionIncrement"":""minor"",""firstUnstableTag"":""alpha""}}", @"{}")]
     [InlineData(@"{""release"":{""versionIncrement"":""major""}}", @"{""release"":{""versionIncrement"":""major""}}")]

src/NerdBank.GitVersioning.Tests/VersionOracleTests.cs

@@ -313,6 +313,26 @@ public void CanSetSemVer2ForNuGetPackageVersionNonPublicRelease()
         Assert.Equal($"7.8.9-foo.25.g{this.CommitIdShort}", oracle.NuGetPackageVersion);
     }
 
+    [Fact]
+    public void CanSetGitCommitIdPrefixNonPublicRelease()
+    {
+        VersionOptions workingCopyVersion = new VersionOptions
+        {
+            Version = SemanticVersion.Parse("7.8.9-foo.25"),
+            NuGetPackageVersion = new VersionOptions.NuGetPackageVersionOptions
+            {
+                SemVer = 2,
+            },
+            GitCommitIdPrefix = "git"
+
+        };
+        this.WriteVersionFile(workingCopyVersion);
+        this.InitializeSourceControl();
+        var oracle = VersionOracle.Create(this.RepoPath);
+        oracle.PublicRelease = false;
+        Assert.Equal($"7.8.9-foo.25.git{this.CommitIdShort}", oracle.NuGetPackageVersion);
+    }
+
     [Fact]
     public void CanUseGitProjectRelativePathWithGitRepoRoot()
     {

src/NerdBank.GitVersioning/VersionOptions.cs

@@ -60,6 +60,14 @@ public class VersionOptions : IEquatable<VersionOptions>
         [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
         public AssemblyVersionOptions AssemblyVersion { get; set; }
 
+        /// <summary>
+        /// Gets or sets the prefix for git commit id in version.
+        /// If <c>null</c> 'g' will be used.
+        /// </summary>
+        /// <value>A prefix for git commit id.</value>
+        [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+        public string GitCommitIdPrefix { get; set; }
+
         /// <summary>
         /// Gets the version to use particularly for the <see cref="AssemblyVersionAttribute"/>
         /// instead of the default <see cref="Version"/>.

src/NerdBank.GitVersioning/VersionOracle.cs

@@ -409,7 +409,7 @@ public IDictionary<string, string> CloudBuildVersionVars
         /// See <see href="https://github.com/dotnet/Nerdbank.GitVersioning/issues/260#issuecomment-445511898">this discussion</see>.
         /// </remarks>
         private string NuGetSemVer1BuildMetadata =>
-            this.PublicRelease ? string.Empty : $"-g{this.GitCommitIdShort}";
+            this.PublicRelease ? string.Empty : $"-{this.VersionOptions?.GitCommitIdPrefix ?? "g"}{this.GitCommitIdShort}";
 
         /// <summary>
         /// Gets the build metadata, compliant to SemVer 1.0.
@@ -418,7 +418,7 @@ public IDictionary<string, string> CloudBuildVersionVars
             this.PublicRelease ? string.Empty : $"-{this.GitCommitIdShort}";
 
         /// <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 -{GitCommitIdPrefix}COMMITID suffix
         /// when <see cref="PublicRelease"/> is <c>false</c>.
         /// </summary>
         private string NuGetSemVer1 =>
@@ -438,13 +438,13 @@ public IDictionary<string, string> CloudBuildVersionVars
         private string PrereleaseVersionSemVer1 => SemanticVersionExtensions.MakePrereleaseSemVer1Compliant(this.PrereleaseVersion, this.SemVer1NumericIdentifierPadding);
 
         /// <summary>
-        /// Gets the -gc0ffee or .gc0ffee suffix for the version.
+        /// Gets the -{<seealso cref="VersionOptions.GitCommitIdPrefix"/>}c0ffee or .<seealso cref="VersionOptions.GitCommitIdPrefix"/>c0ffee 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.
+        /// The 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 prefix always to avoid failures when the commit ID happens to be problematic.
         /// </remarks>
-        private string GitCommitIdShortForNonPublicPrereleaseTag => (string.IsNullOrEmpty(this.PrereleaseVersion) ? "-" : ".") + "g" + this.GitCommitIdShort;
+        private string GitCommitIdShortForNonPublicPrereleaseTag => (string.IsNullOrEmpty(this.PrereleaseVersion) ? "-" : ".") + (this.VersionOptions?.GitCommitIdPrefix ?? "g") + this.GitCommitIdShort;
 
         private VersionOptions.CloudBuildNumberOptions CloudBuildNumberOptions { get; }
 

src/NerdBank.GitVersioning/version.schema.json

@@ -79,6 +79,12 @@
           "default": 10,
           "maximum": 40
         },
+        "gitCommitIdPrefix": {
+          "type": "string",
+          "description": "The git commit prefix (e.g. 'g') in prerelease versions",
+          "pattern": "^[^0-9][\\da-z\\-_\\.]*$",
+          "default": "g"
+        },
         "gitCommitIdShortAutoMinimum": {
           "type": "integer",
           "description": "When greater than 0, the length of the commit ID will be either this value or the shortest unambiguous git-abbreviated commit ID possible, whichever is greater. When 0, the gitCommitIdShortFixedLength property is used instead.",