branch regex is matched against {EscapedBranchName} not {BranchName} +semver minor

Author: HHobeck

BREAKING_CHANGES.md

@@ -1,3 +1,7 @@
+## v6.1.0
+
+* The configuration property `label-number-pattern` was removed. The functionality can be still used by changing the label and the branch name regular expression for pull-request branches.
+
 ## v6.0.0
 
 ### Platforms
@@ -60,7 +64,7 @@
 * 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 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
 
 * The `Mainline` mode and the related implementation has been removed completely. The new `Mainline` version strategy should be used instead.

docs/input/docs/reference/configuration.md

@@ -100,7 +100,7 @@ branches:
       of-merged-branch: true
       when-current-commit-tagged: false
     track-merge-target: false
-    regex: ^releases?[/-](?<BranchName>.+)
+    regex: ^releases?[\/-](?<BranchName>.+)
     source-branches:
     - main
     - support
@@ -116,7 +116,7 @@ branches:
     prevent-increment:
       when-current-commit-tagged: false
     track-merge-message: true
-    regex: ^features?[/-](?<BranchName>.+)
+    regex: ^features?[\/-](?<BranchName>.+)
     source-branches:
     - develop
     - main
@@ -128,14 +128,13 @@ branches:
     pre-release-weight: 30000
   pull-request:
     mode: ContinuousDelivery
-    label: PullRequest
+    label: PullRequest{Number}
     increment: Inherit
     prevent-increment:
       of-merged-branch: true
       when-current-commit-tagged: false
-    label-number-pattern: '[/-](?<number>\d+)'
     track-merge-message: true
-    regex: ^(pull|pull\-requests|pr)[/-]
+    regex: ^(pull-requests|pull|pr)[\/-](?<Number>\d*)
     source-branches:
     - develop
     - main
@@ -151,7 +150,7 @@ branches:
     increment: Inherit
     prevent-increment:
       when-current-commit-tagged: false
-    regex: ^hotfix(es)?[/-](?<BranchName>.+)
+    regex: ^hotfix(es)?[\/-](?<BranchName>.+)
     source-branches:
     - main
     - support
@@ -165,7 +164,7 @@ branches:
     prevent-increment:
       of-merged-branch: true
     track-merge-target: false
-    regex: ^support[/-](?<BranchName>.+)
+    regex: ^support[\/-](?<BranchName>.+)
     source-branches:
     - main
     is-source-branch-for: []
@@ -262,7 +261,7 @@ branches:
       when-current-commit-tagged: false
     track-merge-target: false
     track-merge-message: true
-    regex: ^releases?[/-](?<BranchName>.+)
+    regex: ^releases?[\/-](?<BranchName>.+)
     source-branches:
     - main
     is-source-branch-for: []
@@ -277,7 +276,7 @@ branches:
     prevent-increment:
       when-current-commit-tagged: false
     track-merge-message: true
-    regex: ^features?[/-](?<BranchName>.+)
+    regex: ^features?[\/-](?<BranchName>.+)
     source-branches:
     - main
     - release
@@ -286,14 +285,13 @@ branches:
     pre-release-weight: 30000
   pull-request:
     mode: ContinuousDelivery
-    label: PullRequest
+    label: PullRequest{Number}
     increment: Inherit
     prevent-increment:
       of-merged-branch: true
       when-current-commit-tagged: false
-    label-number-pattern: '[/-](?<number>\d+)'
     track-merge-message: true
-    regex: ^(pull|pull\-requests|pr)[/-]
+    regex: ^(pull-requests|pull|pr)[\/-](?<Number>\d*)
     source-branches:
     - main
     - release
@@ -381,7 +379,7 @@ branches:
     prevent-increment:
       when-current-commit-tagged: false
     track-merge-message: true
-    regex: ^features?[/-](?<BranchName>.+)
+    regex: ^features?[\/-](?<BranchName>.+)
     source-branches:
     - main
     is-source-branch-for: []
@@ -393,7 +391,7 @@ branches:
     increment: Patch
     prevent-increment:
       when-current-commit-tagged: false
-    regex: ^hotfix(es)?[/-](?<BranchName>.+)
+    regex: ^hotfix(es)?[\/-](?<BranchName>.+)
     source-branches:
     - main
     is-source-branch-for: []
@@ -402,14 +400,13 @@ branches:
     pre-release-weight: 30000
   pull-request:
     mode: ContinuousDelivery
-    label: PullRequest
+    label: PullRequest{Number}
     increment: Inherit
     prevent-increment:
       of-merged-branch: true
       when-current-commit-tagged: false
-    label-number-pattern: '[/-](?<number>\d+)'
     track-merge-message: true
-    regex: ^(pull|pull\-requests|pr)[/-]
+    regex: ^(pull-requests|pull|pr)[\/-](?<Number>\d*)
     source-branches:
     - main
     - feature
@@ -690,7 +687,7 @@ branches:
     is-main-branch: false
     pre-release-weight: 0
   release:
-    regex: ^releases?[/-]
+    regex: ^releases?[\/-]
     mode: ContinuousDelivery
     label: beta
     increment: None
@@ -702,29 +699,28 @@ branches:
     is-main-branch: false
     pre-release-weight: 30000
   feature:
-    regex: ^features?[/-]
+    regex: ^features?[\/-]
     mode: ContinuousDelivery
     label: '{BranchName}'
     increment: Inherit
     source-branches: [ 'develop', 'main', 'release', 'feature', 'support', 'hotfix' ]
     pre-release-weight: 30000
   pull-request:
-    regex: ^(pull|pull\-requests|pr)[/-]
+    regex: ^(pull-requests|pull|pr)[\/-]
     mode: ContinuousDelivery
     label: PullRequest
     increment: Inherit
-    label-number-pattern: '[/-](?<number>\d+)[-/]'
     source-branches: [ 'develop', 'main', 'release', 'feature', 'support', 'hotfix' ]
     pre-release-weight: 30000
   hotfix:
-    regex: ^hotfix(es)?[/-]
+    regex: ^hotfix(es)?[\/-]
     mode: ContinuousDelivery
     label: beta
     increment: Inherit
     source-branches: [ 'release', 'main', 'support', 'hotfix' ]
     pre-release-weight: 30000
   support:
-    regex: ^support[/-]
+    regex: ^support[\/-]
     mode: ContinuousDelivery
     label: ''
     increment: Patch
@@ -840,9 +836,9 @@ The pre-release label to use for this branch. Use the value `{BranchName}` as a
 insert the value of the named group `BranchName` from the [regular expression](#regex).
 
 For example: branch `feature/foo` would become a pre-release label
-of `alpha.foo` with `label: 'alpha.{BranchName}'` and `regex: '^features?[/-](?<BranchName>.+)'`.
+of `alpha.foo` with `label: 'alpha.{BranchName}'` and `regex: '^features?[\/-](?<BranchName>.+)'`.
 
-Another example: branch `features/sc-12345/some-description` would become a pre-release label of `sc-12345` with `label: '{StoryNo}'` and `regex: '^features?[/-](?<StoryNo>sc-\d+)[-/].+'`.
+Another example: branch `features/sc-12345/some-description` would become a pre-release label of `sc-12345` with `label: '{StoryNo}'` and `regex: '^features?[\/-](?<StoryNo>sc-\d+)[-/].+'`.
 
 **Note:** To clear a default use an empty string: `label: ''`
 
@@ -871,30 +867,6 @@ The increment of the merged branch will be ignored when this branch related prop
 
 This branch related property controls the behvior whether to use the tagged (value set to true) or the incremented (value set to false) semantic version. Defaults to true.
 
-### label-number-pattern
-
-Pull requests require us to extract the pre-release number out of the branch
-name so `refs/pulls/534/merge` builds as `PullRequest.534`. This is a regex with
-a named capture group called `number`.
-
-If the branch `mode` is set to `ContinuousDeployment`, then the extracted
-`number` is appended to the name of the pre-release label and the number portion
-is the number of commits since the last label. This enables consecutive commits to
-the pull request branch to generate unique full semantic version numbers when
-the branch is configured to use ContinuousDeployment mode.
-
-**Example usage:**
-
-```yaml
-branches:
-  pull-request:
-    mode: ContinuousDeployment
-    label: PullRequest
-    increment: Inherit
-    track-merge-target: true
-    label-number-pattern: '[/-](?<number>\d+)[-/]'
-```
-
 ### track-merge-target
 
 Strategy which will look for tagged merge commits directly off the current

docs/input/docs/workflows/GitFlow/v1.yml

@@ -1,4 +1,4 @@
-assembly-versioning-scheme: MajorMinorPatch
+assembly-versioning-scheme: MajorMinorPatch
 assembly-file-versioning-scheme: MajorMinorPatch
 tag-prefix: '[vV]?'
 version-in-branch-pattern: (?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*
@@ -57,7 +57,7 @@ branches:
       of-merged-branch: true
       when-current-commit-tagged: false
     track-merge-target: false
-    regex: ^releases?[/-](?<BranchName>.+)
+    regex: ^releases?[\/-](?<BranchName>.+)
     source-branches:
     - main
     - support
@@ -73,7 +73,7 @@ branches:
     prevent-increment:
       when-current-commit-tagged: false
     track-merge-message: true
-    regex: ^features?[/-](?<BranchName>.+)
+    regex: ^features?[\/-](?<BranchName>.+)
     source-branches:
     - develop
     - main
@@ -85,14 +85,13 @@ branches:
     pre-release-weight: 30000
   pull-request:
     mode: ContinuousDelivery
-    label: PullRequest
+    label: PullRequest{Number}
     increment: Inherit
     prevent-increment:
       of-merged-branch: true
       when-current-commit-tagged: false
-    label-number-pattern: '[/-](?<number>\d+)'
     track-merge-message: true
-    regex: ^(pull|pull\-requests|pr)[/-]
+    regex: ^(pull-requests|pull|pr)[\/-](?<Number>\d*)
     source-branches:
     - develop
     - main
@@ -108,7 +107,7 @@ branches:
     increment: Inherit
     prevent-increment:
       when-current-commit-tagged: false
-    regex: ^hotfix(es)?[/-](?<BranchName>.+)
+    regex: ^hotfix(es)?[\/-](?<BranchName>.+)
     source-branches:
     - main
     - support
@@ -122,7 +121,7 @@ branches:
     prevent-increment:
       of-merged-branch: true
     track-merge-target: false
-    regex: ^support[/-](?<BranchName>.+)
+    regex: ^support[\/-](?<BranchName>.+)
     source-branches:
     - main
     is-source-branch-for: []

docs/input/docs/workflows/GitHubFlow/v1.yml

@@ -1,4 +1,4 @@
-assembly-versioning-scheme: MajorMinorPatch
+assembly-versioning-scheme: MajorMinorPatch
 assembly-file-versioning-scheme: MajorMinorPatch
 tag-prefix: '[vV]?'
 version-in-branch-pattern: (?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*
@@ -43,7 +43,7 @@ branches:
       when-current-commit-tagged: false
     track-merge-target: false
     track-merge-message: true
-    regex: ^releases?[/-](?<BranchName>.+)
+    regex: ^releases?[\/-](?<BranchName>.+)
     source-branches:
     - main
     is-source-branch-for: []
@@ -58,7 +58,7 @@ branches:
     prevent-increment:
       when-current-commit-tagged: false
     track-merge-message: true
-    regex: ^features?[/-](?<BranchName>.+)
+    regex: ^features?[\/-](?<BranchName>.+)
     source-branches:
     - main
     - release
@@ -67,14 +67,13 @@ branches:
     pre-release-weight: 30000
   pull-request:
     mode: ContinuousDelivery
-    label: PullRequest
+    label: PullRequest{Number}
     increment: Inherit
     prevent-increment:
       of-merged-branch: true
       when-current-commit-tagged: false
-    label-number-pattern: '[/-](?<number>\d+)'
     track-merge-message: true
-    regex: ^(pull|pull\-requests|pr)[/-]
+    regex: ^(pull-requests|pull|pr)[\/-](?<Number>\d*)
     source-branches:
     - main
     - release

docs/input/docs/workflows/TrunkBased/preview1.yml

@@ -1,4 +1,4 @@
-assembly-versioning-scheme: MajorMinorPatch
+assembly-versioning-scheme: MajorMinorPatch
 assembly-file-versioning-scheme: MajorMinorPatch
 tag-prefix: '[vV]?'
 version-in-branch-pattern: (?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*
@@ -37,7 +37,7 @@ branches:
     prevent-increment:
       when-current-commit-tagged: false
     track-merge-message: true
-    regex: ^features?[/-](?<BranchName>.+)
+    regex: ^features?[\/-](?<BranchName>.+)
     source-branches:
     - main
     is-source-branch-for: []
@@ -49,7 +49,7 @@ branches:
     increment: Patch
     prevent-increment:
       when-current-commit-tagged: false
-    regex: ^hotfix(es)?[/-](?<BranchName>.+)
+    regex: ^hotfix(es)?[\/-](?<BranchName>.+)
     source-branches:
     - main
     is-source-branch-for: []
@@ -58,14 +58,13 @@ branches:
     pre-release-weight: 30000
   pull-request:
     mode: ContinuousDelivery
-    label: PullRequest
+    label: PullRequest{Number}
     increment: Inherit
     prevent-increment:
       of-merged-branch: true
       when-current-commit-tagged: false
-    label-number-pattern: '[/-](?<number>\d+)'
     track-merge-message: true
-    regex: ^(pull|pull\-requests|pr)[/-]
+    regex: ^(pull-requests|pull|pr)[\/-](?<Number>\d*)
     source-branches:
     - main
     - feature

src/GitVersion.Configuration.Tests/Configuration/ConfigurationExtensionsTests.cs

@@ -40,8 +40,8 @@ public void EnsureIsReleaseBranchWithReferenceNameWorksAsExpected(string branchN
         isReleaseBranch.ShouldBe(expectedIsReleaseBranch);
     }
 
-    [TestCase("feature/sc-1000/Description", "^features?[/-](?<BranchName>.+)", "{BranchName}", "sc-1000-Description")]
-    [TestCase("feature/sc-1000/Description", "^features?[/-](?<StoryNo>sc-\\d+)[-/].+", "{StoryNo}", "sc-1000")]
+    [TestCase("feature/sc-1000/Description", @"^features?[\/-](?<BranchName>.+)", "{BranchName}", "sc-1000-Description")]
+    [TestCase("feature/sc-1000/Description", @"^features?[\/-](?<StoryNo>sc-\d+)[-\/].+", "{StoryNo}", "sc-1000")]
     public void EnsureGetBranchSpecificLabelWorksAsExpected(string branchName, string regularExpression, string label, string expectedLabel)
     {
         var configuration = GitFlowConfigurationBuilder.New