Table of Contents

Current Version Static Badge

Branch naming

A branch maturity pattern is used to identify if a build in a branch is a release or pre-release build and the build maturity identifier (e.g: rc, alpha, beta). This topic documents the default branch maturity pattern and how to use custom patterns.

Default branch maturity pattern

The default branch maturity pattern regular expression pattern is:

^((?<rc>(main|release)[\\\/_](.*[\\\/_])?rc.*)|(?<release>main|release)|(?<beta>feature)|(?<alpha>.+))[\\\/_]?

The table below gives example default release/pre-release branch versioning (SHAs abbreviated).

Git branch Type Example product version Example informational version
main
release
release/apples		 Release 1.2.3 1.2.3+801.<branchName>.e10c9cc0
release_rc
release/rc		 Pre-release (RC) 1.2.3-rc.801 1.2.3-rc.801+<branchName>.e10c9cc0
feature
feature/oranges		 Pre-release (Beta) 1.2.3-beta.801 1.2.3-beta.801+<branchName>.e10c9cc0
Others not matching Pre-release (Alpha) 1.2.3-alpha.801 1.2.3-alpha.801+<branchName>.e10c9cc0

If no fixes, added features, or breaking changes, the following workflow of git commits shows versioning changing with branch name:

gitGraph
       commit id:"1.2.3+100"
       branch feature/berry
       checkout feature/berry
       commit id:"1.2.3-beta.101"
       branch develop/berry
       checkout develop/berry
       commit id:"1.2.3-alpha.102"

Custom configuration

A custom branch maturity pattern regular expression pattern can be set using the Git2SemVer_BranchMaturityPattern.

For example:

<PropertyGroup>
    <Git2SemVer_BranchMaturityPattern>
        ^((?<rc>(main|release)[\\\/_](.*[\\\/_])?rc.*)|(?<release>main|release)|(?<beta>feature)|(?<alpha>.+))[\\\/_]?
    </Git2SemVer_BranchMaturityPattern>
</PropertyGroup>

The regular expression must have two or more named groups. The release named group is required and defines which branches are release branches. All other named groups define pre-release branches and the group's name is the build maturity identifier. The last named group must be a catch all (e.g: (?<alpha>.+)) for pre-release branches not matching prior groups.

For example, a branch maturity pattern for a single release branch main with all other branches being pre-releases dev branches is:

^((?<release>main)|(?<dev>.+))[\\\/_]?

This results in builds on a branch like mystuff/oranges having pre-release versioning like 1.2.3-dev.801+<branchName>.e10c9cc0.

The workflow shown for the default branch maturity pattern now becomes:

gitGraph
       commit id:"1.2.3+100"
       branch feature/berry
       checkout feature/berry
       commit id:"1.2.3-dev.101"
       branch develop/berry
       checkout develop/berry
       commit id:"1.2.3-dev.102"
Note

When a branch name or maturity identifier is used in version metadata, invalid Semmmantic Versioning characters are replaced with the "-" characters. This is to ensure Semmmantic Versioning compliance for compatibility with common tools.

Edit this page