Skip to content

Commit

Permalink
improve documentation of banDynamicVersions
Browse files Browse the repository at this point in the history
fix wrong description of allowRanges
add JIRA link for allowRangesWithIdenticalBounds
clarify excludedScopes
  • Loading branch information
kwin committed Mar 29, 2023
1 parent 435807f commit 6feac61
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions enforcer-rules/src/site/apt/banDynamicVersions.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,19 @@ Ban Dynamic Versions

The following parameters are supported by this rule:

* <<allowSnapshots>> - if <<<true>>> dependencies with versions ending with <<<-SNAPSHOT>>> will not be banned. Default is <<<false>>>.
* <<allowSnapshots>> - if <<<true>>> dependencies with versions ending with <<<-SNAPSHOT>>> will not be banned. Default is <<<false>>>.

* <<allowRelease>> - if <<<true>>> dependencies with version placeholder <<<RELEASE>>> will not be banned. Default is <<<false>>>.
* <<allowRelease>> - if <<<true>>> dependencies with version placeholder <<<RELEASE>>> will not be banned. Default is <<<false>>>.

* <<allowLatest>> - if <<<true>>> dependencies with versions placeholder <<<LATEST>>> will not be banned. Default is <<<false>>>.
* <<allowLatest>> - if <<<true>>> dependencies with versions placeholder <<<LATEST>>> will not be banned. Default is <<<false>>>.

* <<allowRanges>> - if <<<true>>> versions ending with <<<-SNAPSHOT>>> will not be banned. Default is <<<false>>>.
* <<allowRanges>> - if <<<true>>> versions starting with either <<<[>>> or <<<(>>> will not be banned. Default is <<<false>>>.

* <<allowRangesWithIdenticalBounds>> - if <<<true>>> ranges having a range with same upper and lower bound (always inclusive) will not be banned (although they require resolving).
* <<allowRangesWithIdenticalBounds>> - if <<<true>>> ranges having a range with same upper and lower bound (always inclusive) will not be banned (although they require resolving in some Maven versions, {{{https://issues.apache.org/jira/browse/MNG-7561}MNG-7461}}).

* <<excludeOptionals>> - if <<<true>>> optional dependencies won't be checked. Default is <<<false>>>.
* <<excludeOptionals>> - if <<<true>>> direct optional dependencies won't be checked. Default is <<<false>>>.

* <<excludedScopes>> - the list of scopes to exclude. By default no scopes are excluded.
* <<excludedScopes>> - the list of scopes to exclude from direct dependencies. By default no scopes are excluded. For transitive dependencies the regular Maven rules are applied.

* <<ignores>> - a list of dependencies to ignore. The format is <<<groupId[:artifactId[:version[:type[:scope:[classifier]]]]]>>> where <<<artifactId>>>, <<<version>>>, <<<type>>>, <<<scope>>> and <<<classifier>>> are optional (but require all previous parts). Wildcards may be used to replace an entire or just parts of a section.
Examples:
Expand Down

0 comments on commit 6feac61

Please sign in to comment.