refactor: add VersionIncrementSourceType to distinguish between version increment strategies

roeil · roeil · commit a3003ef5f66e · 2025-03-14T09:39:48.000+02:00
diff --git a/src/GitVersion.Core/PublicAPI.Shipped.txt b/src/GitVersion.Core/PublicAPI.Shipped.txt
@@ -600,7 +600,6 @@ GitVersion.Settings.OnlyTrackedBranches -> bool
 GitVersion.VersionCalculation.BaseVersion
 GitVersion.VersionCalculation.BaseVersion.BaseVersion() -> void
 GitVersion.VersionCalculation.BaseVersion.BaseVersion(GitVersion.VersionCalculation.BaseVersionOperand! Operand) -> void
-GitVersion.VersionCalculation.BaseVersion.BaseVersion(string! source, GitVersion.SemanticVersion! semanticVersion, GitVersion.Git.ICommit? baseVersionSource = null) -> void
 GitVersion.VersionCalculation.BaseVersion.BaseVersionSource.get -> GitVersion.Git.ICommit?
 GitVersion.VersionCalculation.BaseVersion.GetIncrementedVersion() -> GitVersion.SemanticVersion!
 GitVersion.VersionCalculation.BaseVersion.Operand.get -> GitVersion.VersionCalculation.BaseVersionOperand!
@@ -612,7 +611,6 @@ GitVersion.VersionCalculation.BaseVersion.ShouldIncrement.get -> bool
 GitVersion.VersionCalculation.BaseVersion.Source.get -> string!
 GitVersion.VersionCalculation.BaseVersionOperand
 GitVersion.VersionCalculation.BaseVersionOperand.BaseVersionOperand() -> void
-GitVersion.VersionCalculation.BaseVersionOperand.BaseVersionOperand(string! Source, GitVersion.SemanticVersion! SemanticVersion, GitVersion.Git.ICommit? BaseVersionSource = null) -> void
 GitVersion.VersionCalculation.BaseVersionOperand.BaseVersionSource.get -> GitVersion.Git.ICommit?
 GitVersion.VersionCalculation.BaseVersionOperand.BaseVersionSource.init -> void
 GitVersion.VersionCalculation.BaseVersionOperand.SemanticVersion.get -> GitVersion.SemanticVersion!
diff --git a/src/GitVersion.Core/PublicAPI.Unshipped.txt b/src/GitVersion.Core/PublicAPI.Unshipped.txt
@@ -3,3 +3,16 @@ GitVersion.Configuration.EffectiveConfiguration.EffectiveConfiguration(GitVersio
 GitVersion.Configuration.EffectiveConfiguration.VersionFilters.get -> System.Collections.Generic.IEnumerable<GitVersion.VersionCalculation.IVersionFilter!>!
 GitVersion.Configuration.IIgnoreConfiguration.Paths.get -> System.Collections.Generic.IReadOnlyCollection<string!>!
 GitVersion.Git.IGitRepository.FindPatchPaths(GitVersion.Git.ICommit! commit, string? tagPrefix) -> System.Collections.Generic.IEnumerable<string!>?
+GitVersion.VersionCalculation.BaseVersion.BaseVersion(string! source, GitVersion.SemanticVersion! semanticVersion, GitVersion.Git.ICommit? baseVersionSource = null, GitVersion.VersionCalculation.VersionIncrementSourceType sourceType = GitVersion.VersionCalculation.VersionIncrementSourceType.Tree) -> void
+GitVersion.VersionCalculation.BaseVersion.SourceType.get -> GitVersion.VersionCalculation.VersionIncrementSourceType
+GitVersion.VersionCalculation.BaseVersion.SourceType.init -> void
+GitVersion.VersionCalculation.BaseVersionOperand.BaseVersionOperand(string! Source, GitVersion.SemanticVersion! SemanticVersion, GitVersion.Git.ICommit? BaseVersionSource = null, GitVersion.VersionCalculation.VersionIncrementSourceType SourceType = GitVersion.VersionCalculation.VersionIncrementSourceType.Tree) -> void
+GitVersion.VersionCalculation.BaseVersionOperand.SourceType.get -> GitVersion.VersionCalculation.VersionIncrementSourceType
+GitVersion.VersionCalculation.BaseVersionOperand.SourceType.init -> void
+GitVersion.VersionCalculation.BaseVersionOperator.SourceType.get -> GitVersion.VersionCalculation.VersionIncrementSourceType
+GitVersion.VersionCalculation.IBaseVersionIncrement.SourceType.get -> GitVersion.VersionCalculation.VersionIncrementSourceType
+GitVersion.VersionCalculation.VersionIncrementSourceType
+GitVersion.VersionCalculation.VersionIncrementSourceType.Fallback = 2 -> GitVersion.VersionCalculation.VersionIncrementSourceType
+GitVersion.VersionCalculation.VersionIncrementSourceType.NextVersionConfig = 3 -> GitVersion.VersionCalculation.VersionIncrementSourceType
+GitVersion.VersionCalculation.VersionIncrementSourceType.Tag = 1 -> GitVersion.VersionCalculation.VersionIncrementSourceType
+GitVersion.VersionCalculation.VersionIncrementSourceType.Tree = 0 -> GitVersion.VersionCalculation.VersionIncrementSourceType
diff --git a/src/GitVersion.Core/VersionCalculation/PathFilter.cs b/src/GitVersion.Core/VersionCalculation/PathFilter.cs
@@ -16,7 +16,7 @@ public bool Exclude(IBaseVersion baseVersion, out string? reason)
         ArgumentNullException.ThrowIfNull(baseVersion);
 
         reason = null;
-        if (baseVersion.Source.StartsWith("Fallback") || baseVersion.Source.StartsWith("Git tag") || baseVersion.Source.StartsWith("NextVersion")) return false;
+        if (baseVersion.SourceType != VersionIncrementSourceType.Tree) return false;
 
         return Exclude(baseVersion.BaseVersionSource, out reason);
     }
diff --git a/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/BaseVersion.cs b/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/BaseVersion.cs
@@ -10,13 +10,13 @@ public BaseVersion() : this(new BaseVersionOperand())
     {
     }
 
-    public BaseVersion(string source, SemanticVersion semanticVersion, ICommit? baseVersionSource = null)
-        : this(new BaseVersionOperand(source, semanticVersion, baseVersionSource))
-    {
-    }
+    public BaseVersion(string source, SemanticVersion semanticVersion, ICommit? baseVersionSource = null, VersionIncrementSourceType sourceType = VersionIncrementSourceType.Tree)
+        : this(new BaseVersionOperand(source, semanticVersion, baseVersionSource, sourceType)) => this.SourceType = sourceType;
 
     public string Source => (Operator?.Source).IsNullOrEmpty() ? Operand.Source : Operator.Source;
 
+    public VersionIncrementSourceType SourceType { get; init; } = VersionIncrementSourceType.Tree;
+
     public SemanticVersion SemanticVersion => Operand.SemanticVersion;
 
     public ICommit? BaseVersionSource => Operator?.BaseVersionSource ?? Operand.BaseVersionSource;
diff --git a/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/BaseVersionOperand.cs b/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/BaseVersionOperand.cs
@@ -3,7 +3,7 @@
 
 namespace GitVersion.VersionCalculation;
 
-public sealed record BaseVersionOperand(string Source, SemanticVersion SemanticVersion, ICommit? BaseVersionSource = null)
+public sealed record BaseVersionOperand(string Source, SemanticVersion SemanticVersion, ICommit? BaseVersionSource = null, VersionIncrementSourceType SourceType = VersionIncrementSourceType.Tree)
     : IBaseVersionIncrement
 {
     public BaseVersionOperand() : this(string.Empty, SemanticVersion.Empty)
@@ -12,6 +12,8 @@ public BaseVersionOperand() : this(string.Empty, SemanticVersion.Empty)
 
     public string Source { get; init; } = Source.NotNull();
 
+    public VersionIncrementSourceType SourceType { get; init; } = SourceType;
+
     public SemanticVersion SemanticVersion { get; init; } = SemanticVersion.NotNull();
 
     public override string ToString()
diff --git a/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/BaseVersionOperator.cs b/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/BaseVersionOperator.cs
@@ -6,6 +6,8 @@ public sealed record BaseVersionOperator : IBaseVersionIncrement
 {
     public string Source { get; init; } = string.Empty;
 
+    public VersionIncrementSourceType SourceType { get; } = VersionIncrementSourceType.Tree;
+
     public ICommit? BaseVersionSource { get; init; }
 
     public VersionField Increment { get; init; }
diff --git a/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/ConfiguredNextVersionVersionStrategy.cs b/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/ConfiguredNextVersionVersionStrategy.cs
@@ -42,7 +42,7 @@ public IEnumerable<BaseVersion> GetBaseVersions(EffectiveBranchConfiguration con
                     };
                 }
 
-                yield return new BaseVersion("NextVersion in GitVersion configuration file", semanticVersion)
+                yield return new BaseVersion("NextVersion in GitVersion configuration file", semanticVersion, sourceType: VersionIncrementSourceType.NextVersionConfig)
                 {
                     Operator = operation
                 };
diff --git a/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/FallbacktVersionStrategy.cs b/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/FallbacktVersionStrategy.cs
@@ -58,7 +58,8 @@ private IEnumerable<BaseVersion> GetBaseVersionsInternal(EffectiveBranchConfigur
                 Increment = increment,
                 ForceIncrement = false,
                 Label = label
-            }
+            },
+            SourceType = VersionIncrementSourceType.Fallback
         };
     }
 }
diff --git a/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/IBaseVersionIncrement.cs b/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/IBaseVersionIncrement.cs
@@ -6,5 +6,7 @@ public interface IBaseVersionIncrement
 {
     string Source { get; }
 
+    VersionIncrementSourceType SourceType { get; }
+
     ICommit? BaseVersionSource { get; }
 }
diff --git a/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/TaggedCommitVersionStrategy.cs b/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/TaggedCommitVersionStrategy.cs
@@ -78,7 +78,7 @@ private IEnumerable<BaseVersion> GetBaseVersionsInternal(EffectiveBranchConfigur
             semanticVersionTreshold = semanticVersion.Value.Increment(increment, null, forceIncrement: true);
 
             yield return new BaseVersion(
-                $"Git tag '{semanticVersion.Tag.Name.Friendly}'", semanticVersion.Value, baseVersionSource)
+                $"Git tag '{semanticVersion.Tag.Name.Friendly}'", semanticVersion.Value, baseVersionSource, VersionIncrementSourceType.Tag)
             {
                 Operator = new BaseVersionOperator
                 {
diff --git a/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/VersionIncrementSourceType.cs b/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/VersionIncrementSourceType.cs
@@ -0,0 +1,9 @@
+namespace GitVersion.VersionCalculation;
+
+public enum VersionIncrementSourceType
+{
+    Tree,
+    Tag,
+    Fallback,
+    NextVersionConfig
+}

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public bool Exclude(IBaseVersion baseVersion, out string? reason)`
`16`	`16`	`ArgumentNullException.ThrowIfNull(baseVersion);`
`17`	`17`
`18`	`18`	`reason = null;`
`19`		`- if (baseVersion.Source.StartsWith("Fallback") \|\| baseVersion.Source.StartsWith("Git tag") \|\| baseVersion.Source.StartsWith("NextVersion")) return false;`
	`19`	`+ if (baseVersion.SourceType != VersionIncrementSourceType.Tree) return false;`
`20`	`20`
`21`	`21`	`return Exclude(baseVersion.BaseVersionSource, out reason);`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,13 +10,13 @@ public BaseVersion() : this(new BaseVersionOperand())`
`10`	`10`	`{`
`11`	`11`	`}`
`12`	`12`
`13`		`- public BaseVersion(string source, SemanticVersion semanticVersion, ICommit? baseVersionSource = null)`
`14`		`- : this(new BaseVersionOperand(source, semanticVersion, baseVersionSource))`
`15`		`- {`
`16`		`- }`
	`13`	`+ public BaseVersion(string source, SemanticVersion semanticVersion, ICommit? baseVersionSource = null, VersionIncrementSourceType sourceType = VersionIncrementSourceType.Tree)`
	`14`	`+ : this(new BaseVersionOperand(source, semanticVersion, baseVersionSource, sourceType)) => this.SourceType = sourceType;`
`17`	`15`
`18`	`16`	`public string Source => (Operator?.Source).IsNullOrEmpty() ? Operand.Source : Operator.Source;`
`19`	`17`
	`18`	`+ public VersionIncrementSourceType SourceType { get; init; } = VersionIncrementSourceType.Tree;`
	`19`	`+`
`20`	`20`	`public SemanticVersion SemanticVersion => Operand.SemanticVersion;`
`21`	`21`
`22`	`22`	`public ICommit? BaseVersionSource => Operator?.BaseVersionSource ?? Operand.BaseVersionSource;`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@ public sealed record BaseVersionOperator : IBaseVersionIncrement`
`6`	`6`	`{`
`7`	`7`	`public string Source { get; init; } = string.Empty;`
`8`	`8`
	`9`	`+ public VersionIncrementSourceType SourceType { get; } = VersionIncrementSourceType.Tree;`
	`10`	`+`
`9`	`11`	`public ICommit? BaseVersionSource { get; init; }`
`10`	`12`
`11`	`13`	`public VersionField Increment { get; init; }`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public IEnumerable<BaseVersion> GetBaseVersions(EffectiveBranchConfiguration con`
`42`	`42`	`};`
`43`	`43`	`}`
`44`	`44`
`45`		`- yield return new BaseVersion("NextVersion in GitVersion configuration file", semanticVersion)`
	`45`	`+ yield return new BaseVersion("NextVersion in GitVersion configuration file", semanticVersion, sourceType: VersionIncrementSourceType.NextVersionConfig)`
`46`	`46`	`{`
`47`	`47`	`Operator = operation`
`48`	`48`	`};`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,8 @@ private IEnumerable<BaseVersion> GetBaseVersionsInternal(EffectiveBranchConfigur`
`58`	`58`	`Increment = increment,`
`59`	`59`	`ForceIncrement = false,`
`60`	`60`	`Label = label`
`61`		`- }`
	`61`	`+ },`
	`62`	`+ SourceType = VersionIncrementSourceType.Fallback`
`62`	`63`	`};`
`63`	`64`	`}`
`64`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,7 @@ public interface IBaseVersionIncrement`
`6`	`6`	`{`
`7`	`7`	`string Source { get; }`
`8`	`8`
	`9`	`+ VersionIncrementSourceType SourceType { get; }`
	`10`	`+`
`9`	`11`	`ICommit? BaseVersionSource { get; }`
`10`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ private IEnumerable<BaseVersion> GetBaseVersionsInternal(EffectiveBranchConfigur`
`78`	`78`	`semanticVersionTreshold = semanticVersion.Value.Increment(increment, null, forceIncrement: true);`
`79`	`79`
`80`	`80`	`yield return new BaseVersion(`
`81`		`- $"Git tag '{semanticVersion.Tag.Name.Friendly}'", semanticVersion.Value, baseVersionSource)`
	`81`	`+ $"Git tag '{semanticVersion.Tag.Name.Friendly}'", semanticVersion.Value, baseVersionSource, VersionIncrementSourceType.Tag)`
`82`	`82`	`{`
`83`	`83`	`Operator = new BaseVersionOperator`
`84`	`84`	`{`