feat(paths-filter): first commit that supports paths filtering (ignore inclusive only)

roeil · roeil · commit e242079ddc3e · 2025-02-13T17:23:42.000+02: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/schemas/6.1/GitVersion.configuration.json b/schemas/6.1/GitVersion.configuration.json
@@ -189,6 +189,13 @@
             "null"
           ]
         },
+        "paths": {
+          "description": "A sequence of file paths to be excluded from the version calculations.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
         "sha": {
           "description": "A sequence of SHAs to be excluded from the version calculations.",
           "$ref": "#/$defs/hashSetOfString"
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;
@@ -22,4 +23,11 @@ public string? BeforeString
     [JsonPropertyName("sha")]
     [JsonPropertyDescription("A sequence of SHAs to be excluded from the version calculations.")]
     public HashSet<string> Shas { get; init; } = [];
+
+    [JsonIgnore]
+    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/PathFilterTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/PathFilterTests.cs
@@ -0,0 +1,20 @@
+using GitVersion.Core.Tests.Helpers;
+using GitVersion.Git;
+using GitVersion.VersionCalculation;
+
+namespace GitVersion.Core.Tests;
+
+[TestFixture]
+public class PathFilterTests : TestBase
+{
+    [Test]
+    public void VerifyNullGuard() => Should.Throw<ArgumentNullException>(() => new PathFilter(null!, null!, null!));
+
+    [Test]
+    public void VerifyNullGuard2()
+    {
+        var sut = new PathFilter(null!, null!, [""]);
+
+        Should.Throw<ArgumentNullException>(() => sut.Exclude((ICommit?)null, out _));
+    }
+}
diff --git a/src/GitVersion.Core/Configuration/EffectiveConfiguration.cs b/src/GitVersion.Core/Configuration/EffectiveConfiguration.cs
@@ -1,4 +1,5 @@
 using GitVersion.Extensions;
+using GitVersion.Git;
 using GitVersion.VersionCalculation;
 
 namespace GitVersion.Configuration;
@@ -67,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;
@@ -122,8 +122,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; }
 
-    public bool IsEmpty => Before == null && Shas.Count == 0;
+    IReadOnlyCollection<string> Paths { get; }
+
+    public bool IsEmpty => Before == null && Shas.Count == 0 && Paths.Count == 0;
 }
diff --git a/src/GitVersion.Core/Extensions/ConfigurationExtensions.cs b/src/GitVersion.Core/Extensions/ConfigurationExtensions.cs
@@ -37,12 +37,13 @@ public static IBranchConfiguration GetBranchConfiguration(this IGitVersionConfig
         return branchConfiguration;
     }
 
-    public static IEnumerable<IVersionFilter> ToFilters(this IIgnoreConfiguration source)
+    public static IEnumerable<IVersionFilter> ToFilters(this IIgnoreConfiguration source, IGitRepository repository, GitVersionContext versionContext)
     {
         source.NotNull();
 
         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(repository, versionContext, source.Paths);
     }
 
     private static IEnumerable<IBranchConfiguration> GetBranchConfigurations(IGitVersionConfiguration configuration, string branchName)
diff --git a/src/GitVersion.Core/Git/IGitRepository.cs b/src/GitVersion.Core/Git/IGitRepository.cs
@@ -1,3 +1,5 @@
+using LibGit2Sharp;
+
 namespace GitVersion.Git;
 
 public interface IGitRepository : IDisposable
@@ -14,6 +16,9 @@ public interface IGitRepository : IDisposable
     IBranchCollection Branches { get; }
     ICommitCollection Commits { get; }
     IRemoteCollection Remotes { get; }
+    IQueryableCommitLog InnerCommits { get; }
+    IEnumerable<Tag> InnerTags { get; }
+    Diff InnerDiff { get; }
 
     ICommit? FindMergeBase(ICommit commit, ICommit otherCommit);
     int UncommittedChangesCount();
diff --git a/src/GitVersion.Core/PublicAPI.Shipped.txt b/src/GitVersion.Core/PublicAPI.Shipped.txt
@@ -88,7 +88,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
@@ -1 +1,5 @@
 #nullable enable
+GitVersion.Configuration.IIgnoreConfiguration.Paths.get -> System.Collections.Generic.IReadOnlyCollection<string!>!
+GitVersion.Git.IGitRepository.InnerCommits.get -> LibGit2Sharp.IQueryableCommitLog!
+GitVersion.Git.IGitRepository.InnerDiff.get -> LibGit2Sharp.Diff!
+GitVersion.Git.IGitRepository.InnerTags.get -> System.Collections.Generic.IEnumerable<LibGit2Sharp.Tag!>!
diff --git a/src/GitVersion.Core/VersionCalculation/IncrementStrategyFinder.cs b/src/GitVersion.Core/VersionCalculation/IncrementStrategyFinder.cs
@@ -7,7 +7,11 @@
 
 namespace GitVersion.VersionCalculation;
 
-internal class IncrementStrategyFinder(IRepositoryStore repositoryStore, ITaggedSemanticVersionRepository taggedSemanticVersionRepository)
+internal class IncrementStrategyFinder(
+    IRepositoryStore repositoryStore,
+    Lazy<GitVersionContext> versionContext,
+    IGitRepository repository,
+    ITaggedSemanticVersionRepository taggedSemanticVersionRepository)
     : IIncrementStrategyFinder
 {
     private readonly Dictionary<string, VersionField?> commitIncrementCache = [];
@@ -51,8 +55,10 @@ public VersionField DetermineIncrementedField(
         var minorRegex = TryGetRegexOrDefault(configuration.MinorVersionBumpMessage, RegexPatterns.VersionCalculation.DefaultMinorRegex);
         var patchRegex = TryGetRegexOrDefault(configuration.PatchVersionBumpMessage, RegexPatterns.VersionCalculation.DefaultPatchRegex);
         var noBumpRegex = TryGetRegexOrDefault(configuration.NoBumpMessage, RegexPatterns.VersionCalculation.DefaultNoBumpRegex);
+        var pathFilters = configuration.Ignore.ToFilters(repository, versionContext.Value).OfType<PathFilter>();
 
         var increments = commits
+            .Where(c => !pathFilters.Any(f => f.Exclude(c, out _)))
             .Select(c => GetIncrementFromCommit(c, majorRegex, minorRegex, patchRegex, noBumpRegex))
             .Where(v => v != null)
             .ToList();
diff --git a/src/GitVersion.Core/VersionCalculation/PathFilter.cs b/src/GitVersion.Core/VersionCalculation/PathFilter.cs
@@ -0,0 +1,76 @@
+using GitVersion.Extensions;
+using GitVersion.Git;
+using LibGit2Sharp;
+
+namespace GitVersion.VersionCalculation;
+
+internal class PathFilter(IGitRepository repository, GitVersionContext context, IEnumerable<string> paths, PathFilter.PathFilterMode mode = PathFilter.PathFilterMode.Inclusive) : IVersionFilter
+{
+    private readonly static Dictionary<string, Patch> patchsCache = [];
+
+    public enum PathFilterMode { Inclusive = 0, Exclusive = 1 }
+
+    private readonly IEnumerable<string> paths = paths.NotNull();
+    private readonly PathFilterMode mode = mode;
+    private readonly GitVersionContext context = context;
+
+    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;
+
+        return Exclude(baseVersion.BaseVersionSource, out reason);
+    }
+
+    public bool Exclude(ICommit? localCommit, out string? reason)
+    {
+        localCommit.NotNull();
+        var commit = repository.InnerCommits.First(c => c.Sha == localCommit.Sha);
+
+        reason = null;
+
+        var match = new System.Text.RegularExpressions.Regex($"^({context.Configuration.TagPrefixPattern}).*$",
+            System.Text.RegularExpressions.RegexOptions.Compiled);
+
+        if (commit != null)
+        {
+            Patch? patch = null;
+            if (!patchsCache.ContainsKey(commit.Sha))
+            {
+                if (!repository.InnerTags.Any(t => t.Target.Sha == commit.Sha && match.IsMatch(t.FriendlyName)))
+                {
+                    Tree commitTree = commit.Tree; // Main Tree
+                    Tree? parentCommitTree = commit.Parents.FirstOrDefault()?.Tree; // Secondary Tree
+                    patch = repository.InnerDiff.Compare<Patch>(parentCommitTree, commitTree); // Difference
+                }
+                patchsCache[commit.Sha] = patch;
+            }
+
+            patch = patchsCache[commit.Sha];
+            if (patch != null)
+            {
+                switch (mode)
+                {
+                    case PathFilterMode.Inclusive:
+                        if (!paths.Any(path => patch.Any(p => p.Path.StartsWith(path, StringComparison.OrdinalIgnoreCase))))
+                        {
+                            reason = "Source was ignored due to commit path is not present";
+                            return true;
+                        }
+                        break;
+                    case PathFilterMode.Exclusive:
+                        if (paths.Any(path => patch.All(p => p.Path.StartsWith(path, StringComparison.OrdinalIgnoreCase))))
+                        {
+                            reason = "Source was ignored due to commit path excluded";
+                            return true;
+                        }
+                        break;
+                }
+            }
+        }
+
+        return false;
+    }
+}
diff --git a/src/GitVersion.Core/VersionCalculation/VersionCalculators/NextVersionCalculator.cs b/src/GitVersion.Core/VersionCalculation/VersionCalculators/NextVersionCalculator.cs
@@ -11,6 +11,7 @@ namespace GitVersion.VersionCalculation;
 internal class NextVersionCalculator(
     ILog log,
     Lazy<GitVersionContext> versionContext,
+    IGitRepository repository,
     IEnumerable<IDeploymentModeCalculator> deploymentModeCalculators,
     IEnumerable<IVersionStrategy> versionStrategies,
     IEffectiveBranchConfigurationFinder effectiveBranchConfigurationFinder,
@@ -284,7 +285,7 @@ IEnumerable<NextVersion> GetNextVersionsInternal()
 
     private bool IncludeVersion(IBaseVersion baseVersion, IIgnoreConfiguration ignoreConfiguration)
     {
-        foreach (var versionFilter in ignoreConfiguration.ToFilters())
+        foreach (var versionFilter in ignoreConfiguration.ToFilters(repository, Context))
         {
             if (versionFilter.Exclude(baseVersion, out var reason))
             {
diff --git a/src/GitVersion.LibGit2Sharp/Git/GitRepository.cs b/src/GitVersion.LibGit2Sharp/Git/GitRepository.cs
@@ -28,6 +28,9 @@ private IRepository RepositoryInstance
     public IBranchCollection Branches => new BranchCollection(RepositoryInstance.Branches);
     public ICommitCollection Commits => new CommitCollection(RepositoryInstance.Commits);
     public IRemoteCollection Remotes => new RemoteCollection(RepositoryInstance.Network.Remotes);
+    public IQueryableCommitLog InnerCommits => RepositoryInstance.Commits;
+    public IEnumerable<LibGit2Sharp.Tag> InnerTags => RepositoryInstance.Tags;
+    public Diff InnerDiff => RepositoryInstance.Diff;
 
     public void DiscoverRepository(string? gitDirectory)
     {
