Skip to content

Commit 926fb99

Browse files
Add 'enforceNonSnapshots' documentation to README.md
1 parent 20b882a commit 926fb99

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
@@ -144,7 +144,7 @@ One common stumbling block for teams adjusting to gitflow with Maven projects is
144144
In practice, the Maven versions should:
145145

146146
* Be synchronized with release branch and hotfix branch names.
147-
* Never be -SNAPSHOT in the master, support, release, or hotfix branches. Also, no -SNAPSHOT (plugin) dependencies are allowed.
147+
* Never be -SNAPSHOT in the master, support, release, or hotfix branches. Also, no -SNAPSHOT parent or (plugin) dependencies are allowed. (This condition may be disabled by setting `enforceNonSnapshots` = `false`.)
148148
* Always be -SNAPSHOT in the feature and develop branches.
149149
* Be irrelevant if there's no git branch resolvable from your environment.
150150

@@ -160,6 +160,7 @@ The following properties change the behavior of this goal:
160160
| -------------------- | ------------- | --------------------------- | ----------- |
161161
| gitBranchExpression | current git branch resolved from SCM or ${env.GIT_BRANCH} | n/a | Maven property expression to resolve in order to determine the current git branch |
162162
| deploySnapshotTypeBranches | `false` | n/a | When `true`, the POM version should end with the feature branch name and -SNAPSHOT, e.g. `1.0.0-myfeature-SNAPSHOT`. This prevents a feature branch snapshot from "overwriting" a snapshot from the develop branch. |
163+
| enforceNonSnapshots | `true` | n/a | When `true`, enforce the requirement that none of the following may contain a -SNAPSHOT: the POM version, any parent, or any (plugin) dependencies. |
163164
| releaseBranchMatchType | `equals` | n/a | When `equals`, the POM version should be identical to the branch name for release and hotfix branches (e.g. POM version should be `1.0.0` for branch `release/1.0.0`). When `startsWith`, POM version should start with the name branch (e.g. POM version could be `1.0.1` for branch `release/1.0`. When using the `update-stage-dependencies` mojo, set to `equals`, otherwise set to `startsWith`. |
164165
| masterBranchPattern | (origin/)?master | No | Regex. When matched, signals the master branch is being built. |
165166
| supportBranchPattern | (origin/)?support/(.*) | No | Regex. When matches, signals a support branch (long term master-equivalent for older release) being built. Last subgroup, if present, must be start of the Maven project version. |

0 commit comments

Comments
 (0)