Topological commit sort causes issues when master is merged into a feature branch

Author: HHobeck

docs/input/docs/reference/modes/continuous-delivery.md

@@ -24,7 +24,7 @@ Continuous delivery is good when you deploy continuously to an testing system.
 * 1.1.0-3
 * 1.1.0-2 (tag: 1.1.0-2) <-- This is the version which has been deployed on testing
 * 1.1.0-1
-* 1.1.1-0
+* 1.1.0-0
 
 Tags are not required but optional in this mode to communicate when the release
 is done as it's an automated process.

docs/input/docs/reference/modes/continuous-deployment.md

@@ -21,7 +21,7 @@ to deploy on production. This means that GitVersion will build
 * 1.2.0
 * 1.1.0 (tag: 1.1.0) <-- This is the version which has been deployed on production
 * 1.1.0
-* 1.1.1
+* 1.1.0
 
 Tags are required in this mode to communicate when the deployment happens on production.
 

docs/input/docs/reference/modes/manual-deployment.md

@@ -21,7 +21,7 @@ deployed. For instance:
 * 1.1.0-2+1
 * 1.1.0-1+2 (tag: 1.1.0-1) <-- This is the version which has been deployed on testing
 * 1.1.0-1+1
-* 1.1.1-1+0
+* 1.1.0-1+0
 
 Tags are required in this mode to communicate when the release is done as it's
 an external manual process.

src/GitVersion.Core.Tests/Extensions/GitToolsTestingExtensions.cs

@@ -138,7 +138,7 @@ public static void AssertFullSemver(this RepositoryFixtureBase fixture, string f
     /// <summary>
     /// Simulates running on build server
     /// </summary>
-    public static void InitializeRepo(this RemoteRepositoryFixture fixture)
+    public static void InitializeRepository(this RemoteRepositoryFixture fixture)
     {
         var gitVersionOptions = new GitVersionOptions
         {

src/GitVersion.Core.Tests/IntegrationTests/OtherScenarios.cs

@@ -26,7 +26,7 @@ public void DoNotBlowUpWhenMainAndDevelopPointAtSameCommit()
         Commands.Fetch(fixture.LocalRepositoryFixture.Repository, fixture.LocalRepositoryFixture.Repository.Network.Remotes.First().Name, [], new(), null);
         Commands.Checkout(fixture.LocalRepositoryFixture.Repository, fixture.Repository.Head.Tip);
         fixture.LocalRepositoryFixture.Repository.Branches.Remove(MainBranch);
-        fixture.InitializeRepo();
+        fixture.InitializeRepository();
         fixture.AssertFullSemver("1.0.1-1");
     }
 
@@ -92,15 +92,15 @@ public void DoNotBlowUpWhenDevelopAndFeatureBranchPointAtSameCommit()
         Commands.Fetch(fixture.LocalRepositoryFixture.Repository, fixture.LocalRepositoryFixture.Repository.Network.Remotes.First().Name, [], new(), null);
         Commands.Checkout(fixture.LocalRepositoryFixture.Repository, fixture.Repository.Head.Tip);
         fixture.LocalRepositoryFixture.Repository.Branches.Remove(MainBranch);
-        fixture.InitializeRepo();
+        fixture.InitializeRepository();
         fixture.AssertFullSemver("1.1.0-alpha.1");
     }
 
     [TestCase(true, 1)]
     [TestCase(false, 1)]
     [TestCase(true, 5)]
     [TestCase(false, 5)]
-    public void HasDirtyFlagWhenUncommittedChangesAreInRepo(bool stageFile, int numberOfFiles)
+    public void HasDirtyFlagWhenUncommittedChangesAreInRepository(bool stageFile, int numberOfFiles)
     {
         using var fixture = new EmptyRepositoryFixture();
         fixture.MakeACommit();
@@ -133,7 +133,7 @@ public void NoDirtyFlagInCleanRepository()
 
     [TestCase(false, "1.1.0-alpha.2")]
     [TestCase(true, "1.2.0-alpha.1")]
-    public void EnsureTrackMergeTargetStrategyWhichWillLookForTaggedMergecommits(bool trackMergeTarget, string expectedVersion)
+    public void EnsureTrackMergeTargetStrategyWhichWillLookForTaggedMergeCommits(bool trackMergeTarget, string expectedVersion)
     {
         // * 9daa6ea 53 minutes ago  (HEAD -> develop)
         // | *   85536f2 55 minutes ago  (tag: 1.1.0, main)
@@ -1283,7 +1283,7 @@ public void EnsureVersionAfterMainIsMergedBackToDevelopIsCorrectForMainline(bool
     }
 
     [TestCase(false, "2.0.0-alpha.3")]
-    [TestCase(true, "2.0.0-alpha.3")]
+    [TestCase(true, "3.0.0-alpha.2")]
     public void EnsureVersionAfterMainIsMergedBackToDevelopIsCorrectForGitFlow(bool applyTag, string semanticVersion)
     {
         var configuration = GitFlowConfigurationBuilder.New.Build();
@@ -1300,7 +1300,7 @@ public void EnsureVersionAfterMainIsMergedBackToDevelopIsCorrectForGitFlow(bool
 
         fixture.Checkout("main");
         fixture.MakeACommit("C");
-        if (applyTag) fixture.ApplyTag("1.0.1");
+        if (applyTag) fixture.ApplyTag("2.0.0");
         fixture.Checkout("develop");
         fixture.MergeNoFF("main");
 
@@ -1380,7 +1380,8 @@ public void AlternativeSemanticVersionsShouldBeConsidered()
     }
 
     [TestCase(null, "6.0.0-beta.6")]
-    [TestCase("beta", "6.0.0-beta.21")]
+    [TestCase("beta", "6.0.0-beta.6")]
+    [TestCase("gamma", "6.0.0-gamma.21")]
     public void AlternativeSemanticVersionsShouldBeConsidered(string? labelOnMain, string version)
     {
         var configuration = GitFlowConfigurationBuilder.New
@@ -1391,14 +1392,16 @@ public void AlternativeSemanticVersionsShouldBeConsidered(string? labelOnMain, s
         using var fixture = new EmptyRepositoryFixture();
 
         fixture.MakeATaggedCommit("1.0.0");
-        fixture.MakeATaggedCommit("4.0.0-beta.14");
         fixture.MakeACommit("A");
+        fixture.ApplyTag("4.0.0-beta.14");
+        fixture.ApplyTag("4.0.0-gamma.14");
+        fixture.MakeACommit("B");
         fixture.MakeATaggedCommit("6.0.0-alpha.1");
         fixture.MakeATaggedCommit("6.0.0-alpha.2");
         fixture.MakeATaggedCommit("6.0.0-alpha.3");
-        fixture.MakeACommit("B");
-        fixture.MakeATaggedCommit("6.0.0-beta.5");
         fixture.MakeACommit("C");
+        fixture.MakeATaggedCommit("6.0.0-beta.5");
+        fixture.MakeACommit("D");
 
         fixture.AssertFullSemver(version, configuration);
     }

src/GitVersion.Core.Tests/IntegrationTests/PerformanceScenarios.cs

@@ -12,20 +12,23 @@ public void RepositoryWithALotOfTags()
 
         using var fixture = new EmptyRepositoryFixture();
 
-        const int maxCommits = 500;
-        for (int i = 0; i < maxCommits; i++)
+        Random random = new(4711);
+        SemanticVersion semanticVersion = SemanticVersion.Empty;
+        for (int i = 0; i < 500; i++)
         {
-            fixture.MakeATaggedCommit($"1.0.{i}");
+            VersionField versionField = (VersionField)random.Next(1, 4);
+            semanticVersion = semanticVersion.Increment(versionField, string.Empty, forceIncrement: true);
+            fixture.MakeATaggedCommit(semanticVersion.ToString("j"));
         }
 
         fixture.BranchTo("feature");
         fixture.MakeACommit();
 
         var sw = Stopwatch.StartNew();
 
-        fixture.AssertFullSemver($"1.0.{maxCommits}-feature.1+1", configuration);
+        fixture.AssertFullSemver("170.3.3-feature.1+1", configuration);
         sw.Stop();
 
-        sw.ElapsedMilliseconds.ShouldBeLessThan(5000);
+        sw.ElapsedMilliseconds.ShouldBeLessThan(2500);
     }
 }

src/GitVersion.Core/VersionCalculation/IncrementStrategyFinder.cs

@@ -106,7 +106,11 @@ private IReadOnlyCollection<ICommit> GetCommitHistory(string? tagPrefix, Semanti
                 .ToHashSet()
         );
 
-        var intermediateCommits = GetIntermediateCommits(baseVersionSource, currentCommit, ignore).ToArray();
+        var intermediateCommits = this.repositoryStore.GetCommitLog(
+            baseVersionSource: baseVersionSource,
+            currentCommit: currentCommit,
+            ignore: ignore
+        );
         var commitLog = intermediateCommits.ToDictionary(element => element.Id.Sha);
 
         foreach (var intermediateCommit in intermediateCommits.Reverse())
@@ -197,7 +201,6 @@ public IEnumerable<ICommit> GetMergedCommits(ICommit mergeCommit, int index, IIg
 
         ICommit findMergeBase = this.repositoryStore.FindMergeBase(baseCommit, mergedCommit)
             ?? throw new InvalidOperationException("Cannot find the base commit of merged branch.");
-
         return GetIntermediateCommits(findMergeBase, mergedCommit, ignore);
     }
 

src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/TaggedCommitVersionStrategy.cs

@@ -1,6 +1,8 @@
 using GitVersion.Configuration;
 using GitVersion.Core;
 using GitVersion.Extensions;
+using GitVersion.Logging;
+using static GitVersion.Core.RegexPatterns;
 
 namespace GitVersion.VersionCalculation;
 
@@ -10,14 +12,15 @@ namespace GitVersion.VersionCalculation;
 /// Increments if the tag is not the current commit.
 /// </summary>
 internal sealed class TaggedCommitVersionStrategy(
-    Lazy<GitVersionContext> contextLazy,
+    Lazy<GitVersionContext> contextLazy, ILog log,
     ITaggedSemanticVersionService taggedSemanticVersionService,
     IIncrementStrategyFinder incrementStrategyFinder)
     : IVersionStrategy
 {
     private readonly ITaggedSemanticVersionService taggedSemanticVersionService = taggedSemanticVersionService.NotNull();
     private readonly Lazy<GitVersionContext> contextLazy = contextLazy.NotNull();
     private readonly IIncrementStrategyFinder incrementStrategyFinder = incrementStrategyFinder.NotNull();
+    private readonly ILog log = log.NotNull();
 
     private GitVersionContext Context => contextLazy.Value;
 
@@ -41,6 +44,7 @@ private IEnumerable<BaseVersion> GetBaseVersionsInternal(EffectiveBranchConfigur
 
         var label = configuration.Value.GetBranchSpecificLabel(Context.CurrentBranch.Name, null);
 
+        SemanticVersion semanticVersionTreshold = new(0, 0, 0);
         List<SemanticVersionWithTag> alternativeSemanticVersionsWithTag = [];
         foreach (var semanticVersionWithTag in taggedSemanticVersions)
         {
@@ -50,6 +54,19 @@ private IEnumerable<BaseVersion> GetBaseVersionsInternal(EffectiveBranchConfigur
                 continue;
             }
 
+            var alternativeSemanticVersionMax = alternativeSemanticVersionsWithTag.Max()?.Value;
+            var highestPossibleSemanticVersion = semanticVersionWithTag.Value.Increment(
+                VersionField.Major, null, forceIncrement: true, alternativeSemanticVersionMax
+            );
+            if (highestPossibleSemanticVersion.IsLessThan(semanticVersionTreshold, includePreRelease: false))
+            {
+                this.log.Info(
+                    $"The tag '{semanticVersionWithTag.Value}' is skipped because it will never be higher than other tags."
+                );
+                alternativeSemanticVersionsWithTag.Clear();
+                continue;
+            }
+
             var baseVersionSource = semanticVersionWithTag.Tag.Commit;
             var increment = incrementStrategyFinder.DetermineIncrementedField(
                 currentCommit: Context.CurrentCommit,
@@ -58,6 +75,7 @@ private IEnumerable<BaseVersion> GetBaseVersionsInternal(EffectiveBranchConfigur
                 configuration: configuration.Value,
                 label: label
             );
+            semanticVersionTreshold = semanticVersionWithTag.Value.Increment(increment, null, forceIncrement: true);
 
             yield return new BaseVersion(
                 $"Git tag '{semanticVersionWithTag.Tag.Name.Friendly}'", semanticVersionWithTag.Value, baseVersionSource)
@@ -67,7 +85,7 @@ private IEnumerable<BaseVersion> GetBaseVersionsInternal(EffectiveBranchConfigur
                     Increment = increment,
                     ForceIncrement = false,
                     Label = label,
-                    AlternativeSemanticVersion = alternativeSemanticVersionsWithTag.Max()?.Value
+                    AlternativeSemanticVersion = alternativeSemanticVersionMax
                 }
             };
             alternativeSemanticVersionsWithTag.Clear();