Move tag name option to release object

Author: ronaldbarendse

src/NerdBank.GitVersioning/VersionOptions.cs

@@ -46,11 +46,6 @@ 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>
@@ -114,12 +109,6 @@ 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>
@@ -164,7 +153,6 @@ 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();
     }
 
@@ -484,22 +472,6 @@ 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.
@@ -1470,7 +1442,7 @@ public int GetHashCode(CloudBuildNumberCommitIdOptions? obj)
     }
 
     /// <summary>
-    /// Encapsulates settings for the "prepare-release" command.
+    /// Encapsulates settings for the "prepare-release" and "tag" commands.
     /// </summary>
     public class ReleaseOptions : IEquatable<ReleaseOptions>
     {
@@ -1480,6 +1452,7 @@ public class ReleaseOptions : IEquatable<ReleaseOptions>
         internal static readonly ReleaseOptions DefaultInstance = new ReleaseOptions()
         {
             isFrozen = true,
+            tagName = "v{version}",
             branchName = "v{version}",
             versionIncrement = ReleaseVersionIncrement.Minor,
             firstUnstableTag = "alpha",
@@ -1488,6 +1461,9 @@ public class ReleaseOptions : IEquatable<ReleaseOptions>
         [DebuggerBrowsable(DebuggerBrowsableState.Never)]
         private bool isFrozen;
 
+        [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+        private string? tagName;
+
         [DebuggerBrowsable(DebuggerBrowsableState.Never)]
         private string? branchName;
 
@@ -1510,11 +1486,28 @@ public ReleaseOptions()
         /// <param name="copyFrom">The existing instance to copy from.</param>
         public ReleaseOptions(ReleaseOptions copyFrom)
         {
+            this.tagName = copyFrom.tagName;
             this.branchName = copyFrom.branchName;
             this.versionIncrement = copyFrom.versionIncrement;
             this.firstUnstableTag = copyFrom.firstUnstableTag;
         }
 
+        /// <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 ?? DefaultInstance.TagName!;
+
         /// <summary>
         /// Gets or sets the branch name template for release branches.
         /// </summary>
@@ -1526,7 +1519,7 @@ public string? BranchName
         }
 
         /// <summary>
-        /// Gets the set branch name template for release branches.
+        /// Gets the branch name template for release branches.
         /// </summary>
         [JsonIgnore]
         public string BranchNameOrDefault => this.BranchName ?? DefaultInstance.BranchName!;
@@ -1621,7 +1614,8 @@ public bool Equals(ReleaseOptions? x, ReleaseOptions? y)
                     return false;
                 }
 
-                return StringComparer.Ordinal.Equals(x.BranchNameOrDefault, y.BranchNameOrDefault) &&
+                return StringComparer.Ordinal.Equals(x.TagNameOrDefault, y.TagNameOrDefault) &&
+                       StringComparer.Ordinal.Equals(x.BranchNameOrDefault, y.BranchNameOrDefault) &&
                        x.VersionIncrementOrDefault == y.VersionIncrementOrDefault &&
                        StringComparer.Ordinal.Equals(x.FirstUnstableTagOrDefault, y.FirstUnstableTagOrDefault);
             }
@@ -1636,7 +1630,8 @@ public int GetHashCode(ReleaseOptions? obj)
 
                 unchecked
                 {
-                    int hash = StringComparer.Ordinal.GetHashCode(obj.BranchNameOrDefault) * 397;
+                    int hash = StringComparer.Ordinal.GetHashCode(obj.TagNameOrDefault) * 397;
+                    hash ^= StringComparer.Ordinal.GetHashCode(obj.BranchNameOrDefault);
                     hash ^= (int)obj.VersionIncrementOrDefault;
                     hash ^= StringComparer.Ordinal.GetHashCode(obj.FirstUnstableTagOrDefault);
                     return hash;

src/NerdBank.GitVersioning/VersionOptionsContractResolver.cs

@@ -126,6 +126,11 @@ protected override JsonProperty CreateProperty(MemberInfo member, MemberSerializ
                 property.ShouldSerialize = instance => !((VersionOptions)instance).ReleaseOrDefault.IsDefault;
             }
 
+            if (property.DeclaringType == typeof(VersionOptions.ReleaseOptions) && member.Name == nameof(VersionOptions.ReleaseOptions.TagName))
+            {
+                property.ShouldSerialize = instance => ((VersionOptions.ReleaseOptions)instance).TagNameOrDefault != VersionOptions.ReleaseOptions.DefaultInstance.TagName;
+            }
+
             if (property.DeclaringType == typeof(VersionOptions.ReleaseOptions) && member.Name == nameof(VersionOptions.ReleaseOptions.BranchName))
             {
                 property.ShouldSerialize = instance => ((VersionOptions.ReleaseOptions)instance).BranchNameOrDefault != VersionOptions.ReleaseOptions.DefaultInstance.BranchName;

src/NerdBank.GitVersioning/version.schema.json

@@ -119,7 +119,7 @@
         },
         "publicReleaseRefSpec": {
           "type": "array",
-          "description": "An array of regular expressions that may match a ref (branch or tag) that should be built with PublicRelease=true as the default value. The ref matched against is in its canonical form (e.g. refs/heads/master)",
+          "description": "An array of regular expressions that may match a ref (branch or tag) that should be built with PublicRelease=true as the default value. The ref matched against is in its canonical form (e.g. refs/heads/master).",
           "items": {
             "type": "string",
             "format": "regex"
@@ -128,12 +128,12 @@
         },
         "cloudBuild": {
           "type": "object",
-          "description": "Options that are applicable specifically to cloud builds (e.g. VSTS, AppVeyor, TeamCity)",
+          "description": "Options that are applicable specifically to cloud builds (e.g. VSTS, AppVeyor, TeamCity).",
           "properties": {
             "setAllVariables": {
               "type": "boolean",
               "default": false,
-              "description": "Elevates all build properties to cloud build variables prefaced with \"NBGV_\""
+              "description": "Elevates all build properties to cloud build variables prefaced with \"NBGV_\"."
             },
             "setVersionVariables": {
               "type": "boolean",
@@ -172,13 +172,19 @@
           }
         },
         "release": {
-          "description": "Settings for the prepare-release command",
+          "description": "Settings for the prepare-release and tag commands.",
           "type": "object",
           "properties": {
+            "tagName": {
+              "description": "Defines the format of tag names. Format must include a placeholder '{version}' for the version.",
+              "type": "string",
+              "pattern": "\\{version\\}",
+              "default": "v{version}"
+            },
             "branchName": {
               "description": "Defines the format of release branch names. Format must include a placeholder '{version}' for the version.",
               "type": "string",
-              "pattern": ".*\\{version\\}.*",
+              "pattern": "\\{version\\}",
               "default": "v{version}"
             },
             "versionIncrement": {
@@ -195,12 +201,6 @@
           },
           "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.",

src/nbgv/Program.cs

@@ -554,7 +554,7 @@ private static Task<int> OnTagCommand(string project, string versionOrRef)
                 return Task.FromResult((int)ExitCodes.NoVersionJsonFound);
             }
 
-            string tagNameFormat = versionOptions.TagNameOrDefault;
+            string tagNameFormat = versionOptions.ReleaseOrDefault.TagNameOrDefault;
 
             // ensure there is a '{version}' placeholder in the tag name
             if (string.IsNullOrEmpty(tagNameFormat) || !tagNameFormat.Contains("{version}"))