refactors tag prefix configuration

arturcic · arturcic · commit ea95b5b7a759 · 2025-11-12T12:22:31.000+01:00
Renames `TagPrefix` to `TagPrefixPattern` for clarity.
diff --git a/src/GitVersion.Core.Tests/MergeMessageTests.cs b/src/GitVersion.Core.Tests/MergeMessageTests.cs
@@ -35,10 +35,10 @@ public void EmptyTagPrefix(string? prefix)
     {
         // Arrange
         const string message = "Updated some code.";
-        var configuration = GitHubFlowConfigurationBuilder.New.WithTagPrefixPattern(prefix).Build();
+        var configurationBuilder = GitHubFlowConfigurationBuilder.New.WithTagPrefixPattern(prefix);
 
         // Act
-        var sut = new MergeMessage(message, configuration);
+        var sut = new MergeMessage(message, configurationBuilder.Build());
 
         // Assert
         sut.TargetBranch.ShouldBeNull();
diff --git a/src/GitVersion.Core/Configuration/EffectiveConfiguration.cs b/src/GitVersion.Core/Configuration/EffectiveConfiguration.cs
@@ -52,7 +52,7 @@ public EffectiveConfiguration(
         AssemblyVersioningFormat = configuration.AssemblyVersioningFormat;
         AssemblyFileVersioningFormat = configuration.AssemblyFileVersioningFormat;
         DeploymentMode = branchConfiguration.DeploymentMode.Value;
-        TagPrefix = configuration.TagPrefixPattern;
+        TagPrefixPattern = configuration.TagPrefixPattern;
         VersionInBranchPattern = configuration.VersionInBranchPattern;
         Label = branchConfiguration.Label;
         NextVersion = configuration.NextVersion;
@@ -90,7 +90,7 @@ public EffectiveConfiguration(
     public string? AssemblyVersioningFormat { get; }
     public string? AssemblyFileVersioningFormat { get; }
 
-    public string? TagPrefix { get; }
+    public string? TagPrefixPattern { get; }
 
     public string? VersionInBranchPattern { get; }
 
diff --git a/src/GitVersion.Core/Extensions/ReferenceNameExtensions.cs b/src/GitVersion.Core/Extensions/ReferenceNameExtensions.cs
@@ -6,16 +6,16 @@ namespace GitVersion.Configuration;
 
 public static class ReferenceNameExtensions
 {
-    public static bool TryGetSemanticVersion(this ReferenceName source, out (SemanticVersion Value, string? Name) result, EffectiveConfiguration configuration)
-        => source.TryGetSemanticVersion(out result, configuration.VersionInBranchPattern, configuration.TagPrefix, configuration.SemanticVersionFormat);
+    public static bool TryGetSemanticVersion(this ReferenceName source, EffectiveConfiguration configuration, out (SemanticVersion Value, string? Name) result)
+        => source.TryGetSemanticVersion(configuration.VersionInBranchPattern, configuration.TagPrefixPattern, configuration.SemanticVersionFormat, out result);
 
-    public static bool TryGetSemanticVersion(this ReferenceName source, out (SemanticVersion Value, string? Name) result, IGitVersionConfiguration configuration)
-        => source.TryGetSemanticVersion(out result, configuration.VersionInBranchPattern, configuration.TagPrefixPattern, configuration.SemanticVersionFormat);
+    public static bool TryGetSemanticVersion(this ReferenceName source, IGitVersionConfiguration configuration, out (SemanticVersion Value, string? Name) result)
+        => source.TryGetSemanticVersion(configuration.VersionInBranchPattern, configuration.TagPrefixPattern, configuration.SemanticVersionFormat, out result);
 
-    private static bool TryGetSemanticVersion(this ReferenceName referenceName, out (SemanticVersion Value, string? Name) result,
-                                              string? versionPatternPattern,
-                                              string? tagPrefix,
-                                              SemanticVersionFormat format)
+    private static bool TryGetSemanticVersion(this ReferenceName referenceName,
+                                             string? versionPatternPattern,
+                                             string? tagPrefix,
+                                             SemanticVersionFormat format, out (SemanticVersion Value, string? Name) result)
     {
         var versionPatternRegex = RegexPatterns.Cache.GetOrAdd(GetVersionInBranchPattern(versionPatternPattern));
         result = default;
diff --git a/src/GitVersion.Core/MergeMessage.cs b/src/GitVersion.Core/MergeMessage.cs
@@ -53,7 +53,7 @@ public MergeMessage(string mergeMessage, IGitVersionConfiguration configuration)
                 PullRequestNumber = pullNumber;
             }
 
-            Version = MergedBranch?.TryGetSemanticVersion(out var result, configuration) == true ? result.Value : null;
+            Version = MergedBranch?.TryGetSemanticVersion(configuration, out var result) == true ? result.Value : null;
 
             break;
         }
diff --git a/src/GitVersion.Core/PublicAPI.Unshipped.txt b/src/GitVersion.Core/PublicAPI.Unshipped.txt
@@ -1,4 +1,5 @@
 #nullable enable
+GitVersion.Configuration.EffectiveConfiguration.TagPrefixPattern.get -> string?
 GitVersion.Extensions.AssemblyVersionsGeneratorExtensions.extension(GitVersion.SemanticVersion!)
 GitVersion.Extensions.AssemblyVersionsGeneratorExtensions.extension(GitVersion.SemanticVersion!).GetAssemblyFileVersion(GitVersion.Configuration.AssemblyFileVersioningScheme scheme) -> string?
 GitVersion.Extensions.AssemblyVersionsGeneratorExtensions.extension(GitVersion.SemanticVersion!).GetAssemblyVersion(GitVersion.Configuration.AssemblyVersioningScheme scheme) -> string?
@@ -42,6 +43,9 @@ GitVersion.Logging.LogExtensions.extension(GitVersion.Logging.ILog!).Warning(Git
 GitVersion.Logging.LogExtensions.extension(GitVersion.Logging.ILog!).Warning(GitVersion.Logging.Verbosity verbosity, GitVersion.Logging.LogAction! logAction) -> void
 GitVersion.Logging.LogExtensions.extension(GitVersion.Logging.ILog!).Warning(GitVersion.Logging.Verbosity verbosity, string! format, params object?[]! args) -> void
 GitVersion.Logging.LogExtensions.extension(GitVersion.Logging.ILog!).Warning(string! format, params object?[]! args) -> void
+static GitVersion.Configuration.ReferenceNameExtensions.TryGetSemanticVersion(this GitVersion.Git.ReferenceName! referenceName, string? versionPatternPattern, string? tagPrefix, GitVersion.SemanticVersionFormat format, out (GitVersion.SemanticVersion! Value, string? Name) result) -> bool
+static GitVersion.Configuration.ReferenceNameExtensions.TryGetSemanticVersion(this GitVersion.Git.ReferenceName! source, GitVersion.Configuration.EffectiveConfiguration! configuration, out (GitVersion.SemanticVersion! Value, string? Name) result) -> bool
+static GitVersion.Configuration.ReferenceNameExtensions.TryGetSemanticVersion(this GitVersion.Git.ReferenceName! source, GitVersion.Configuration.IGitVersionConfiguration! configuration, out (GitVersion.SemanticVersion! Value, string? Name) result) -> bool
 static GitVersion.Extensions.FileSystemExtensions.FindGitDir(this System.IO.Abstractions.IFileSystem! fileSystem, string? path) -> (string! GitDirectory, string! WorkingTreeDirectory)?
 static GitVersion.Logging.LogExtensions.Debug(this GitVersion.Logging.ILog! log, GitVersion.Logging.Verbosity verbosity, string! format, params object?[]! args) -> void
 static GitVersion.Logging.LogExtensions.Debug(this GitVersion.Logging.ILog! log, string! format, params object?[]! args) -> void
diff --git a/src/GitVersion.Core/VersionCalculation/IncrementStrategyFinder.cs b/src/GitVersion.Core/VersionCalculation/IncrementStrategyFinder.cs
@@ -73,7 +73,7 @@ public VersionField DetermineIncrementedField(
         }
 
         IEnumerable<ICommit> commits = GetCommitHistory(
-            tagPrefix: configuration.TagPrefix,
+            tagPrefix: configuration.TagPrefixPattern,
             semanticVersionFormat: configuration.SemanticVersionFormat,
             baseVersionSource: baseVersionSource,
             currentCommit: currentCommit,
diff --git a/src/GitVersion.Core/VersionCalculation/Mainline/NonTrunk/FirstCommitOnRelease.cs b/src/GitVersion.Core/VersionCalculation/Mainline/NonTrunk/FirstCommitOnRelease.cs
@@ -30,7 +30,7 @@ public IEnumerable<IBaseVersionIncrement> GetIncrements(
         MainlineIteration iteration, MainlineCommit commit, MainlineContext context)
     {
         var effectiveConfiguration = commit.GetEffectiveConfiguration(context.Configuration);
-        if (!commit.BranchName.TryGetSemanticVersion(out var element, effectiveConfiguration)) yield break;
+        if (!commit.BranchName.TryGetSemanticVersion(effectiveConfiguration, out var element)) yield break;
         context.AlternativeSemanticVersions.Add(element.Value);
     }
 }
diff --git a/src/GitVersion.Core/VersionCalculation/Mainline/Trunk/CommitOnTrunkBranchedBase.cs b/src/GitVersion.Core/VersionCalculation/Mainline/Trunk/CommitOnTrunkBranchedBase.cs
@@ -17,7 +17,7 @@ public virtual IEnumerable<IBaseVersionIncrement> GetIncrements(
 
         var effectiveConfiguration = iteration.GetEffectiveConfiguration(context.Configuration);
         if (iteration.GetEffectiveConfiguration(context.Configuration).IsReleaseBranch
-            && iteration.BranchName.TryGetSemanticVersion(out var element, effectiveConfiguration))
+            && iteration.BranchName.TryGetSemanticVersion(effectiveConfiguration, out var element))
         {
             context.AlternativeSemanticVersions.Add(element.Value);
         }
diff --git a/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/VersionInBranchNameVersionStrategy.cs b/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/VersionInBranchNameVersionStrategy.cs
@@ -35,7 +35,7 @@ public bool TryGetBaseVersion(EffectiveBranchConfiguration configuration, [NotNu
 
         foreach (var branch in new[] { Context.CurrentBranch, configuration.Branch })
         {
-            if (!branch.Name.TryGetSemanticVersion(out var result, configuration.Value)) continue;
+            if (!branch.Name.TryGetSemanticVersion(configuration.Value, out var result)) continue;
             string? branchNameOverride = null;
             if (!result.Name.IsNullOrEmpty() && (Context.CurrentBranch.Name.Equals(branch.Name)
                                                  || Context.Configuration.GetBranchConfiguration(Context.CurrentBranch.Name).Label is null))

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public MergeMessage(string mergeMessage, IGitVersionConfiguration configuration)`
`53`	`53`	`PullRequestNumber = pullNumber;`
`54`	`54`	`}`
`55`	`55`
`56`		`- Version = MergedBranch?.TryGetSemanticVersion(out var result, configuration) == true ? result.Value : null;`
	`56`	`+ Version = MergedBranch?.TryGetSemanticVersion(configuration, out var result) == true ? result.Value : null;`
`57`	`57`
`58`	`58`	`break;`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public VersionField DetermineIncrementedField(`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`IEnumerable<ICommit> commits = GetCommitHistory(`
`76`		`- tagPrefix: configuration.TagPrefix,`
	`76`	`+ tagPrefix: configuration.TagPrefixPattern,`
`77`	`77`	`semanticVersionFormat: configuration.SemanticVersionFormat,`
`78`	`78`	`baseVersionSource: baseVersionSource,`
`79`	`79`	`currentCommit: currentCommit,`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public IEnumerable<IBaseVersionIncrement> GetIncrements(`
`30`	`30`	`MainlineIteration iteration, MainlineCommit commit, MainlineContext context)`
`31`	`31`	`{`
`32`	`32`	`var effectiveConfiguration = commit.GetEffectiveConfiguration(context.Configuration);`
`33`		`- if (!commit.BranchName.TryGetSemanticVersion(out var element, effectiveConfiguration)) yield break;`
	`33`	`+ if (!commit.BranchName.TryGetSemanticVersion(effectiveConfiguration, out var element)) yield break;`
`34`	`34`	`context.AlternativeSemanticVersions.Add(element.Value);`
`35`	`35`	`}`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public virtual IEnumerable<IBaseVersionIncrement> GetIncrements(`
`17`	`17`
`18`	`18`	`var effectiveConfiguration = iteration.GetEffectiveConfiguration(context.Configuration);`
`19`	`19`	`if (iteration.GetEffectiveConfiguration(context.Configuration).IsReleaseBranch`
`20`		`- && iteration.BranchName.TryGetSemanticVersion(out var element, effectiveConfiguration))`
	`20`	`+ && iteration.BranchName.TryGetSemanticVersion(effectiveConfiguration, out var element))`
`21`	`21`	`{`
`22`	`22`	`context.AlternativeSemanticVersions.Add(element.Value);`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public bool TryGetBaseVersion(EffectiveBranchConfiguration configuration, [NotNu`
`35`	`35`
`36`	`36`	`foreach (var branch in new[] { Context.CurrentBranch, configuration.Branch })`
`37`	`37`	`{`
`38`		`- if (!branch.Name.TryGetSemanticVersion(out var result, configuration.Value)) continue;`
	`38`	`+ if (!branch.Name.TryGetSemanticVersion(configuration.Value, out var result)) continue;`
`39`	`39`	`string? branchNameOverride = null;`
`40`	`40`	`if (!result.Name.IsNullOrEmpty() && (Context.CurrentBranch.Name.Equals(branch.Name)`
`41`	`41`	`\|\| Context.Configuration.GetBranchConfiguration(Context.CurrentBranch.Name).Label is null))`