The Calculation of BaseVersions should be based on tags first, then merge commits

Author: ni-fgenois

src/GitVersion.Core.Tests/Core/DynamicRepositoryTests.cs

@@ -52,8 +52,8 @@ public void Cleanup()
 
         // Note: use same name twice to see if changing commits works on same (cached) repository
         [NonParallelizable]
-        [TestCase("GV_main", "https://github.com/GitTools/GitVersion", MainBranch, "4783d325521463cd6cf1b61074352da84451f25d", "4.0.0+1086")]
-        [TestCase("GV_main", "https://github.com/GitTools/GitVersion", MainBranch, "3bdcd899530b4e9b37d13639f317da04a749e728", "4.0.0+1092")]
+        [TestCase("GV_main", "https://github.com/GitTools/GitVersion", MainBranch, "4783d325521463cd6cf1b61074352da84451f25d", "4.0.0+862")]
+        [TestCase("GV_main", "https://github.com/GitTools/GitVersion", MainBranch, "3bdcd899530b4e9b37d13639f317da04a749e728", "4.0.0+868")]
         public void FindsVersionInDynamicRepo(string name, string url, string targetBranch, string commitId, string expectedFullSemVer)
         {
             var root = Path.Combine(this.workDirectory, name);

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

@@ -229,11 +229,11 @@ public void CommitsSinceVersionSourceShouldNotGoDownUponGitFlowReleaseFinish()
             fixture.Checkout("develop");
             fixture.MergeNoFF("release/1.2.0");
             fixture.MakeACommit("commit in develop - 6");
-            fixture.AssertFullSemver("1.3.0-alpha.9");
+            fixture.AssertFullSemver("1.3.0-alpha.6");
             fixture.SequenceDiagram.Destroy("release/1.2.0");
             fixture.Repository.Branches.Remove("release/1.2.0");
 
-            var expectedFullSemVer = "1.3.0-alpha.9";
+            var expectedFullSemVer = "1.3.0-alpha.6";
             fixture.AssertFullSemver(expectedFullSemVer, config);
         }
 
@@ -261,11 +261,11 @@ public void CommitsSinceVersionSourceShouldNotGoDownUponMergingFeatureOnlyToDeve
             fixture.MakeACommit("commit in develop - 2");
             fixture.AssertFullSemver("1.3.0-alpha.1");
             fixture.MergeNoFF("release/1.2.0");
-            fixture.AssertFullSemver("1.3.0-alpha.5");
+            fixture.AssertFullSemver("1.3.0-alpha.2");
             fixture.SequenceDiagram.Destroy("release/1.2.0");
             fixture.Repository.Branches.Remove("release/1.2.0");
 
-            var expectedFullSemVer = "1.3.0-alpha.5";
+            var expectedFullSemVer = "1.3.0-alpha.2";
             fixture.AssertFullSemver(expectedFullSemVer, config);
         }
 
@@ -318,16 +318,16 @@ public void WhenPreventIncrementOfMergedBranchVersionIsSetToFalseForDevelopCommi
             fixture.MergeNoFF(ReleaseBranch);
 
             // Version numbers will still be correct when the release branch is around.
-            fixture.AssertFullSemver("1.2.0-alpha.6");
-            fixture.AssertFullSemver("1.2.0-alpha.6", config);
+            fixture.AssertFullSemver("1.2.0-alpha.3");
+            fixture.AssertFullSemver("1.2.0-alpha.3", config);
 
             var versionSourceBeforeReleaseBranchIsRemoved = fixture.GetVersion(config).Sha;
 
             fixture.Repository.Branches.Remove(ReleaseBranch);
             var versionSourceAfterReleaseBranchIsRemoved = fixture.GetVersion(config).Sha;
             Assert.AreEqual(versionSourceBeforeReleaseBranchIsRemoved, versionSourceAfterReleaseBranchIsRemoved);
-            fixture.AssertFullSemver("1.2.0-alpha.6");
-            fixture.AssertFullSemver("1.2.0-alpha.6", config);
+            fixture.AssertFullSemver("1.2.0-alpha.3");
+            fixture.AssertFullSemver("1.2.0-alpha.3", config);
 
             config.Branches = new Dictionary<string, BranchConfig>
             {
@@ -370,12 +370,13 @@ public void WhenPreventIncrementOfMergedBranchVersionIsSetToFalseForDevelopCommi
             fixture.MergeNoFF(ReleaseBranch);
             fixture.ApplyTag("v1.1.0");
             fixture.Checkout("develop");
+            fixture.AssertFullSemver("1.2.0-alpha.0", config);
 
             // Simulate some work done on develop while the release branch was open.
             fixture.Repository.MakeCommits(2);
             fixture.MergeNoFF(ReleaseBranch);
             fixture.Repository.Branches.Remove(ReleaseBranch);
-            fixture.AssertFullSemver("1.2.0-alpha.6", config);
+            fixture.AssertFullSemver("1.2.0-alpha.3", config);
 
             // Create hotfix for defects found in release/1.1.0
             const string HotfixBranch = "hotfix/1.1.1";
@@ -392,12 +393,12 @@ public void WhenPreventIncrementOfMergedBranchVersionIsSetToFalseForDevelopCommi
             fixture.Checkout("develop");
             // Simulate some work done on develop while the hotfix branch was open.
             fixture.Repository.MakeCommits(3);
-            fixture.AssertFullSemver("1.2.0-alpha.9", config);
+            fixture.AssertFullSemver("1.2.0-alpha.6", config);
             fixture.Repository.MergeNoFF(HotfixBranch);
-            fixture.AssertFullSemver("1.2.0-alpha.19", config);
+            fixture.AssertFullSemver("1.2.0-alpha.10", config);
 
             fixture.Repository.Branches.Remove(HotfixBranch);
-            fixture.AssertFullSemver("1.2.0-alpha.19", config);
+            fixture.AssertFullSemver("1.2.0-alpha.10", config);
         }
     }
 }

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

@@ -156,7 +156,7 @@ public void GitFlowMinorRelease()
 
             // Not 0 for commit count as we can't know the increment rules of the merged branch
             fixture.Checkout("develop");
-            fixture.AssertFullSemver("1.4.0-alpha.4");
+            fixture.AssertFullSemver("1.4.0-alpha.2");
             Console.WriteLine(fixture.SequenceDiagram.GetDiagram());
         }
 
@@ -212,7 +212,7 @@ public void GitFlowMajorRelease()
 
             // Not 0 for commit count as we can't know the increment rules of the merged branch
             fixture.Checkout("develop");
-            fixture.AssertFullSemver("2.1.0-alpha.4");
+            fixture.AssertFullSemver("2.1.0-alpha.2");
             Console.WriteLine(fixture.SequenceDiagram.GetDiagram());
         }
 

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

@@ -48,12 +48,13 @@ public void NoMergeBacksToDevelopInCaseThereAreChangesInReleaseBranch()
             // Merge to develop
             fixture.Checkout("develop");
             fixture.Repository.MergeNoFF("release/1.0.0");
-            fixture.AssertFullSemver("1.1.0-alpha.2");
+            fixture.AssertFullSemver("1.1.0-alpha.1");
 
             fixture.Repository.MakeACommit();
+            fixture.AssertFullSemver("1.1.0-alpha.2");
             fixture.Repository.Branches.Remove("release/1.0.0");
 
-            fixture.AssertFullSemver("1.1.0-alpha.3");
+            fixture.AssertFullSemver("1.1.0-alpha.2");
         }
 
         [Test]

src/GitVersion.Core/VersionCalculation/BaseVersionCalculator.cs

@@ -58,11 +58,40 @@ public BaseVersion GetBaseVersion()
                 BaseVersion baseVersionWithOldestSource;
                 if (matchingVersionsOnceIncremented.Any())
                 {
-                    var oldest = matchingVersionsOnceIncremented.Aggregate((v1, v2) =>
-                        v1.Version!.BaseVersionSource!.When < v2.Version!.BaseVersionSource!.When ? v1 : v2);
-                    baseVersionWithOldestSource = oldest!.Version!;
-                    maxVersion = oldest;
-                    this.log.Info($"Found multiple base versions which will produce the same SemVer ({maxVersion.IncrementedVersion}), taking oldest source for commit counting ({baseVersionWithOldestSource!.Source})");
+                    if (matchingVersionsOnceIncremented.Count > 1)
+                    {
+                        log.Info($"Found multiple base versions which will produce the same SemVer ({maxVersion.IncrementedVersion})");
+                        log.Info($"Here are the different source candidate for commit counting : ");
+                        foreach (var baseVersion in matchingVersionsOnceIncremented.Select(b => b.Version))
+                        {
+                            if (baseVersion != null)
+                            {
+                                log.Info($" - {BaseVersionToString(baseVersion)}");
+                            }
+                        }
+
+                        var tagVersions = matchingVersionsOnceIncremented.FindAll(b => b.Version != null && b.Version.Source.Contains("Git tag"));
+
+                        if (tagVersions.Count > 0)
+                        {
+                            log.Info("As there are Git tags, the other sources will be discarded");
+                            matchingVersionsOnceIncremented = tagVersions;
+                        }
+
+                        maxVersion = matchingVersionsOnceIncremented.Aggregate((v1, v2) =>
+                            v1.Version!.BaseVersionSource!.When < v2.Version!.BaseVersionSource!.When ? v1 : v2);
+                        baseVersionWithOldestSource = maxVersion!.Version!;
+                        log.Info($"Taking oldest source for commit counting : {BaseVersionToString(baseVersionWithOldestSource)}");
+                    }
+                    else
+                    {
+                        maxVersion = matchingVersionsOnceIncremented.First();
+                        baseVersionWithOldestSource = maxVersion!.Version!;
+                        log.Info(
+                        $"Found a base versions which will produce the following SemVer ({maxVersion.IncrementedVersion}), " +
+                              $"with the following source for commit counting : {BaseVersionToString(baseVersionWithOldestSource)}"
+                        );
+                    }
                 }
                 else
                 {
@@ -81,11 +110,17 @@ public BaseVersion GetBaseVersion()
                     maxVersion.Version!.Source, maxVersion.Version.ShouldIncrement, maxVersion.Version.SemanticVersion,
                     baseVersionWithOldestSource.BaseVersionSource, maxVersion.Version.BranchNameOverride);
 
-                this.log.Info($"Base version used: {calculatedBase}");
+                log.Info($"Base version used: {calculatedBase}");
 
                 return calculatedBase;
             }
         }
+
+        private string BaseVersionToString(BaseVersion baseVersion)
+        {
+            return $"{baseVersion!.Source} ({baseVersion!.BaseVersionSource!.Sha})";
+        }
+
         private IEnumerable<BaseVersion> GetBaseVersions(IVersionStrategy strategy)
         {
             foreach (var version in strategy.GetVersions())