Skip to content

Commit 12a6c76

Browse files
authored
Update README.md
1 parent a807238 commit 12a6c76

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ gitVersioning {
5656
}
5757
}
5858
```
59+
- *optional* `preferTags` global enable(`true`)/disable(`false`) prefer tag rules over branch rules if both match.
5960

6061
- `branch` specific version format definition.
6162
- `pattern` An arbitrary regex to match branch names (has to be a **full match pattern** e.g. `feature/.+` )
@@ -146,6 +147,12 @@ gitVersioning {
146147
147148
### Parameters & Environment Variables
148149
150+
- Disable Plugin
151+
- **Environment Variables**
152+
- `export VERSIONING_DISABLE=true`
153+
- **Command Line Parameters**
154+
- `gradle ... -Pversioning.disable=true`
155+
149156
- Provide **branch** or **tag** name
150157
- **Environment Variables**
151158
- `export VERSIONING_GIT_BRANCH=$PROVIDED_BRANCH_NAME`
@@ -156,6 +163,12 @@ gitVersioning {
156163
157164
ℹ Especially useful for **CI builds** see [Miscellaneous Hints](#miscellaneous-hints)
158165
166+
- **Prefer Tags** for Versioning instead of Branches
167+
- **Environment Variables**
168+
- `export VERSIONING_PREFER_TAGS=true`
169+
- **Command Line Parameters**
170+
- `gradle ... -Pversioning.preferTags=true`
171+
159172
## Provided Project Properties
160173
161174
- `git.commit` e.g. '0fc20459a8eceb2c4abb9bf0af45a6e8af17b94b'

0 commit comments

Comments
 (0)