Skip to content

Commit f8cdb53

Browse files
author
Simon Ejsing
committed
Add documentation for new feature
1 parent d63a4e7 commit f8cdb53

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/configuration.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Configuration
1+
# Configuration
22
GitVersion 3.0 is mainly powered by configuration and no longer has branching strategies hard coded.
33

44
## Configuration tool
@@ -82,6 +82,21 @@ The options in here are:
8282
- **`tag-number-pattern:`** Pull requests require us to pull the pre-release number out of the branch name so `refs/pulls/534/merge` builds as `PullRequest.534`.
8383
This is a regex with a named capture group called `number`
8484

85+
- **`tag-name-pattern:`** This is similar to `tag-number-pattern` but instead of using the pull request number as the number part of the prerelease tag, the number is instead appended to the tag.
86+
This is only applicable when the branch mode is set to ContinuousDeployment, where the prerelease tag number part is based on the number of commits since the last tag.
87+
It enables consecutive commits to the pull request branch to generate unique full semantic version numbers when the branch is configured to use ContinuousDeployment mode and this value is set.
88+
This is a regex with a named capture group called `number`.
89+
Example usage:
90+
```yaml
91+
branches:
92+
(pull|pull\-requests|pr)[/-]:
93+
mode: ContinuousDeployment
94+
tag: PullRequest
95+
increment: Inherit
96+
track-merge-target: true
97+
tag-name-pattern: '[/-](?<number>\d+)[-/]'
98+
```
99+
85100
- **`track-merge-target:`** Strategy which will look for tagged merge commits directly off the current branch. For example `develop` → `release/1.0.0` → merge into `master` and tag `1.0.0`. The tag is *not* on develop, but develop should be version `1.0.0` now.
86101

87102
We don't envision many people needing to change most of these configuration values, but they are there if you need to.

0 commit comments

Comments
 (0)