You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kw...@apache.org on 2023/03/29 16:28:21 UTC
[maven-enforcer] 01/01: improve documentation of banDynamicVersions
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch bugfix/improve-ban-dynamic-versions-doc
in repository https://gitbox.apache.org/repos/asf/maven-enforcer.git
commit 96ad751d441301071aefa2a5d0c3a176c08f58f5
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Wed Mar 29 18:28:13 2023 +0200
improve documentation of banDynamicVersions
fix wrong description of allowRanges
add JIRA link for allowRangesWithIdenticalBounds
clarify excludedScopes
---
enforcer-rules/src/site/apt/banDynamicVersions.apt.vm | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/enforcer-rules/src/site/apt/banDynamicVersions.apt.vm b/enforcer-rules/src/site/apt/banDynamicVersions.apt.vm
index 48f0040..8062cd6 100644
--- a/enforcer-rules/src/site/apt/banDynamicVersions.apt.vm
+++ b/enforcer-rules/src/site/apt/banDynamicVersions.apt.vm
@@ -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: