Add tag name option

Author: ronaldbarendse

src/NerdBank.GitVersioning/VersionOptions.cs

@@ -46,6 +46,11 @@ public class VersionOptions : IEquatable<VersionOptions>
     /// </summary>
     private const int DefaultSemVer1NumericIdentifierPadding = 4;
 
+    /// <summary>
+    /// The default value for the <see cref="TagName"/> property.
+    /// </summary>
+    private const string DefaultTagName = "v{version}";
+
     /// <summary>
     /// A value indicating whether mutations of this instance are not allowed.
     /// </summary>
@@ -109,6 +114,12 @@ public class VersionOptions : IEquatable<VersionOptions>
     [DebuggerBrowsable(DebuggerBrowsableState.Never)]
     private CloudBuildOptions? cloudBuild;
 
+    /// <summary>
+    /// Backing field for the <see cref="TagName"/> property.
+    /// </summary>
+    [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+    private string? tagName;
+
     /// <summary>
     /// Backing field for the <see cref="Release"/> property.
     /// </summary>
@@ -153,6 +164,7 @@ public VersionOptions(VersionOptions copyFrom)
         this.publicReleaseRefSpec = copyFrom.publicReleaseRefSpec?.ToList();
         this.cloudBuild = copyFrom.cloudBuild is object ? new CloudBuildOptions(copyFrom.cloudBuild) : null;
         this.release = copyFrom.release is object ? new ReleaseOptions(copyFrom.release) : null;
+        this.tagName = copyFrom.tagName;
         this.pathFilters = copyFrom.pathFilters?.ToList();
     }
 
@@ -472,6 +484,22 @@ public ReleaseOptions? Release
     [JsonIgnore]
     public ReleaseOptions ReleaseOrDefault => this.Release ?? ReleaseOptions.DefaultInstance;
 
+    /// <summary>
+    /// Gets or sets the tag name template for tagging.
+    /// </summary>
+    [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+    public string? TagName
+    {
+        get => this.tagName;
+        set => this.SetIfNotReadOnly(ref this.tagName, value);
+    }
+
+    /// <summary>
+    /// Gets the tag name template for tagging.
+    /// </summary>
+    [JsonIgnore]
+    public string? TagNameOrDefault => this.TagName ?? DefaultTagName;
+
     /// <summary>
     /// Gets or sets a list of paths to use to filter commits when calculating version height.
     /// If a given commit does not affect any paths in this filter, it is ignored for version height calculations.

src/NerdBank.GitVersioning/version.schema.json

@@ -176,7 +176,7 @@
           "type": "object",
           "properties": {
             "branchName": {
-              "description": "Defines the format of release branch names. Format must include a placeholder '{version}' for the version",
+              "description": "Defines the format of release branch names. Format must include a placeholder '{version}' for the version.",
               "type": "string",
               "pattern": ".*\\{version\\}.*",
               "default": "v{version}"
@@ -188,13 +188,19 @@
               "default": "minor"
             },
             "firstUnstableTag": {
-              "description": "Specifies the first/default prerelease tag for new versions",
+              "description": "Specifies the first/default prerelease tag for new versions.",
               "type": "string",
               "default": "alpha"
             }
           },
           "additionalProperties": false
         },
+        "tagName": {
+          "description": "Defines the format of tag names. Format must include a placeholder '{version}' for the version.",
+          "type": "string",
+          "pattern": ".*\\{version\\}.*",
+          "default": "v{version}"
+        },
         "pathFilters": {
           "type": "array",
           "description": "An array of pathspec-like strings that are used to filter commits when calculating the version height. A commit will not increment the version height if its changed files are not included by these filters.\nPaths are relative to this file. Paths relative to the root of the repository can be specified with the `:/` prefix.\nExclusions can be specified with a `:^` prefix for relative paths, or a `:^/` prefix for paths relative to the root of the repository.\nAfter a path matches any non-exclude filter, it will be run through all exclude filters. If it matches, the path is ignored.",