Fix bug: VersionInBranchNameVersionStrategy only considers the release branch

HHobeck · HHobeck · commit 4531e3cb8be6 · 2023-04-04T20:14:55.000+02:00
diff --git a/docs/input/docs/reference/configuration.md b/docs/input/docs/reference/configuration.md
@@ -43,6 +43,7 @@ The global configuration looks like this:
 assembly-versioning-scheme: MajorMinorPatch
 assembly-file-versioning-scheme: MajorMinorPatch
 label-prefix: '[vV]?'
+version-in-branch-pattern: '(?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*'
 major-version-bump-message: '\+semver:\s?(breaking|major)'
 minor-version-bump-message: '\+semver:\s?(feature|minor)'
 patch-version-bump-message: '\+semver:\s?(fix|patch)'
@@ -258,9 +259,12 @@ and [tracks-release-branches](#tracks-release-branches).
 
 ### label-prefix
 
-A regex which is used to trim Git tags before processing (e.g., v1.0.0). Default
-is `[vV]`, although this is just for illustrative purposes as we do a IgnoreCase
-match and could be `v`.
+A regular expression which is used to trim Git tags before processing (e.g., v1.0.0). The default value is `[vV]`.
+
+### version-in-branch-pattern
+
+A regular expression which is used to determine the version number in the branch name or commit message (e.g., v1.0.0-LTS). 
+The default value is `(?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*`.
 
 ### major-version-bump-message
 
diff --git a/src/GitVersion.Core.Tests/Configuration/ConfigurationProviderTests.CanWriteOutEffectiveConfiguration.approved.txt b/src/GitVersion.Core.Tests/Configuration/ConfigurationProviderTests.CanWriteOutEffectiveConfiguration.approved.txt
@@ -1,6 +1,7 @@
 assembly-versioning-scheme: MajorMinorPatch
 assembly-file-versioning-scheme: MajorMinorPatch
 label-prefix: '[vV]?'
+version-in-branch-pattern: (?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*
 major-version-bump-message: '\+semver:\s?(breaking|major)'
 minor-version-bump-message: '\+semver:\s?(feature|minor)'
 patch-version-bump-message: '\+semver:\s?(fix|patch)'
@@ -94,6 +95,7 @@ branches:
     - support
     - hotfix
     is-source-branch-for: []
+    is-release-branch: true
     pre-release-weight: 30000
   support:
     label: ''
diff --git a/src/GitVersion.Core.Tests/IntegrationTests/OtherBranchScenarios.cs b/src/GitVersion.Core.Tests/IntegrationTests/OtherBranchScenarios.cs
@@ -33,14 +33,19 @@ public void ShouldOnlyConsiderTagsMatchingOfCurrentBranch()
     [Test]
     public void CanTakeVersionFromReleaseBranch()
     {
+        var configuration = GitFlowConfigurationBuilder.New
+            .WithBranch("release", _ => _.WithLabel("{BranchName}"))
+            .Build();
+
         using var fixture = new EmptyRepositoryFixture();
+
         const string taggedVersion = "1.0.3";
         fixture.Repository.MakeATaggedCommit(taggedVersion);
         fixture.Repository.MakeCommits(5);
-        fixture.Repository.CreateBranch("release/beta-2.0.0");
-        Commands.Checkout(fixture.Repository, "release/beta-2.0.0");
+        fixture.Repository.CreateBranch("release/2.0.0-LTS");
+        Commands.Checkout(fixture.Repository, "release/2.0.0-LTS");
 
-        fixture.AssertFullSemver("2.0.0-beta.1+0");
+        fixture.AssertFullSemver("2.0.0-LTS.1+0", configuration);
     }
 
     [Test]
diff --git a/src/GitVersion.Core.Tests/MergeMessageTests.cs b/src/GitVersion.Core.Tests/MergeMessageTests.cs
@@ -111,11 +111,11 @@ public void ParsesGitHubPullMergeMessage(
 
     private static readonly object?[] BitBucketPullMergeMessages =
     {
-        new object?[] { "Merge pull request #1234 from feature/one from feature/two to dev", "feature/two", "dev", null, 1234  },
+        new object?[] { "Merge pull request #1234 from feature/one from feature/two to dev", "feature/two", "dev", null, 1234 },
         new object?[] { "Merge pull request #1234 in feature/one from feature/two to dev", "feature/two", "dev", null, 1234 },
-        new object?[] { "Merge pull request #1234 in v4.0.0 from v4.1.0 to dev", "v4.1.0", "dev", new SemanticVersion(4,1), 1234  },
-        new object?[] { "Merge pull request #1234 from origin/feature/one from origin/feature/4.2.0/two to dev", "origin/feature/4.2.0/two", "dev", new SemanticVersion(4,2), 1234  },
-        new object?[] { "Merge pull request #1234 in feature/4.1.0/one from feature/4.2.0/two to dev", "feature/4.2.0/two", "dev", new SemanticVersion(4,2), 1234  },
+        new object?[] { "Merge pull request #1234 in v4.0.0 from v4.1.0 to dev", "v4.1.0", "dev", new SemanticVersion(4,1), 1234 },
+        new object?[] { "Merge pull request #1234 from origin/feature/one from origin/feature/4.2.0/two to dev", "origin/feature/4.2.0/two", "dev", new SemanticVersion(4,2), 1234 },
+        new object?[] { "Merge pull request #1234 in feature/4.1.0/one from feature/4.2.0/two to dev", "feature/4.2.0/two", "dev", new SemanticVersion(4,2), 1234 },
         new object?[] { $"Merge pull request #1234 from feature/one from feature/two to {MainBranch}" , "feature/two", MainBranch, null, 1234 },
         new object?[] { "Merge pull request #1234 in V4.1.0 from V://10.10.10.10 to dev", "V://10.10.10.10", "dev", null, 1234 },
         //TODO: Investigate successful bitbucket merge messages that may be invalid
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Strategies/MergeMessageBaseVersionStrategyTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/Strategies/MergeMessageBaseVersionStrategyTests.cs
@@ -75,14 +75,7 @@ public void TakesVersionFromMergeOfReleaseBranch(string message, bool isMergeCom
     [TestCase("Merge branch '4.0.3'", true)]
     [TestCase("Merge branch 's'", true)]
     [TestCase("Merge tag '10.10.50'", true)]
-    [TestCase("Merge branch 'hotfix-4.6.6' into support-4.6", true)]
-    [TestCase("Merge branch 'hotfix-10.10.50'", true)]
-    [TestCase("Merge branch 'Hotfix-10.10.50'", true)]
-    [TestCase("Merge branch 'Hotfix/10.10.50'", true)]
-    [TestCase("Merge branch 'hotfix-0.1.5'", true)]
-    [TestCase("Merge branch 'hotfix-4.2.2' into support-4.2", true)]
     [TestCase("Merge branch 'somebranch' into release-3.0.0", true)]
-    [TestCase("Merge branch 'hotfix-0.1.5'\n\nRelates to: TicketId", true)]
     [TestCase("Merge branch 'alpha-0.1.5'", true)]
     [TestCase("Merge pull request #95 from Particular/issue-94", false)]
     [TestCase("Merge pull request #95 in Particular/issue-94", true)]
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Strategies/VersionInBranchNameBaseVersionStrategyTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/Strategies/VersionInBranchNameBaseVersionStrategyTests.cs
@@ -33,10 +33,10 @@ public void CanTakeVersionFromNameOfReleaseBranch(string branchName, string expe
         baseVersion.SemanticVersion.ToString().ShouldBe(expectedBaseVersion);
     }
 
-    [TestCase("hotfix-2.0.0")]
+    //[TestCase("hotfix-2.0.0")]
     [TestCase("origin/hotfix-2.0.0")]
     [TestCase("remotes/origin/hotfix-2.0.0")]
-    [TestCase("hotfix/2.0.0")]
+    //[TestCase("hotfix/2.0.0")]
     [TestCase("origin/hotfix/2.0.0")]
     [TestCase("remotes/origin/hotfix/2.0.0")]
     [TestCase("custom/JIRA-123")]
@@ -68,7 +68,7 @@ public void ShouldNotTakeVersionFromNameOfNonReleaseBranch(string branchName)
 
     [TestCase("release-2.0.0", "2.0.0")]
     [TestCase("release/3.0.0", "3.0.0")]
-    [TestCase("support/lts-2.0.0", "2.0.0")]
+    [TestCase("support/2.0.0-lts", "2.0.0")]
     [TestCase("support-3.0.0-lts", "3.0.0")]
     public void CanTakeVersionFromNameOfConfiguredReleaseBranch(string branchName, string expectedBaseVersion)
     {
@@ -80,6 +80,7 @@ public void CanTakeVersionFromNameOfConfiguredReleaseBranch(string branchName, s
         var repository = fixture.Repository.ToGitRepository();
 
         var configuration = GitFlowConfigurationBuilder.New
+            .WithLabelPrefix("([vV]|lts-)?")
             .WithBranch("support", builder => builder.WithIsReleaseBranch(true))
             .Build();
         ConfigurationHelper configurationHelper = new(configuration);
diff --git a/src/GitVersion.Core/Configuration/ConfigurationBuilderBase.cs b/src/GitVersion.Core/Configuration/ConfigurationBuilderBase.cs
@@ -12,6 +12,7 @@ internal abstract class ConfigurationBuilderBase<TConfigurationBuilder> : IConfi
     private string? assemblyVersioningFormat;
     private string? assemblyFileVersioningFormat;
     private string? labelPrefix;
+    private string? versionInBranchPattern;
     private string? nextVersion;
     private string? majorVersionBumpMessage;
     private string? minorVersionBumpMessage;
@@ -131,6 +132,12 @@ public virtual TConfigurationBuilder WithLabelPrefix(string? value)
         return (TConfigurationBuilder)this;
     }
 
+    public virtual TConfigurationBuilder WithVersionInBranchPattern(string? value)
+    {
+        this.versionInBranchPattern = value;
+        return (TConfigurationBuilder)this;
+    }
+
     public virtual TConfigurationBuilder WithNextVersion(string? value)
     {
         this.nextVersion = value;
@@ -302,6 +309,7 @@ public virtual TConfigurationBuilder WithConfiguration(IGitVersionConfiguration
         WithAssemblyVersioningFormat(value.AssemblyVersioningFormat);
         WithAssemblyFileVersioningFormat(value.AssemblyFileVersioningFormat);
         WithLabelPrefix(value.LabelPrefix);
+        WithVersionInBranchPattern(value.VersionInBranchPattern);
         WithNextVersion(value.NextVersion);
         WithMajorVersionBumpMessage(value.MajorVersionBumpMessage);
         WithMinorVersionBumpMessage(value.MinorVersionBumpMessage);
@@ -357,6 +365,7 @@ public virtual IGitVersionConfiguration Build()
             AssemblyVersioningFormat = this.assemblyVersioningFormat,
             AssemblyFileVersioningFormat = this.assemblyFileVersioningFormat,
             LabelPrefix = this.labelPrefix,
+            VersionInBranchPattern = this.versionInBranchPattern,
             NextVersion = this.nextVersion,
             MajorVersionBumpMessage = this.majorVersionBumpMessage,
             MinorVersionBumpMessage = this.minorVersionBumpMessage,
diff --git a/src/GitVersion.Core/Configuration/ConfigurationConstants.cs b/src/GitVersion.Core/Configuration/ConfigurationConstants.cs
@@ -3,6 +3,7 @@ namespace GitVersion.Configuration;
 internal static class ConfigurationConstants
 {
     public const string DefaultLabelPrefix = "[vV]?";
+    public const string DefaultVersionInBranchPattern = @"(?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*";
     public const string BranchNamePlaceholder = "{BranchName}";
 
     public const string MainBranchKey = "main";
diff --git a/src/GitVersion.Core/Configuration/EffectiveConfiguration.cs b/src/GitVersion.Core/Configuration/EffectiveConfiguration.cs
@@ -1,3 +1,4 @@
+using System.Text.RegularExpressions;
 using GitVersion.Extensions;
 using GitVersion.VersionCalculation;
 
@@ -39,6 +40,7 @@ public EffectiveConfiguration(IGitVersionConfiguration configuration, IBranchCon
         AssemblyFileVersioningFormat = configuration.AssemblyFileVersioningFormat;
         VersioningMode = branchConfiguration.VersioningMode.Value;
         LabelPrefix = configuration.LabelPrefix;
+        VersionInBranchRegex = configuration.VersionInBranchRegex;
         Label = branchConfiguration.Label;
         NextVersion = configuration.NextVersion;
         Increment = branchConfiguration.Increment;
@@ -137,6 +139,8 @@ protected EffectiveConfiguration(AssemblyVersioningScheme assemblyVersioningSche
     /// </summary>
     public string? LabelPrefix { get; }
 
+    public Regex VersionInBranchRegex { get; }
+
     /// <summary>
     ///     Label to use when calculating SemVer
     /// </summary>
diff --git a/src/GitVersion.Core/Configuration/GitFlowConfigurationBuilder.cs b/src/GitVersion.Core/Configuration/GitFlowConfigurationBuilder.cs
@@ -20,6 +20,7 @@ private GitFlowConfigurationBuilder()
             PatchVersionBumpMessage = IncrementStrategyFinder.DefaultPatchPattern,
             SemanticVersionFormat = SemanticVersionFormat.Strict,
             LabelPrefix = ConfigurationConstants.DefaultLabelPrefix,
+            VersionInBranchPattern = ConfigurationConstants.DefaultVersionInBranchPattern,
             LabelPreReleaseWeight = 60000,
             UpdateBuildNumber = true,
             VersioningMode = VersioningMode.ContinuousDelivery,
@@ -133,6 +134,7 @@ private GitFlowConfigurationBuilder()
                 HotfixBranch.Name
             },
             Label = "beta",
+            IsReleaseBranch = true,
             PreReleaseWeight = 30000
         });
 
diff --git a/src/GitVersion.Core/Configuration/GitHubFlowConfigurationBuilder.cs b/src/GitVersion.Core/Configuration/GitHubFlowConfigurationBuilder.cs
@@ -20,6 +20,7 @@ private GitHubFlowConfigurationBuilder()
             PatchVersionBumpMessage = IncrementStrategyFinder.DefaultPatchPattern,
             SemanticVersionFormat = SemanticVersionFormat.Strict,
             LabelPrefix = ConfigurationConstants.DefaultLabelPrefix,
+            VersionInBranchPattern = ConfigurationConstants.DefaultVersionInBranchPattern,
             LabelPreReleaseWeight = 60000,
             UpdateBuildNumber = true,
             VersioningMode = VersioningMode.ContinuousDelivery,
diff --git a/src/GitVersion.Core/Configuration/GitVersionConfiguration.cs b/src/GitVersion.Core/Configuration/GitVersionConfiguration.cs
@@ -1,4 +1,5 @@
 using System.Globalization;
+using System.Text.RegularExpressions;
 using GitVersion.Attributes;
 using GitVersion.Extensions;
 
@@ -34,6 +35,21 @@ internal sealed record GitVersionConfiguration : BranchConfiguration, IGitVersio
     [JsonPropertyDescription($"A regular expression which is used to trim Git tags before processing. Defaults to {ConfigurationConstants.DefaultLabelPrefix}")]
     public string? LabelPrefix { get; internal set; }
 
+    [JsonPropertyName("version-in-branch-pattern")]
+    [JsonPropertyDescription($"A regular expression which is used to determine the version number in the branch name or commit message (e.g., v1.0.0-LTS). The default value is '{ConfigurationConstants.DefaultVersionInBranchPattern}'.")]
+    public string? VersionInBranchPattern { get; internal set; }
+
+    [JsonIgnore]
+    public Regex VersionInBranchRegex => versionInBranchRegex ??= new Regex(GetVersionInBranchPattern(), RegexOptions.Compiled);
+    private Regex? versionInBranchRegex;
+
+    private string GetVersionInBranchPattern()
+    {
+        var versionInBranchPattern = VersionInBranchPattern;
+        if (versionInBranchPattern.IsNullOrEmpty()) versionInBranchPattern = ConfigurationConstants.DefaultVersionInBranchPattern;
+        return $"^{versionInBranchPattern.TrimStart('^')}";
+    }
+
     [JsonPropertyName("next-version")]
     [JsonPropertyDescription("Allows you to bump the next version explicitly. Useful for bumping main or a feature branch with breaking changes")]
     public string? NextVersion
diff --git a/src/GitVersion.Core/Configuration/IGitVersionConfiguration.cs b/src/GitVersion.Core/Configuration/IGitVersionConfiguration.cs
@@ -1,3 +1,4 @@
+using System.Text.RegularExpressions;
 using GitVersion.Extensions;
 
 namespace GitVersion.Configuration;
@@ -18,6 +19,10 @@ public interface IGitVersionConfiguration : IBranchConfiguration
 
     string? LabelPrefix { get; }
 
+    string? VersionInBranchPattern { get; }
+
+    Regex VersionInBranchRegex { get; }
+
     string? NextVersion { get; }
 
     string? MajorVersionBumpMessage { get; }
diff --git a/src/GitVersion.Core/Git/ReferenceName.cs b/src/GitVersion.Core/Git/ReferenceName.cs
@@ -1,4 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
+using System.Diagnostics.Contracts;
+using System.Text.RegularExpressions;
 using GitVersion.Extensions;
 using GitVersion.Helpers;
 
@@ -104,7 +106,39 @@ private string RemoveOrigin()
         return Friendly;
     }
 
+    private char GetBranchSeparator() => WithoutOrigin.Contains('/') || !WithoutOrigin.Contains('-') ? '/' : '-';
+
     private static bool IsPrefixedBy(string input, string prefix) => input.StartsWith(prefix, StringComparison.Ordinal);
 
     private static bool IsPrefixedBy(string input, string[] prefixes) => prefixes.Any(prefix => IsPrefixedBy(input, prefix));
+
+    public bool TryGetSemanticVersion([NotNullWhen(true)] out (SemanticVersion Value, string? Name) result,
+        Regex versionPatternRegex, string? labelPrefix, SemanticVersionFormat format)
+    {
+        result = default;
+
+        Contract.Assume(versionPatternRegex.ToString().StartsWith("^"));
+
+        int length = 0;
+        foreach (var branchPart in WithoutOrigin.Split(GetBranchSeparator()))
+        {
+            if (branchPart.IsNullOrEmpty()) return false;
+
+            var match = versionPatternRegex.NotNull().Match(branchPart);
+            if (match.Success)
+            {
+                var versionPart = match.Groups["version"].Value;
+                if (SemanticVersion.TryParse(versionPart, labelPrefix, out var semanticVersion, format))
+                {
+                    length += versionPart.Length;
+                    var name = WithoutOrigin[length..].Trim('-');
+                    result = new(semanticVersion, name.IsEmpty() ? null : name);
+                    return true;
+                }
+            }
+            length += branchPart.Length + 1;
+        }
+
+        return false;
+    }
 }
diff --git a/src/GitVersion.Core/MergeMessage.cs b/src/GitVersion.Core/MergeMessage.cs
@@ -48,7 +48,9 @@ public MergeMessage(string mergeMessage, IGitVersionConfiguration configuration)
                 PullRequestNumber = pullNumber;
             }
 
-            Version = ParseVersion(configuration.LabelPrefix, configuration.SemanticVersionFormat);
+            Version = ParseVersion(
+                configuration.VersionInBranchRegex, configuration.LabelPrefix, configuration.SemanticVersionFormat
+            )?.Value;
 
             break;
         }
@@ -62,22 +64,11 @@ public MergeMessage(string mergeMessage, IGitVersionConfiguration configuration)
     public int? PullRequestNumber { get; }
     public SemanticVersion? Version { get; }
 
-    private SemanticVersion? ParseVersion(string? tagPrefix, SemanticVersionFormat versionFormat)
+    private (SemanticVersion Value, string? Name)? ParseVersion(
+        Regex versionPatternRegex, string? labelPrefix, SemanticVersionFormat format)
     {
-        if (tagPrefix is null || MergedBranch is null)
-            return null;
-        // Remove remotes and branch prefixes like release/ feature/ hotfix/ etc
-        var toMatch = Regex.Replace(MergedBranch.WithoutOrigin, @"^(\w+[-/])*", "", RegexOptions.IgnoreCase);
-        toMatch = Regex.Replace(toMatch, $"^{tagPrefix}", "");
-        // We don't match if the version is likely an ip (i.e starts with http://)
-        var versionMatch = new Regex(@"^(?<!://)\d+\.\d+(\.*\d+)*");
-        var version = versionMatch.Match(toMatch);
-
-        if (version.Success && SemanticVersion.TryParse(version.Value, tagPrefix, out var val, versionFormat))
-        {
-            return val;
-        }
-
+        if (MergedBranch?.TryGetSemanticVersion(out var result, versionPatternRegex, labelPrefix, format) == true)
+            return result;
         return null;
     }
 
diff --git a/src/GitVersion.Core/VersionCalculation/BaseVersionCalculators/VersionInBranchNameVersionStrategy.cs b/src/GitVersion.Core/VersionCalculation/BaseVersionCalculators/VersionInBranchNameVersionStrategy.cs
@@ -20,31 +20,23 @@ public override IEnumerable<BaseVersion> GetBaseVersions(EffectiveBranchConfigur
     {
         if (!configuration.Value.IsReleaseBranch) yield break;
 
-        var versionInBranch = GetVersionInBranch(
-            configuration.Branch.Name, configuration.Value.LabelPrefix, configuration.Value.SemanticVersionFormat
-        );
-        if (versionInBranch != null)
+        if (configuration.Branch.Name.TryGetSemanticVersion(out var result, configuration.Value.VersionInBranchRegex,
+            configuration.Value.LabelPrefix, configuration.Value.SemanticVersionFormat))
         {
             var commitBranchWasBranchedFrom = this.repositoryStore.FindCommitBranchWasBranchedFrom(
                 configuration.Branch, Context.Configuration
             );
-            var branchNameOverride = Context.CurrentBranch.Name.Friendly.RegexReplace("[-/]" + versionInBranch.Item1, string.Empty);
-            yield return new BaseVersion("Version in branch name", false, versionInBranch.Item2, commitBranchWasBranchedFrom.Commit, branchNameOverride);
-        }
-    }
 
-    private static Tuple<string, SemanticVersion>? GetVersionInBranch(
-        ReferenceName branchName, string? tagPrefixRegex, SemanticVersionFormat versionFormat)
-    {
-        var branchParts = branchName.WithoutOrigin.Split('/', '-');
-        foreach (var part in branchParts)
-        {
-            if (SemanticVersion.TryParse(part, tagPrefixRegex, out var semanticVersion, versionFormat))
+            string? branchNameOverride = null;
+            if (Context.CurrentBranch.Name.Equals(configuration.Branch.Name)
+                || Context.Configuration.GetBranchConfiguration(Context.CurrentBranch.Name).Label is null)
             {
-                return Tuple.Create(part, semanticVersion);
+                branchNameOverride = result.Name;
             }
-        }
 
-        return null;
+            yield return new BaseVersion(
+                "Version in branch name", false, result.Value, commitBranchWasBranchedFrom.Commit, branchNameOverride
+            );
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ namespace GitVersion.Configuration;`
`3`	`3`	`internal static class ConfigurationConstants`
`4`	`4`	`{`
`5`	`5`	`public const string DefaultLabelPrefix = "[vV]?";`
	`6`	`+ public const string DefaultVersionInBranchPattern = @"(?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*";`
`6`	`7`	`public const string BranchNamePlaceholder = "{BranchName}";`
`7`	`8`
`8`	`9`	`public const string MainBranchKey = "main";`