feat: introduce paths-filter based on commit filtering

roeil · roeil · commit 789226ff04e3 · 2025-06-28T20:21:39.000+03:00
diff --git a/docs/input/docs/workflows/GitFlow/v1.yml b/docs/input/docs/workflows/GitFlow/v1.yml
@@ -148,6 +148,7 @@ branches:
     is-main-branch: false
 ignore:
   sha: []
+  paths: []
 mode: ContinuousDelivery
 label: '{BranchName}'
 increment: Inherit
diff --git a/docs/input/docs/workflows/GitHubFlow/v1.yml b/docs/input/docs/workflows/GitHubFlow/v1.yml
@@ -97,6 +97,7 @@ branches:
     is-main-branch: false
 ignore:
   sha: []
+  paths: []
 mode: ContinuousDelivery
 label: '{BranchName}'
 increment: Inherit
diff --git a/docs/input/docs/workflows/TrunkBased/preview1.yml b/docs/input/docs/workflows/TrunkBased/preview1.yml
@@ -82,6 +82,7 @@ branches:
     pre-release-weight: 30000
 ignore:
   sha: []
+  paths: []
 mode: ContinuousDelivery
 label: '{BranchName}'
 increment: Inherit
diff --git a/src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.CanWriteOutEffectiveConfiguration.approved.txt b/src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.CanWriteOutEffectiveConfiguration.approved.txt
@@ -148,6 +148,7 @@ branches:
     is-main-branch: false
 ignore:
   sha: []
+  paths: []
 mode: ContinuousDelivery
 label: '{BranchName}'
 increment: Inherit
diff --git a/src/GitVersion.Configuration.Tests/Workflows/approved/GitFlow/v1.yml b/src/GitVersion.Configuration.Tests/Workflows/approved/GitFlow/v1.yml
@@ -148,6 +148,7 @@ branches:
     is-main-branch: false
 ignore:
   sha: []
+  paths: []
 mode: ContinuousDelivery
 label: '{BranchName}'
 increment: Inherit
diff --git a/src/GitVersion.Configuration.Tests/Workflows/approved/GitHubFlow/v1.yml b/src/GitVersion.Configuration.Tests/Workflows/approved/GitHubFlow/v1.yml
@@ -97,6 +97,7 @@ branches:
     is-main-branch: false
 ignore:
   sha: []
+  paths: []
 mode: ContinuousDelivery
 label: '{BranchName}'
 increment: Inherit
diff --git a/src/GitVersion.Configuration.Tests/Workflows/approved/TrunkBased/preview1.yml b/src/GitVersion.Configuration.Tests/Workflows/approved/TrunkBased/preview1.yml
@@ -82,6 +82,7 @@ branches:
     pre-release-weight: 30000
 ignore:
   sha: []
+  paths: []
 mode: ContinuousDelivery
 label: '{BranchName}'
 increment: Inherit
diff --git a/src/GitVersion.Configuration/IgnoreConfiguration.cs b/src/GitVersion.Configuration/IgnoreConfiguration.cs
@@ -1,3 +1,4 @@
+using System.Collections.ObjectModel;
 using GitVersion.Configuration.Attributes;
 
 namespace GitVersion.Configuration;
@@ -24,5 +25,11 @@ public string? BeforeString
     public HashSet<string> Shas { get; init; } = [];
 
     [JsonIgnore]
-    public bool IsEmpty => Before == null && Shas.Count == 0;
+    public bool IsEmpty => Before == null && Shas.Count == 0 && Paths.Count == 0;
+
+    IReadOnlyCollection<string> IIgnoreConfiguration.Paths => Paths;
+
+    [JsonPropertyName("paths")]
+    [JsonPropertyDescription("A sequence of file paths to be excluded from the version calculations.")]
+    public Collection<string> Paths { get; init; } = [];
 }
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/MinDateVersionFilterTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/MinDateVersionFilterTests.cs
@@ -12,7 +12,7 @@ public void VerifyNullGuard()
         var dummy = DateTimeOffset.UtcNow.AddSeconds(1.0);
         var sut = new MinDateVersionFilter(dummy);
 
-        Should.Throw<ArgumentNullException>(() => sut.Exclude(null!, out _));
+        Should.Throw<ArgumentNullException>(() => sut.Exclude((IBaseVersion)null!, out _));
     }
 
     [Test]
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/PathFilterTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/PathFilterTests.cs
@@ -0,0 +1,11 @@
+using GitVersion.Core.Tests.Helpers;
+using GitVersion.VersionCalculation;
+
+namespace GitVersion.Core.Tests;
+
+[TestFixture]
+public class PathFilterTests : TestBase
+{
+    [Test]
+    public void VerifyNullGuard() => Should.Throw<ArgumentNullException>(() => new PathFilter(null!));
+}
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/ShaVersionFilterTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/ShaVersionFilterTests.cs
@@ -12,7 +12,7 @@ public void VerifyNullGuard()
         var commit = GitRepositoryTestingExtensions.CreateMockCommit();
         var sut = new ShaVersionFilter([commit.Sha]);
 
-        Should.Throw<ArgumentNullException>(() => sut.Exclude(null!, out _));
+        Should.Throw<ArgumentNullException>(() => sut.Exclude((IBaseVersion)null!, out _));
     }
 
     [Test]
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Strategies/MergeMessageBaseVersionStrategyTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/Strategies/MergeMessageBaseVersionStrategyTests.cs
@@ -204,6 +204,7 @@ private class MockCommit : ICommit
         public IObjectId Id => throw new NotImplementedException();
         public string Sha => throw new NotImplementedException();
         public IReadOnlyList<ICommit> Parents => throw new NotImplementedException();
+        public IEnumerable<string> DiffPaths => throw new NotImplementedException();
         public DateTimeOffset When => throw new NotImplementedException();
         public string Message => throw new NotImplementedException();
     }
diff --git a/src/GitVersion.Core/Configuration/EffectiveConfiguration.cs b/src/GitVersion.Core/Configuration/EffectiveConfiguration.cs
@@ -68,7 +68,6 @@ public EffectiveConfiguration(
         PatchVersionBumpMessage = configuration.PatchVersionBumpMessage;
         NoBumpMessage = configuration.NoBumpMessage;
         CommitMessageIncrementing = branchConfiguration.CommitMessageIncrementing.Value;
-        VersionFilters = configuration.Ignore.ToFilters();
         Ignore = configuration.Ignore;
         TracksReleaseBranches = branchConfiguration.TracksReleaseBranches ?? false;
         IsReleaseBranch = branchConfiguration.IsReleaseBranch ?? false;
@@ -124,8 +123,6 @@ public EffectiveConfiguration(
 
     public CommitMessageIncrementMode CommitMessageIncrementing { get; }
 
-    public IEnumerable<IVersionFilter> VersionFilters { get; }
-
     public IIgnoreConfiguration Ignore { get; }
 
     public string? CommitDateFormat { get; }
diff --git a/src/GitVersion.Core/Configuration/IIgnoreConfiguration.cs b/src/GitVersion.Core/Configuration/IIgnoreConfiguration.cs
@@ -6,5 +6,7 @@ public interface IIgnoreConfiguration
 
     IReadOnlySet<string> Shas { get; }
 
-    bool IsEmpty { get; }
+    IReadOnlyCollection<string> Paths { get; }
+
+    bool IsEmpty => Before == null && Shas.Count == 0 && Paths.Count == 0;
 }
diff --git a/src/GitVersion.Core/Configuration/IgnoreConfigurationExtensions.cs b/src/GitVersion.Core/Configuration/IgnoreConfigurationExtensions.cs
@@ -22,5 +22,5 @@ public static IEnumerable<ICommit> Filter(this IIgnoreConfiguration ignore, ICom
     }
 
     private static bool ShouldBeIgnored(ICommit commit, IIgnoreConfiguration ignore)
-        => !(commit.When <= ignore.Before) && !ignore.Shas.Contains(commit.Sha);
+        => !ignore.ToFilters().Any(filter => filter.Exclude(commit, out var _));
 }
diff --git a/src/GitVersion.Core/Extensions/ConfigurationExtensions.cs b/src/GitVersion.Core/Extensions/ConfigurationExtensions.cs
@@ -25,7 +25,7 @@ public static EffectiveConfiguration GetEffectiveConfiguration(
         {
             fallbackConfiguration = parentConfiguration;
         }
-        return new EffectiveConfiguration(configuration, branchConfiguration, fallbackConfiguration);
+        return new EffectiveConfiguration(configuration, branchConfiguration, fallbackConfiguration: fallbackConfiguration);
     }
 
     public static IBranchConfiguration GetBranchConfiguration(this IGitVersionConfiguration configuration, IBranch branch)
@@ -44,6 +44,7 @@ public static IEnumerable<IVersionFilter> ToFilters(this IIgnoreConfiguration so
 
         if (source.Shas.Count != 0) yield return new ShaVersionFilter(source.Shas);
         if (source.Before.HasValue) yield return new MinDateVersionFilter(source.Before.Value);
+        if (source.Paths.Count != 0) yield return new PathFilter(source.Paths);
     }
 
     private static IEnumerable<IBranchConfiguration> GetBranchConfigurations(IGitVersionConfiguration configuration, string branchName)
diff --git a/src/GitVersion.Core/Git/ICommit.cs b/src/GitVersion.Core/Git/ICommit.cs
@@ -7,4 +7,5 @@ public interface ICommit : IEquatable<ICommit?>, IComparable<ICommit>, IGitObjec
     DateTimeOffset When { get; }
 
     string Message { get; }
+    IEnumerable<string> DiffPaths { get; }
 }
diff --git a/src/GitVersion.Core/Git/ITreeChanges.cs b/src/GitVersion.Core/Git/ITreeChanges.cs
@@ -0,0 +1,6 @@
+namespace GitVersion.Git;
+
+public interface ITreeChanges
+{
+    IEnumerable<string> Paths { get; }
+}
diff --git a/src/GitVersion.Core/PublicAPI.Shipped.txt b/src/GitVersion.Core/PublicAPI.Shipped.txt
@@ -87,7 +87,6 @@ GitVersion.Configuration.EffectiveConfiguration.TrackMergeMessage.get -> bool
 GitVersion.Configuration.EffectiveConfiguration.TrackMergeTarget.get -> bool
 GitVersion.Configuration.EffectiveConfiguration.TracksReleaseBranches.get -> bool
 GitVersion.Configuration.EffectiveConfiguration.UpdateBuildNumber.get -> bool
-GitVersion.Configuration.EffectiveConfiguration.VersionFilters.get -> System.Collections.Generic.IEnumerable<GitVersion.VersionCalculation.IVersionFilter!>!
 GitVersion.Configuration.EffectiveConfiguration.VersionInBranchPattern.get -> string?
 GitVersion.Configuration.EffectiveConfiguration.VersionStrategy.get -> GitVersion.VersionCalculation.VersionStrategies
 GitVersion.Configuration.IBranchConfiguration
diff --git a/src/GitVersion.Core/PublicAPI.Unshipped.txt b/src/GitVersion.Core/PublicAPI.Unshipped.txt
@@ -146,3 +146,8 @@ virtual GitVersion.WixInfo.<Clone>$() -> GitVersion.WixInfo!
 virtual GitVersion.WixInfo.EqualityContract.get -> System.Type!
 virtual GitVersion.WixInfo.Equals(GitVersion.WixInfo? other) -> bool
 virtual GitVersion.WixInfo.PrintMembers(System.Text.StringBuilder! builder) -> bool
+GitVersion.Configuration.IIgnoreConfiguration.Paths.get -> System.Collections.Generic.IReadOnlyCollection<string!>!
+GitVersion.Git.ICommit.DiffPaths.get -> System.Collections.Generic.IEnumerable<string!>!
+GitVersion.Git.ITreeChanges
+GitVersion.Git.ITreeChanges.Paths.get -> System.Collections.Generic.IEnumerable<string!>!
+GitVersion.VersionCalculation.IVersionFilter.Exclude(GitVersion.Git.ICommit! commit, out string? reason) -> bool
diff --git a/src/GitVersion.Core/VersionCalculation/Abstractions/IVersionFilter.cs b/src/GitVersion.Core/VersionCalculation/Abstractions/IVersionFilter.cs
@@ -1,6 +1,9 @@
+using GitVersion.Git;
+
 namespace GitVersion.VersionCalculation;
 
 public interface IVersionFilter
 {
     bool Exclude(IBaseVersion baseVersion, out string? reason);
+    bool Exclude(ICommit commit, out string? reason);
 }
diff --git a/src/GitVersion.Core/VersionCalculation/IncrementStrategyFinder.cs b/src/GitVersion.Core/VersionCalculation/IncrementStrategyFinder.cs
@@ -7,7 +7,9 @@
 
 namespace GitVersion.VersionCalculation;
 
-internal class IncrementStrategyFinder(IRepositoryStore repositoryStore, ITaggedSemanticVersionRepository taggedSemanticVersionRepository)
+internal class IncrementStrategyFinder(
+    IRepositoryStore repositoryStore,
+    ITaggedSemanticVersionRepository taggedSemanticVersionRepository)
     : IIncrementStrategyFinder
 {
     private readonly Dictionary<string, VersionField?> commitIncrementCache = [];
diff --git a/src/GitVersion.Core/VersionCalculation/MinDateVersionFilter.cs b/src/GitVersion.Core/VersionCalculation/MinDateVersionFilter.cs
@@ -1,5 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 using GitVersion.Extensions;
+using GitVersion.Git;
 
 namespace GitVersion.VersionCalculation;
 
@@ -17,4 +18,15 @@ public bool Exclude(IBaseVersion baseVersion, [NotNullWhen(true)] out string? re
         reason = "Source was ignored due to commit date being outside of configured range";
         return true;
     }
+
+    public bool Exclude(ICommit commit, [NotNullWhen(true)] out string? reason)
+    {
+        reason = null;
+
+        if (commit == null || commit.When >= minimum)
+            return false;
+
+        reason = "Source was ignored due to commit date being outside of configured range";
+        return true;
+    }
 }
diff --git a/src/GitVersion.Core/VersionCalculation/PathFilter.cs b/src/GitVersion.Core/VersionCalculation/PathFilter.cs
@@ -0,0 +1,51 @@
+using System.Diagnostics.CodeAnalysis;
+using System.Text.RegularExpressions;
+using GitVersion.Git;
+
+namespace GitVersion.VersionCalculation;
+
+internal class PathFilter( IEnumerable<string> paths) : IVersionFilter
+{
+    private readonly List<Regex> pathsRegexes = paths.Select(path => new Regex(path, RegexOptions.IgnoreCase | RegexOptions.Compiled)).ToList();
+    private readonly Dictionary<string, bool> pathMatchCache = [];
+
+    public bool Exclude(IBaseVersion baseVersion, [NotNullWhen(true)] out string? reason)
+    {
+        ArgumentNullException.ThrowIfNull(baseVersion);
+
+        reason = null;
+        if (baseVersion.Source.StartsWith("Fallback") || baseVersion.Source.StartsWith("Git tag") || baseVersion.Source.StartsWith("NextVersion")) return false;
+
+        return Exclude(baseVersion.BaseVersionSource, out reason);
+    }
+
+    public bool Exclude(ICommit? commit, [NotNullWhen(true)] out string? reason)
+    {
+        reason = null;
+
+        if (commit != null)
+        {
+            var patchPaths = commit.DiffPaths;
+
+            if (patchPaths != null)
+            {
+                foreach (var path in patchPaths)
+                {
+                    if (!pathMatchCache.TryGetValue(path, out var isMatch))
+                    {
+                        isMatch = this.pathsRegexes.Any(regex => regex.IsMatch(path));
+                        pathMatchCache[path] = isMatch;
+                    }
+
+                    if (isMatch)
+                    {
+                        reason = "Source was ignored due to commit path matching ignore regex";
+                        return true;
+                    }
+                }
+            }
+        }
+
+        return false;
+    }
+}
diff --git a/src/GitVersion.Core/VersionCalculation/ShaVersionFilter.cs b/src/GitVersion.Core/VersionCalculation/ShaVersionFilter.cs
@@ -1,5 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 using GitVersion.Extensions;
+using GitVersion.Git;
 
 namespace GitVersion.VersionCalculation;
 
@@ -22,4 +23,16 @@ public bool Exclude(IBaseVersion baseVersion, [NotNullWhen(true)] out string? re
         reason = $"Sha {baseVersion.BaseVersionSource} was ignored due to commit having been excluded by configuration";
         return true;
     }
+
+    public bool Exclude(ICommit commit, [NotNullWhen(true)] out string? reason)
+    {
+        reason = null;
+
+        if (commit == null
+            || !this.shaList.Any(sha => commit.Sha.StartsWith(sha, StringComparison.OrdinalIgnoreCase)))
+            return false;
+
+        reason = $"Sha {commit} was ignored due to commit having been excluded by configuration";
+        return true;
+    }
 }
diff --git a/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/ConfiguredNextVersionVersionStrategy.cs b/src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/ConfiguredNextVersionVersionStrategy.cs
@@ -18,7 +18,7 @@ public IEnumerable<BaseVersion> GetBaseVersions(EffectiveBranchConfiguration con
     {
         configuration.NotNull();
 
-        if (!Context.Configuration.VersionStrategy.HasFlag(VersionStrategies.ConfiguredNextVersion))
+        if (!this.Context.Configuration.VersionStrategy.HasFlag(VersionStrategies.ConfiguredNextVersion))
             yield break;
 
         var nextVersion = Context.Configuration.NextVersion;
diff --git a/src/GitVersion.LibGit2Sharp/Git/Branch.cs b/src/GitVersion.LibGit2Sharp/Git/Branch.cs
@@ -10,16 +10,16 @@ internal sealed class Branch : IBranch
 
     private readonly LibGit2Sharp.Branch innerBranch;
 
-    internal Branch(LibGit2Sharp.Branch branch)
+    internal Branch(LibGit2Sharp.Branch branch, LibGit2Sharp.Diff diff)
     {
         this.innerBranch = branch.NotNull();
         Name = new(branch.CanonicalName);
 
         var commit = this.innerBranch.Tip;
-        Tip = commit is null ? null : new Commit(commit);
+        Tip = commit is null ? null : new Commit(commit, diff);
 
         var commits = this.innerBranch.Commits;
-        Commits = new CommitCollection(commits);
+        Commits = new CommitCollection(commits, diff);
     }
 
     public ReferenceName Name { get; }
diff --git a/src/GitVersion.LibGit2Sharp/Git/BranchCollection.cs b/src/GitVersion.LibGit2Sharp/Git/BranchCollection.cs
@@ -7,11 +7,13 @@ internal sealed class BranchCollection : IBranchCollection
 {
     private readonly LibGit2Sharp.BranchCollection innerCollection;
     private readonly Lazy<IReadOnlyCollection<IBranch>> branches;
+    private readonly LibGit2Sharp.Diff diff;
 
-    internal BranchCollection(LibGit2Sharp.BranchCollection collection)
+    internal BranchCollection(LibGit2Sharp.BranchCollection collection, LibGit2Sharp.Diff diff)
     {
         this.innerCollection = collection.NotNull();
-        this.branches = new Lazy<IReadOnlyCollection<IBranch>>(() => [.. this.innerCollection.Select(branch => new Branch(branch))]);
+this.branches = new Lazy<IReadOnlyCollection<IBranch>>(() => [.. this.innerCollection.Select(branch => new Branch(branch, diff))]);
+        this.diff = diff.NotNull();
     }
 
     public IEnumerator<IBranch> GetEnumerator()
@@ -25,7 +27,7 @@ public IBranch? this[string name]
         {
             name = name.NotNull();
             var branch = this.innerCollection[name];
-            return branch is null ? null : new Branch(branch);
+            return branch is null ? null : new Branch(branch, this.diff);
         }
     }
 
diff --git a/src/GitVersion.LibGit2Sharp/Git/Commit.cs b/src/GitVersion.LibGit2Sharp/Git/Commit.cs
diff --git a/src/GitVersion.LibGit2Sharp/Git/CommitCollection.cs b/src/GitVersion.LibGit2Sharp/Git/CommitCollection.cs
diff --git a/src/GitVersion.LibGit2Sharp/Git/GitRepository.cs b/src/GitVersion.LibGit2Sharp/Git/GitRepository.cs
diff --git a/src/GitVersion.LibGit2Sharp/Git/Tag.cs b/src/GitVersion.LibGit2Sharp/Git/Tag.cs
diff --git a/src/GitVersion.LibGit2Sharp/Git/TagCollection.cs b/src/GitVersion.LibGit2Sharp/Git/TagCollection.cs
diff --git a/src/GitVersion.LibGit2Sharp/Git/TreeChanges.cs b/src/GitVersion.LibGit2Sharp/Git/TreeChanges.cs

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public void VerifyNullGuard()`
`12`	`12`	`var dummy = DateTimeOffset.UtcNow.AddSeconds(1.0);`
`13`	`13`	`var sut = new MinDateVersionFilter(dummy);`
`14`	`14`
`15`		`- Should.Throw<ArgumentNullException>(() => sut.Exclude(null!, out _));`
	`15`	`+ Should.Throw<ArgumentNullException>(() => sut.Exclude((IBaseVersion)null!, out _));`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`[Test]`