Add CommitsSinceVersionSourceList to VariablesProvider.

9swampy · 9swampy · commit 0e5a247ab7e4 · 2025-07-01T00:51:19.000+01:00
diff --git a/src/GitVersion.Core.Tests/Extensions/GitRepositoryTestingExtensions.cs b/src/GitVersion.Core.Tests/Extensions/GitRepositoryTestingExtensions.cs
@@ -156,6 +156,29 @@ public static void AssertFullSemver(this RepositoryFixtureBase fixture, string f
         }
     }
 
+    public static void AssertCommitsSinceVersionSource(this RepositoryFixtureBase fixture, int commitsSinceVersionSourceExpected,
+        IGitVersionConfiguration? configuration = null, IRepository? repository = null, string? commitId = null, bool onlyTrackedBranches = true, string? targetBranch = null, string? customMessage = null)
+    {
+        repository ??= fixture.Repository;
+
+        var variables = GetVersion(fixture, configuration, repository, commitId, onlyTrackedBranches, targetBranch);
+        variables.CommitsSinceVersionSource.ShouldBe(commitsSinceVersionSourceExpected.ToString(), customMessage);
+        if (commitId == null)
+        {
+            var message = new StringBuilder($"CommitsSinceVersionSource:{commitsSinceVersionSourceExpected}");
+            if (variables.CommitsSinceVersionSourceList != null)
+            {
+                foreach (var sha in variables.CommitsSinceVersionSourceList)
+                {
+                    message.Append(System.Environment.NewLine);
+                    message.Append($"- {sha}");
+                }
+            }
+
+            fixture.SequenceDiagram.NoteOver(message.ToString(), repository.Head.FriendlyName, color: "#D3D3D3");
+        }
+    }
+
     /// <summary>
     /// Simulates running on build server
     /// </summary>
diff --git a/src/GitVersion.Core.Tests/Helpers/TestableGitVersionVariables.cs b/src/GitVersion.Core.Tests/Helpers/TestableGitVersionVariables.cs
@@ -26,4 +26,5 @@ internal record TestableGitVersionVariables() : GitVersionVariables("",
     "",
     "",
     "",
+    "",
     "");
diff --git a/src/GitVersion.Core.Tests/IntegrationTests/GitflowScenarios.cs b/src/GitVersion.Core.Tests/IntegrationTests/GitflowScenarios.cs
@@ -89,6 +89,7 @@ public void GitflowComplexExample()
         fixture.AssertFullSemver("1.2.1-2", configuration);
         fixture.ApplyTag("1.2.1");
         fixture.AssertFullSemver("1.2.1", configuration);
+        fixture.AssertCommitsSinceVersionSource(2, configuration);
         fixture.Checkout(developBranch);
         fixture.MergeNoFF(hotfixBranch);
         if (!keepBranches)
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/VersionSourceTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/VersionSourceTests.cs
@@ -24,6 +24,7 @@ public void VersionSourceSha()
         var semanticVersion = nextVersionCalculator.FindVersion();
 
         semanticVersion.BuildMetaData.VersionSourceSha.ShouldBeNull();
+        semanticVersion.BuildMetaData.CommitsSinceVersionSourceList.Length.ShouldBe((int)semanticVersion.BuildMetaData.CommitsSinceVersionSource);
         semanticVersion.BuildMetaData.CommitsSinceVersionSource.ShouldBe(3);
     }
 
@@ -39,6 +40,7 @@ public void VersionSourceShaOneCommit()
         var semanticVersion = nextVersionCalculator.FindVersion();
 
         semanticVersion.BuildMetaData.VersionSourceSha.ShouldBeNull();
+        semanticVersion.BuildMetaData.CommitsSinceVersionSourceList.Length.ShouldBe((int)semanticVersion.BuildMetaData.CommitsSinceVersionSource);
         semanticVersion.BuildMetaData.CommitsSinceVersionSource.ShouldBe(1);
     }
 
@@ -58,6 +60,9 @@ public void VersionSourceShaUsingTag()
         var semanticVersion = nextVersionCalculator.FindVersion();
 
         semanticVersion.BuildMetaData.VersionSourceSha.ShouldBe(secondCommitSha);
+#if DEBUG
+        semanticVersion.BuildMetaData.CommitsSinceVersionSourceList.Length.ShouldBe((int)semanticVersion.BuildMetaData.CommitsSinceVersionSource);
+#endif
         semanticVersion.BuildMetaData.CommitsSinceVersionSource.ShouldBe(1);
     }
 
diff --git a/src/GitVersion.Core/OutputVariables/GitVersionVariables.cs b/src/GitVersion.Core/OutputVariables/GitVersionVariables.cs
@@ -24,6 +24,7 @@ public record GitVersionVariables(string Major,
                                   string? CommitDate,
                                   string? VersionSourceSha,
                                   string? CommitsSinceVersionSource,
+                                  string? CommitsSinceVersionSourceList,
                                   string? UncommittedChanges) : IEnumerable<KeyValuePair<string, string?>>
 {
     internal static readonly List<string> AvailableVariables =
@@ -52,6 +53,7 @@ public record GitVersionVariables(string Major,
         nameof(CommitDate),
         nameof(VersionSourceSha),
         nameof(CommitsSinceVersionSource),
+        nameof(CommitsSinceVersionSourceList),
         nameof(UncommittedChanges)
     ];
 
@@ -81,6 +83,7 @@ public record GitVersionVariables(string Major,
         { nameof(CommitDate), CommitDate },
         { nameof(VersionSourceSha), VersionSourceSha },
         { nameof(CommitsSinceVersionSource), CommitsSinceVersionSource },
+        { nameof(CommitsSinceVersionSourceList), CommitsSinceVersionSourceList },
         { nameof(UncommittedChanges), UncommittedChanges }
     };
 
diff --git a/src/GitVersion.Core/PublicAPI.Shipped.txt b/src/GitVersion.Core/PublicAPI.Shipped.txt
@@ -426,14 +426,16 @@ GitVersion.OutputVariables.GitVersionVariables.CommitDate.get -> string?
 GitVersion.OutputVariables.GitVersionVariables.CommitDate.init -> void
 GitVersion.OutputVariables.GitVersionVariables.CommitsSinceVersionSource.get -> string?
 GitVersion.OutputVariables.GitVersionVariables.CommitsSinceVersionSource.init -> void
+GitVersion.OutputVariables.GitVersionVariables.CommitsSinceVersionSourceList.get -> string?
+GitVersion.OutputVariables.GitVersionVariables.CommitsSinceVersionSourceList.init -> void
 GitVersion.OutputVariables.GitVersionVariables.EscapedBranchName.get -> string?
 GitVersion.OutputVariables.GitVersionVariables.EscapedBranchName.init -> void
 GitVersion.OutputVariables.GitVersionVariables.FullBuildMetaData.get -> string?
 GitVersion.OutputVariables.GitVersionVariables.FullBuildMetaData.init -> void
 GitVersion.OutputVariables.GitVersionVariables.FullSemVer.get -> string!
 GitVersion.OutputVariables.GitVersionVariables.FullSemVer.init -> void
 GitVersion.OutputVariables.GitVersionVariables.GetEnumerator() -> System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<string!, string?>>!
-GitVersion.OutputVariables.GitVersionVariables.GitVersionVariables(string! Major, string! Minor, string! Patch, string? BuildMetaData, string? FullBuildMetaData, string? BranchName, string? EscapedBranchName, string? Sha, string? ShortSha, string! MajorMinorPatch, string! SemVer, string! FullSemVer, string? AssemblySemVer, string? AssemblySemFileVer, string? PreReleaseTag, string? PreReleaseTagWithDash, string? PreReleaseLabel, string? PreReleaseLabelWithDash, string? PreReleaseNumber, string! WeightedPreReleaseNumber, string? InformationalVersion, string? CommitDate, string? VersionSourceSha, string? CommitsSinceVersionSource, string? UncommittedChanges) -> void
+GitVersion.OutputVariables.GitVersionVariables.GitVersionVariables(string! Major, string! Minor, string! Patch, string? BuildMetaData, string? FullBuildMetaData, string? BranchName, string? EscapedBranchName, string? Sha, string? ShortSha, string! MajorMinorPatch, string! SemVer, string! FullSemVer, string? AssemblySemVer, string? AssemblySemFileVer, string? PreReleaseTag, string? PreReleaseTagWithDash, string? PreReleaseLabel, string? PreReleaseLabelWithDash, string? PreReleaseNumber, string! WeightedPreReleaseNumber, string? InformationalVersion, string? CommitDate, string? VersionSourceSha, string? CommitsSinceVersionSource, string? CommitsSinceVersionSourceList, string? UncommittedChanges) -> void
 GitVersion.OutputVariables.GitVersionVariables.InformationalVersion.get -> string?
 GitVersion.OutputVariables.GitVersionVariables.InformationalVersion.init -> void
 GitVersion.OutputVariables.GitVersionVariables.Major.get -> string!
@@ -520,6 +522,8 @@ GitVersion.SemanticVersionBuildMetaData.CommitsSinceTag.get -> long?
 GitVersion.SemanticVersionBuildMetaData.CommitsSinceTag.init -> void
 GitVersion.SemanticVersionBuildMetaData.CommitsSinceVersionSource.get -> long
 GitVersion.SemanticVersionBuildMetaData.CommitsSinceVersionSource.init -> void
+GitVersion.SemanticVersionBuildMetaData.CommitsSinceVersionSourceList.get -> string[]
+GitVersion.SemanticVersionBuildMetaData.CommitsSinceVersionSourceList.init -> void
 GitVersion.SemanticVersionBuildMetaData.Equals(GitVersion.SemanticVersionBuildMetaData? other) -> bool
 GitVersion.SemanticVersionBuildMetaData.OtherMetaData.get -> string?
 GitVersion.SemanticVersionBuildMetaData.OtherMetaData.init -> void
diff --git a/src/GitVersion.Core/PublicAPI.Unshipped.txt b/src/GitVersion.Core/PublicAPI.Unshipped.txt
@@ -11,10 +11,12 @@ GitVersion.Git.AuthenticationInfo.AuthenticationInfo() -> void
 GitVersion.Git.AuthenticationInfo.AuthenticationInfo(GitVersion.Git.AuthenticationInfo! original) -> void
 GitVersion.Git.CommitFilter.CommitFilter() -> void
 GitVersion.Git.CommitFilter.CommitFilter(GitVersion.Git.CommitFilter! original) -> void
-GitVersion.OutputVariables.GitVersionVariables.Deconstruct(out string! Major, out string! Minor, out string! Patch, out string? BuildMetaData, out string? FullBuildMetaData, out string? BranchName, out string? EscapedBranchName, out string? Sha, out string? ShortSha, out string! MajorMinorPatch, out string! SemVer, out string! FullSemVer, out string? AssemblySemVer, out string? AssemblySemFileVer, out string? PreReleaseTag, out string? PreReleaseTagWithDash, out string? PreReleaseLabel, out string? PreReleaseLabelWithDash, out string? PreReleaseNumber, out string! WeightedPreReleaseNumber, out string? InformationalVersion, out string? CommitDate, out string? VersionSourceSha, out string? CommitsSinceVersionSource, out string? UncommittedChanges) -> void
+GitVersion.OutputVariables.GitVersionVariables.Deconstruct(out string! Major, out string! Minor, out string! Patch, out string? BuildMetaData, out string? FullBuildMetaData, out string? BranchName, out string? EscapedBranchName, out string? Sha, out string? ShortSha, out string! MajorMinorPatch, out string! SemVer, out string! FullSemVer, out string? AssemblySemVer, out string? AssemblySemFileVer, out string? PreReleaseTag, out string? PreReleaseTagWithDash, out string? PreReleaseLabel, out string? PreReleaseLabelWithDash, out string? PreReleaseNumber, out string! WeightedPreReleaseNumber, out string? InformationalVersion, out string? CommitDate, out string? VersionSourceSha, out string? CommitsSinceVersionSource, out string? CommitsSinceVersionSourceList, out string? UncommittedChanges) -> void
 GitVersion.OutputVariables.GitVersionVariables.GitVersionVariables(GitVersion.OutputVariables.GitVersionVariables! original) -> void
 GitVersion.RepositoryInfo.RepositoryInfo() -> void
 GitVersion.RepositoryInfo.RepositoryInfo(GitVersion.RepositoryInfo! original) -> void
+GitVersion.SemanticVersionBuildMetaData.CommitsSinceVersionSourceList.get -> string![]!
+GitVersion.SemanticVersionFormatValues.CommitsSinceVersionSourceList.get -> string?
 GitVersion.SemanticVersionWithTag.<Clone>$() -> GitVersion.SemanticVersionWithTag!
 GitVersion.SemanticVersionWithTag.Deconstruct(out GitVersion.SemanticVersion! Value, out GitVersion.Git.ITag! Tag) -> void
 GitVersion.SemanticVersionWithTag.Equals(GitVersion.SemanticVersionWithTag? other) -> bool
diff --git a/src/GitVersion.Core/SemVer/SemanticVersionBuildMetaData.cs b/src/GitVersion.Core/SemVer/SemanticVersionBuildMetaData.cs
@@ -26,16 +26,46 @@ public class SemanticVersionBuildMetaData : IFormattable, IEquatable<SemanticVer
 
     public string? VersionSourceSha { get; init; }
 
-    public long CommitsSinceVersionSource { get; init; }
+    public long CommitsSinceVersionSource
+    {
+        get;
+        init;
+    }
+
+    public string[] CommitsSinceVersionSourceList
+    {
+        get;
+        init;
+    }
 
     public long UncommittedChanges { get; init; }
 
     public SemanticVersionBuildMetaData()
     {
     }
 
-    public SemanticVersionBuildMetaData(string? versionSourceSha, long? commitsSinceTag, string? branch, string? commitSha,
-        string? commitShortSha, DateTimeOffset? commitDate, long numberOfUnCommittedChanges, string? otherMetadata = null)
+    public SemanticVersionBuildMetaData(
+        string? versionSourceSha,
+        long? commitsSinceTag,
+        string? branch,
+        string? commitSha,
+        string? commitShortSha,
+        DateTimeOffset? commitDate,
+        long numberOfUnCommittedChanges,
+        string? otherMetadata = null)
+        : this(versionSourceSha, commitsSinceTag, branch, commitSha, commitShortSha, commitDate, numberOfUnCommittedChanges, otherMetadata, [])
+    { }
+
+    internal SemanticVersionBuildMetaData(
+        string? versionSourceSha,
+        long? commitsSinceTag,
+        string? branch,
+        string? commitSha,
+        string? commitShortSha,
+        DateTimeOffset? commitDate,
+        long numberOfUnCommittedChanges,
+        string? otherMetadata,
+        string[]? commitSinceTagList)
     {
         this.Sha = commitSha;
         this.ShortSha = commitShortSha;
@@ -45,6 +75,7 @@ public SemanticVersionBuildMetaData(string? versionSourceSha, long? commitsSince
         this.OtherMetaData = otherMetadata;
         this.VersionSourceSha = versionSourceSha;
         this.CommitsSinceVersionSource = commitsSinceTag ?? 0;
+        this.CommitsSinceVersionSourceList = commitsSinceTag == null ? [] : commitSinceTagList ?? [];
         this.UncommittedChanges = numberOfUnCommittedChanges;
     }
 
diff --git a/src/GitVersion.Core/VersionCalculation/SemanticVersioning/SemanticVersionFormatValues.cs b/src/GitVersion.Core/VersionCalculation/SemanticVersioning/SemanticVersionFormatValues.cs
@@ -55,5 +55,7 @@ public class SemanticVersionFormatValues(SemanticVersion semver, IGitVersionConf
 
     public string CommitsSinceVersionSource => semver.BuildMetaData.CommitsSinceVersionSource.ToString(CultureInfo.InvariantCulture);
 
+    public string? CommitsSinceVersionSourceList => string.Join(", ", semver.BuildMetaData.CommitsSinceVersionSourceList ?? []).ToString(CultureInfo.InvariantCulture);
+
     public string UncommittedChanges => semver.BuildMetaData.UncommittedChanges.ToString(CultureInfo.InvariantCulture);
 }
diff --git a/src/GitVersion.Core/VersionCalculation/VariableProvider.cs b/src/GitVersion.Core/VersionCalculation/VariableProvider.cs
@@ -63,6 +63,7 @@ public GitVersionVariables GetVariablesFor(
             semverFormatValues.CommitDate,
             semverFormatValues.VersionSourceSha,
             semverFormatValues.CommitsSinceVersionSource,
+            semverFormatValues.CommitsSinceVersionSourceList,
             semverFormatValues.UncommittedChanges
         );
     }
diff --git a/src/GitVersion.Core/VersionCalculation/VersionCalculators/ContinuousDeliveryVersionCalculator.cs b/src/GitVersion.Core/VersionCalculation/VersionCalculators/ContinuousDeliveryVersionCalculator.cs
@@ -35,6 +35,7 @@ private SemanticVersion CalculateInternal(SemanticVersion semanticVersion, IComm
             BuildMetaData = new SemanticVersionBuildMetaData(buildMetaData)
             {
                 CommitsSinceVersionSource = buildMetaData.CommitsSinceTag!.Value,
+                CommitsSinceVersionSourceList = buildMetaData.CommitsSinceVersionSourceList,
                 CommitsSinceTag = null
             }
         };
diff --git a/src/GitVersion.Core/VersionCalculation/VersionCalculators/VersionCalculatorBase.cs b/src/GitVersion.Core/VersionCalculation/VersionCalculators/VersionCalculatorBase.cs
@@ -33,7 +33,9 @@ protected SemanticVersionBuildMetaData CreateVersionBuildMetaData(ICommit? baseV
             commitSha: Context.CurrentCommit.Sha,
             commitShortSha: shortSha,
             commitDate: Context.CurrentCommit.When,
-            numberOfUnCommittedChanges: Context.NumberOfUncommittedChanges
+            numberOfUnCommittedChanges: Context.NumberOfUncommittedChanges,
+            otherMetadata: null,
+            commitSinceTagList: [.. commitLogs.Select(c => c.Sha)]
         );
     }
 }

-Original file line number
+Diff line change
     "",
     "",
     "",
 +    "",
     "");
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ public void VersionSourceSha()`
`24`	`24`	`var semanticVersion = nextVersionCalculator.FindVersion();`
`25`	`25`
`26`	`26`	`semanticVersion.BuildMetaData.VersionSourceSha.ShouldBeNull();`
	`27`	`+ semanticVersion.BuildMetaData.CommitsSinceVersionSourceList.Length.ShouldBe((int)semanticVersion.BuildMetaData.CommitsSinceVersionSource);`
`27`	`28`	`semanticVersion.BuildMetaData.CommitsSinceVersionSource.ShouldBe(3);`
`28`	`29`	`}`
`29`	`30`
`@@ -39,6 +40,7 @@ public void VersionSourceShaOneCommit()`
`39`	`40`	`var semanticVersion = nextVersionCalculator.FindVersion();`
`40`	`41`
`41`	`42`	`semanticVersion.BuildMetaData.VersionSourceSha.ShouldBeNull();`
	`43`	`+ semanticVersion.BuildMetaData.CommitsSinceVersionSourceList.Length.ShouldBe((int)semanticVersion.BuildMetaData.CommitsSinceVersionSource);`
`42`	`44`	`semanticVersion.BuildMetaData.CommitsSinceVersionSource.ShouldBe(1);`
`43`	`45`	`}`
`44`	`46`
`@@ -58,6 +60,9 @@ public void VersionSourceShaUsingTag()`
`58`	`60`	`var semanticVersion = nextVersionCalculator.FindVersion();`
`59`	`61`
`60`	`62`	`semanticVersion.BuildMetaData.VersionSourceSha.ShouldBe(secondCommitSha);`
	`63`	`+#if DEBUG`
	`64`	`+ semanticVersion.BuildMetaData.CommitsSinceVersionSourceList.Length.ShouldBe((int)semanticVersion.BuildMetaData.CommitsSinceVersionSource);`
	`65`	`+#endif`
`61`	`66`	`semanticVersion.BuildMetaData.CommitsSinceVersionSource.ShouldBe(1);`
`62`	`67`	`}`
`63`	`68`
Original file line number	Diff line number	Diff line change
`@@ -55,5 +55,7 @@ public class SemanticVersionFormatValues(SemanticVersion semver, IGitVersionConf`
`55`	`55`
`56`	`56`	`public string CommitsSinceVersionSource => semver.BuildMetaData.CommitsSinceVersionSource.ToString(CultureInfo.InvariantCulture);`
`57`	`57`
	`58`	`+ public string? CommitsSinceVersionSourceList => string.Join(", ", semver.BuildMetaData.CommitsSinceVersionSourceList ?? []).ToString(CultureInfo.InvariantCulture);`
	`59`	`+`
`58`	`60`	`public string UncommittedChanges => semver.BuildMetaData.UncommittedChanges.ToString(CultureInfo.InvariantCulture);`
`59`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,7 @@ public GitVersionVariables GetVariablesFor(`
`63`	`63`	`semverFormatValues.CommitDate,`
`64`	`64`	`semverFormatValues.VersionSourceSha,`
`65`	`65`	`semverFormatValues.CommitsSinceVersionSource,`
	`66`	`+ semverFormatValues.CommitsSinceVersionSourceList,`
`66`	`67`	`semverFormatValues.UncommittedChanges`
`67`	`68`	`);`
`68`	`69`	`}`