Implements regular expression for determining version label

- Remove magic string 'useBranchName'
- Merge branch configuration property BranchPrefixToTrim with Regex/RegularExpression to support dynamic named groups in the regular expression

Author: Casper Schmidt Wandahl-Liper

BREAKING_CHANGES.md

@@ -28,6 +28,10 @@
 *   A new configuration property with name `version-in-branch-pattern` has been introduced. This setting only applies on branches where the option `is-release-branch` is set to `true`. Please notice that the branch name needs to be defined after the version number by default (instead of `support/lts-2.0.0` please name the branch like `support/2.0.0-lts`).
 *   The `is-release-branch` property of the `hotfix` branch setting has been changed from `false` to `true`. If present the hotfix number will be considered now by default.
 *   In the GitHub and the Git Flow workflows the `label` property is by default set to an empty string on the `main` branch. This yields to a pre-release version on `main` with an empty tag. Instead of for instance `1.0.1+46` GitVersion generates the full semantic version `1.0.1-46` instead. This behavior can be changed to generate only stable versions (no pre-release version) with setting the label to `null` (Please keep in mind that the `label` property on root needs to be set to `null` as well, otherwise the fallback applies). This change is caused by issue #2347.
+*   The `useBranchName` magic string has been removed. Instead use `{BranchName}` for `label`.
+*   The `BranchPrefixToTrim` configuration property has been removed. `RegularExpression` is now used to capture named groups instead.
+    *   Default `RegularExpression` for feature branches is changed from `^features?[/-]` to `^features?[/-](?<BranchName>.+)` to support using `{BranchName}` out-of-the-box
+    *   Default `RegularExpression` for unknown branches is changed from `.*` to `(?<BranchName>.*)` to support using `{BranchName}` out-of-the-box
 
 ## v5.0.0
 

schemas/6.0/GitVersion.configuration.json

@@ -265,7 +265,7 @@
       }
     },
     "string": {
-      "description": "The label to use for this branch. Can be \u0027useBranchName\u0027 to extract the label from the branch name. Use the value {BranchName} as a placeholder to insert the branch name.",
+      "description": "The label to use for this branch. Use the value {BranchName} or similar as a placeholder to insert a named capture group from RegularExpression (fx. the branch name).",
       "type": "string"
     },
     "string1": {
@@ -557,4 +557,4 @@
       }
     }
   }
-}
+}

src/GitVersion.Core.Tests/Configuration/ConfigurationProviderTests.CanWriteOutEffectiveConfiguration.approved.txt

@@ -59,7 +59,7 @@ branches:
     mode: ContinuousDelivery
     label: '{BranchName}'
     increment: Inherit
-    regex: ^features?[/-]
+    regex: ^features?[/-](?<BranchName>.+)
     source-branches:
     - develop
     - main
@@ -114,7 +114,7 @@ branches:
     mode: ContinuousDelivery
     label: '{BranchName}'
     increment: Inherit
-    regex: .*
+    regex: (?<BranchName>.*)
     source-branches:
     - main
     - develop
@@ -133,7 +133,7 @@ prevent-increment-of-merged-branch-version: false
 track-merge-target: false
 track-merge-message: true
 commit-message-incrementing: Enabled
-regex: ''
+regex: (?<BranchName>.+)
 source-branches: []
 is-source-branch-for: []
 tracks-release-branches: false

src/GitVersion.Core.Tests/Helpers/TestEffectiveConfiguration.cs

@@ -16,7 +16,7 @@ public TestEffectiveConfiguration(
         string tagPrefix = ConfigurationConstants.DefaultTagPrefix,
         string label = "ci",
         string? nextVersion = null,
-        string branchPrefixToTrim = "",
+        string regularExpression = "",
         bool preventIncrementOfMergedBranchVersion = false,
         string? labelNumberPattern = null,
         bool trackMergeTarget = false,
@@ -41,7 +41,7 @@ public TestEffectiveConfiguration(
             label,
             nextVersion,
             IncrementStrategy.Patch,
-            branchPrefixToTrim,
+            regularExpression,
             preventIncrementOfMergedBranchVersion,
             labelNumberPattern,
             trackMergeTarget,

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

@@ -184,7 +184,6 @@ public void CanUseBranchNameOffAReleaseBranch()
     }
 
     [TestCase("alpha", "JIRA-123", "alpha")]
-    [TestCase("useBranchName", "JIRA-123", "JIRA-123")]
     [TestCase($"alpha.{ConfigurationConstants.BranchNamePlaceholder}", "JIRA-123", "alpha.JIRA-123")]
     public void ShouldUseConfiguredTag(string tag, string featureName, string preReleaseTagName)
     {

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

@@ -34,7 +34,7 @@ public void ShouldOnlyConsiderTagsMatchingOfCurrentBranch()
     public void CanTakeVersionFromReleaseBranch()
     {
         var configuration = GitFlowConfigurationBuilder.New
-            .WithBranch("release", _ => _.WithLabel("{BranchName}"))
+            .WithBranch("release", _ => _.WithLabel("{BranchName}").WithRegularExpression("(?<BranchName>.*)"))
             .Build();
 
         using var fixture = new EmptyRepositoryFixture();
@@ -52,7 +52,7 @@ public void CanTakeVersionFromReleaseBranch()
     public void CanTakeVersionFromHotfixBranch()
     {
         var configuration = GitFlowConfigurationBuilder.New
-            .WithBranch("hotfix", _ => _.WithLabel("{BranchName}"))
+            .WithBranch("hotfix", _ => _.WithLabel("{BranchName}").WithRegularExpression("(?<BranchName>.*)"))
             .Build();
 
         using var fixture = new EmptyRepositoryFixture();
@@ -83,7 +83,7 @@ public void ShouldNotGetVersionFromFeatureBranchIfNotMerged()
     {
         // * 1c08923 54 minutes ago  (HEAD -> develop)
         // | * 03dd6d5 56 minutes ago  (tag: 1.0.1-feature.1, feature)
-        // |/  
+        // |/
         // * e2ff13b 58 minutes ago  (tag: 1.0.0-unstable.0, main)
 
         var configuration = GitFlowConfigurationBuilder.New
@@ -106,14 +106,13 @@ public void ShouldNotGetVersionFromFeatureBranchIfNotMerged()
     }
 
     [TestCase("alpha", "JIRA-123", "alpha")]
-    [TestCase("useBranchName", "JIRA-123", "JIRA-123")]
     [TestCase($"alpha.{ConfigurationConstants.BranchNamePlaceholder}", "JIRA-123", "alpha.JIRA-123")]
     public void LabelIsBranchNameForBranchesWithoutPrefixedBranchName(string label, string branchName, string preReleaseTagName)
     {
         var configuration = GitFlowConfigurationBuilder.New
             .WithBranch("other", builder => builder
                 .WithIncrement(IncrementStrategy.Patch)
-                .WithRegularExpression(".*")
+                .WithRegularExpression("(?<BranchName>.*)")
                 .WithSourceBranches()
                 .WithLabel(label))
             .Build();

src/GitVersion.Core.Tests/VersionCalculation/VariableProviderTests.cs

@@ -182,7 +182,7 @@ public void ProvidesVariablesInContinuousDeploymentModeWithTagNamePattern()
     }
 
     [Test]
-    public void ProvidesVariablesInContinuousDeploymentModeWithTagSetToUseBranchName()
+    public void ProvidesVariablesInContinuousDeploymentModeWithTagSetToBranchName()
     {
         var semanticVersion = new SemanticVersion
         {

src/GitVersion.Core/Configuration/BranchConfiguration.cs

@@ -11,7 +11,7 @@ internal record BranchConfiguration : IBranchConfiguration
     public VersioningMode? VersioningMode { get; internal set; }
 
     [JsonPropertyName("label")]
-    [JsonPropertyDescription("The label to use for this branch. Can be 'useBranchName' to extract the label from the branch name. Use the value {BranchName} as a placeholder to insert the branch name.")]
+    [JsonPropertyDescription("The label to use for this branch. Use the value {BranchName} or similar as a placeholder to insert a named capture group from RegularExpression (fx. the branch name).")]
     public string? Label { get; internal set; }
 
     [JsonPropertyName("increment")]

src/GitVersion.Core/Configuration/ConfigurationConstants.cs

@@ -19,9 +19,9 @@ internal static class ConfigurationConstants
     public const string MainBranchRegex = "^master$|^main$";
     public const string DevelopBranchRegex = "^dev(elop)?(ment)?$";
     public const string ReleaseBranchRegex = "^releases?[/-]";
-    public const string FeatureBranchRegex = "^features?[/-]";
+    public const string FeatureBranchRegex = "^features?[/-](?<BranchName>.+)";
     public const string PullRequestBranchRegex = @"^(pull|pull\-requests|pr)[/-]";
     public const string HotfixBranchRegex = "^hotfix(es)?[/-]";
     public const string SupportBranchRegex = "^support[/-]";
-    public const string UnknownBranchRegex = ".*";
+    public const string UnknownBranchRegex = "(?<BranchName>.*)";
 }

src/GitVersion.Core/Configuration/ConfigurationExtensions.cs

@@ -68,32 +68,32 @@ public static bool IsReleaseBranch(this IGitVersionConfiguration configuration,
         configuration.NotNull();
 
         var label = configuration.Label;
-        if (label == "useBranchName")
+        if (label is null)
         {
-            label = ConfigurationConstants.BranchNamePlaceholder;
+            return label;
         }
 
-        var value = branchNameOverride ?? branchName;
+        var effectiveBranchName = branchNameOverride ?? branchName;
 
-        if (label?.Contains(ConfigurationConstants.BranchNamePlaceholder) == true)
+        if (!configuration.RegularExpression.IsNullOrWhiteSpace() && !effectiveBranchName.IsNullOrEmpty())
         {
-            if (!configuration.BranchPrefixToTrim.IsNullOrWhiteSpace())
+            effectiveBranchName = effectiveBranchName.RegexReplace("[^a-zA-Z0-9-]", "-");
+            var pattern = new Regex(configuration.RegularExpression, RegexOptions.IgnoreCase);
+            var match = pattern.Match(effectiveBranchName);
+            if (match.Success)
             {
-                var branchNameTrimmed = value?.RegexReplace(
-                    configuration.BranchPrefixToTrim, string.Empty, RegexOptions.IgnoreCase
-                );
-                value = branchNameTrimmed.IsNullOrEmpty() ? value : branchNameTrimmed;
+                // ReSharper disable once LoopCanBeConvertedToQuery
+                foreach (var groupName in pattern.GetGroupNames())
+                {
+                    label = label.Replace("{" + groupName + "}", match.Groups[groupName].Value);
+                }
             }
-
-            value = value?.RegexReplace("[^a-zA-Z0-9-]", "-");
-
-            label = label.Replace(ConfigurationConstants.BranchNamePlaceholder, value);
         }
 
         // Evaluate tag number pattern and append to prerelease tag, preserving build metadata
-        if (!configuration.LabelNumberPattern.IsNullOrEmpty() && !value.IsNullOrEmpty() && label is not null)
+        if (!configuration.LabelNumberPattern.IsNullOrEmpty() && !effectiveBranchName.IsNullOrEmpty())
         {
-            var match = Regex.Match(value, configuration.LabelNumberPattern);
+            var match = Regex.Match(effectiveBranchName, configuration.LabelNumberPattern);
             var numberGroup = match.Groups["number"];
             if (numberGroup.Success)
             {