Support Regex for label property

[CasperWSchmidt]

Detailed Description

We're using Shortcut to manage stories and bugs. Shortcut can automatically generate branches based on features and chores in the format feature/sc-xxxx/description. Using the default regex ^features?[/-] to recognize branches, useBranchName (or {branchName}) we'll get tags with sc-xxxx-description but we'd like to only have the story id (sc-xxxx) as the tag.

I'll be happy to make a PR once this feature has been discussed.

Context

I'm unsure of the actual syntax, but perhaps something like label: regex sc-\d+ so that the code can recognize the regex prefix. This regex will then be executed against the branch name to retrieve the part of the branch name that is returned as the label

Possible Implementation

[HHobeck]

I like the idea. I would recomment to reuse the label and regex property in the branch related property section like:

  feature:
    label: '{BranchName}'
    regex: ^features?[\/-](?<BranchName>.+)

The important thing to notice here is that the user can use zero, one or more generic named capture groups in the regex of an branch which can be used in the label property per placeholder convention like {BranchName}. The useBranchName support needs to be removed in my opinion.

@asbjornu what do you think?

[asbjornu]

I agree to remove the useBranchName token and instead allow string interpolation of any variable GitVersion exposes.

[CasperWSchmidt]

That sounds awesome! Any ETA on a final release for 6.0.0?

[HHobeck]

That sounds awesome! Any ETA on a final release for 6.0.0?

Of course when the tickets are done for milestone 6!? 😅

[CasperWSchmidt]

That sounds awesome! Any ETA on a final release for 6.0.0?

Of course when the tickets are done for milestone 6!? 😅

I can see that the milestone is 5% done, so I guess it will be a while :)

With a little guidance as to where and how you see this change made, I might be able to do this PR myself. Just let me know.

[HHobeck]

I can see that the milestone is 5% done, so I guess it will be a while :)

On the first glance the progress for 6.x seems to be not so advanced but some alpha and beta versions have been released already with alot of changes ;)

I would appreciate your help very much. Any features or bugs which can be finished will help to speed up the release.

With a little guidance as to where and how you see this change made, I might be able to do this PR myself. Just let me know.

Of course I can guide you to the right location. For the beginning I would say let's start with this feature. :)

[HHobeck]

Following steps I would recommend:

• Rename BranchPrefixToTrim to RegularExpression
• Remove all usage of useBranchName
• Refactor the extension method GetBranchSpecificLabel:
  • Determine the capture groups (name and value) of the branch name using the regular expression
  • Iterate over the capturing groups and
  • replace the place holder of the name with the value in label
• Adapt the RegularExpressions in GitFlow and GitHubFlowConfigurationBuilder to e.g. ^features?[\/-](?<BranchName>.+)
• Adapt the base workspace template in
  • src\GitVersion.Core\Configuration\SupportedWorkflows\GitFlow\v1.yml and
  • src\GitVersion.Core\Configuration\SupportedWorkflows\GitHubFlow\v1.yml
• Change documentation in md files and document the breaking change in BREAKING_CHANGES.md
• Write integration tests to ensure the feature

[arturcic]

🎉 This issue has been resolved in version 6.0.0-beta.4 🎉
The release is available on:

• GitHub Release
• Chocolatey Package
• .Net Global Tool

Your GitReleaseManager bot 📦🚀