Skip to content

Commit 1a1e477

Browse files
committed
Updated readme to explain the magic string 'useBranchNameAsTag in the config
1 parent a3efe7d commit 1a1e477

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,8 @@ branches:
141141
```
142142
143143
The options in here are:
144-
- `tag`: The pre release tag to use for this branch
144+
- `tag`: The pre release tag to use for this branch. Use the value `useBranchNameAsTag` to use the branch name instead.
145+
For example `feature/foo` would become a pre-release tag of `foo` with this value
145146
- `increment`: the part of the SemVer to increment when GitVersion detects it needs to be (i.e commit after a tag)
146147
- `preventIncrementOfMergedBranchVersion`: When `release-2.0.0` is merged into master, we want master to build `2.0.0`.
147148
If `release-2.0.0` is merged into develop we want it to build `2.1.0`, this option prevents incrementing after a versioned branch is merged

0 commit comments

Comments
 (0)