[
https://issues.apache.org/jira/browse/MNG-7811?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17773010#comment-17773010
]
ASF GitHub Bot commented on MNG-7811:
-------------------------------------
michael-o commented on code in PR #461:
URL: https://github.com/apache/maven-site/pull/461#discussion_r1349740538
##########
content/markdown/guides/plugins/validation/index.md:
##########
@@ -19,56 +19,65 @@ specific language governing permissions and limitations
under the License.
-->
-Maven since versions 3.9.x and 4.x introduced `Plugin Validation`
-in order to help Maven users and Maven Plugin developers maintain theirs
projects.
+Maven since versions 3.9.x and 4.x introduced **Plugin Validation**
+in order to help Maven users and Maven Plugin developers discover issues with
the plugins they
+use or maintain that may break in the future.
-## Internal Plugins Validation issues
+These issues are displayed as WARNING either when plugin goal is executed or
at the end of the build:
+
+```
+[WARNING] Plugin validation issues were detected in x plugin(s)
+```
+
+and split in 2 categories based on what actions should be taken:
Review Comment:
two
##########
content/markdown/guides/plugins/validation/index.md:
##########
@@ -19,56 +19,65 @@ specific language governing permissions and limitations
under the License.
-->
-Maven since versions 3.9.x and 4.x introduced `Plugin Validation`
-in order to help Maven users and Maven Plugin developers maintain theirs
projects.
+Maven since versions 3.9.x and 4.x introduced **Plugin Validation**
+in order to help Maven users and Maven Plugin developers discover issues with
the plugins they
+use or maintain that may break in the future.
-## Internal Plugins Validation issues
+These issues are displayed as WARNING either when plugin goal is executed or
at the end of the build:
+
+```
+[WARNING] Plugin validation issues were detected in x plugin(s)
+```
+
+and split in 2 categories based on what actions should be taken:
+
+## Internal issues
Internal Plugins Validation issues (project local) are issues discovered in
Maven project configuration, like:
- - using deprecated plugins goals
- - using deprecated plugins parameters
- - using read only plugins parameters
+ - project using deprecated plugins goals
([MNG-7457](https://issues.apache.org/jira/browse/MNG-7457)),
+ - project using deprecated plugins parameters,
+ - project using read only plugins parameters
([MNG-7464](https://issues.apache.org/jira/browse/MNG-7464)).
Review Comment:
plugin parameters
##########
content/markdown/guides/plugins/validation/index.md:
##########
@@ -19,56 +19,65 @@ specific language governing permissions and limitations
under the License.
-->
-Maven since versions 3.9.x and 4.x introduced `Plugin Validation`
-in order to help Maven users and Maven Plugin developers maintain theirs
projects.
+Maven since versions 3.9.x and 4.x introduced **Plugin Validation**
+in order to help Maven users and Maven Plugin developers discover issues with
the plugins they
+use or maintain that may break in the future.
-## Internal Plugins Validation issues
+These issues are displayed as WARNING either when plugin goal is executed or
at the end of the build:
+
+```
+[WARNING] Plugin validation issues were detected in x plugin(s)
+```
+
+and split in 2 categories based on what actions should be taken:
+
+## Internal issues
Internal Plugins Validation issues (project local) are issues discovered in
Maven project configuration, like:
- - using deprecated plugins goals
- - using deprecated plugins parameters
- - using read only plugins parameters
+ - project using deprecated plugins goals
([MNG-7457](https://issues.apache.org/jira/browse/MNG-7457)),
+ - project using deprecated plugins parameters,
+ - project using read only plugins parameters
([MNG-7464](https://issues.apache.org/jira/browse/MNG-7464)).
-In such cases users can fix their project by fixing configuration by editing
their POMs.
-Users should consult actual plugin documentation or try to update plugin to
newer version.
+In such cases, users can fix their project by fixing configuration by editing
their POMs.
+Users should consult actual plugin documentation (and eventually try to update
plugin to newer version).
-## External Plugins Validation issues
+## External issues
External Plugins Validation issues (non-configuration) are issues detected in
plugin itself, like:
- - using old, deprecated Maven Api by plugin
- - declaring dependencies for Maven Core artifacts in wrong scope in plugin
project
+ - plugin using old, deprecated Maven API,
+ - plugin declaring dependencies for Maven Core artifacts in wrong scope
(should be `provided`).
-External Plugins issues can only be fix by plugin authors.
+External Plugins issues require to be fixed by plugin authors first.
-In such cases users can try to update plugin to newer version.
-If the newest version of plugin still has an issue users should report problem
to plugin authors.
+In such cases users can try to update plugin to newer version.
+If the newest version of plugin still has such an issue, users should report
problem to plugin authors.
## Manage Plugin Validation verbosity
-In order to manage Plugin Validation verbosity a property
`maven.plugin.validation` can be used.
+In order to manage Plugin Validation verbosity, a system property
`-Dmaven.plugin.validation=...` can be used on command line (or injected: see
below).
Allowed values are:
- - `NONE` - mute Plugin Validation completely, nothing will be reported
- - `INLINE` - report only `Internal` issues in place where occur
- - `BRIEF` - report only `Internal` issues in place where occur and list of
plugins with `External` issues at the and of build
- - `SUMMARY` - report list of plugins with `Internal` and `External` issues at
the end of build
- - `VERBOSE` - report `Internal` and `External` issues at the end of build in
verbose mode
+ - `NONE` - mute Plugin Validation completely, nothing will be reported,
+ - `INLINE` (default) - report only `Internal` issues in place where they
occur,
+ - `BRIEF` - report `Internal` issues in place where they occur and list of
plugins with `External` issues at the end of the build,
+ - `SUMMARY` - report list of plugins with `Internal` and `External` issues at
the end of the build,
+ - `VERBOSE` - report `Internal` and `External` issues at the end of build in
verbose mode.
-Configuration values for `maven.plugin.validation` are case insensitive, can
be used on command line, like:
+Configuration values for `maven.plugin.validation` are case insensitive, can
only be used on command line (not as property in POM), like:
```
mvn -Dmaven.plugin.validation=verbose ...
```
-Can be added to `MAVEN_OPTS` or `MAVEN_ARGS` environment variables,
-can also be added to `.mvn/maven.config` file in order to configure per
project.
-
-Users can add such property to their `settings.xml` file to change
configuration globally.
+As a consequence:
+- it can be added to `MAVEN_OPTS` or `MAVEN_ARGS` environment variables,
+- it can also be added to `.mvn/maven.config` file in order to configure per
project,
+- it can also be added as property in `settings.xml` file to change
configuration globally.
-*NOTICE* as `maven.plugin.validation` is configuration item for Maven itself,
it can not be used in project pom.xml
+But it can not be used as a user property in project `pom.xml`.
Review Comment:
POM property
##########
content/markdown/guides/plugins/validation/index.md:
##########
@@ -19,56 +19,65 @@ specific language governing permissions and limitations
under the License.
-->
-Maven since versions 3.9.x and 4.x introduced `Plugin Validation`
-in order to help Maven users and Maven Plugin developers maintain theirs
projects.
+Maven since versions 3.9.x and 4.x introduced **Plugin Validation**
+in order to help Maven users and Maven Plugin developers discover issues with
the plugins they
+use or maintain that may break in the future.
-## Internal Plugins Validation issues
+These issues are displayed as WARNING either when plugin goal is executed or
at the end of the build:
+
+```
+[WARNING] Plugin validation issues were detected in x plugin(s)
+```
+
+and split in 2 categories based on what actions should be taken:
+
+## Internal issues
Internal Plugins Validation issues (project local) are issues discovered in
Maven project configuration, like:
- - using deprecated plugins goals
- - using deprecated plugins parameters
- - using read only plugins parameters
+ - project using deprecated plugins goals
([MNG-7457](https://issues.apache.org/jira/browse/MNG-7457)),
+ - project using deprecated plugins parameters,
+ - project using read only plugins parameters
([MNG-7464](https://issues.apache.org/jira/browse/MNG-7464)).
-In such cases users can fix their project by fixing configuration by editing
their POMs.
-Users should consult actual plugin documentation or try to update plugin to
newer version.
+In such cases, users can fix their project by fixing configuration by editing
their POMs.
+Users should consult actual plugin documentation (and eventually try to update
plugin to newer version).
-## External Plugins Validation issues
+## External issues
External Plugins Validation issues (non-configuration) are issues detected in
plugin itself, like:
- - using old, deprecated Maven Api by plugin
- - declaring dependencies for Maven Core artifacts in wrong scope in plugin
project
+ - plugin using old, deprecated Maven API,
+ - plugin declaring dependencies for Maven Core artifacts in wrong scope
(should be `provided`).
-External Plugins issues can only be fix by plugin authors.
+External Plugins issues require to be fixed by plugin authors first.
-In such cases users can try to update plugin to newer version.
-If the newest version of plugin still has an issue users should report problem
to plugin authors.
+In such cases users can try to update plugin to newer version.
+If the newest version of plugin still has such an issue, users should report
problem to plugin authors.
## Manage Plugin Validation verbosity
-In order to manage Plugin Validation verbosity a property
`maven.plugin.validation` can be used.
+In order to manage Plugin Validation verbosity, a system property
`-Dmaven.plugin.validation=...` can be used on command line (or injected: see
below).
Review Comment:
From the description below it can be any scoped property, not just system,
no?
##########
content/markdown/guides/plugins/validation/index.md:
##########
@@ -19,56 +19,65 @@ specific language governing permissions and limitations
under the License.
-->
-Maven since versions 3.9.x and 4.x introduced `Plugin Validation`
-in order to help Maven users and Maven Plugin developers maintain theirs
projects.
+Maven since versions 3.9.x and 4.x introduced **Plugin Validation**
+in order to help Maven users and Maven Plugin developers discover issues with
the plugins they
+use or maintain that may break in the future.
-## Internal Plugins Validation issues
+These issues are displayed as WARNING either when plugin goal is executed or
at the end of the build:
+
+```
+[WARNING] Plugin validation issues were detected in x plugin(s)
+```
+
+and split in 2 categories based on what actions should be taken:
+
+## Internal issues
Internal Plugins Validation issues (project local) are issues discovered in
Maven project configuration, like:
- - using deprecated plugins goals
- - using deprecated plugins parameters
- - using read only plugins parameters
+ - project using deprecated plugins goals
([MNG-7457](https://issues.apache.org/jira/browse/MNG-7457)),
+ - project using deprecated plugins parameters,
Review Comment:
plugin parameters
> Plugins verification - reports are inconsistent
> -----------------------------------------------
>
> Key: MNG-7811
> URL: https://issues.apache.org/jira/browse/MNG-7811
> Project: Maven
> Issue Type: Bug
> Components: Plugins and Lifecycle
> Reporter: Slawomir Jaranowski
> Assignee: Slawomir Jaranowski
> Priority: Major
> Fix For: 3.9.3, 4.0.0-alpha-7, 4.0.0
>
>
> We have report modes:
> {noformat}
> - NONE, // mute validation completely (validation issue collection still
> happens, it is just not reported!)
> - INLINE, // inline, each "internal" problem one line next to mojo invocation
> - SUMMARY, // at end, list of plugin GAVs along with "internal" issues
> - BRIEF, // synonym to SUMMARY
> - VERBOSE // at end, list of plugin GAVs along with detailed report of ANY
> validation issues
> {noformat}
> *NONE*
> - is ok works as expected, as documented
> *INLINE*
> - is ok works as expected, as documented
> *SUMMARY*, *BRIEF*
> - are the same - *{color:#ff0000}bug{color}*
> - prints *internal* issues in *VERBOSE* mode - *{color:#ff0000}bug{color}*
> *VERBOSE*
> - is ok works as expected, as documented
> So we don't have possibility to report an external issues in brief mode - as
> a list at the end, also - *{color:#ff0000}bug{color}*
> h1. Proposition
> - *SUMMARY* - prints *internal* and *external* issues as list at the end
> - *BRIEF* - prints *internal* issues in *INLINE* and *external* as list at
> the end
> - prepare documentation on Maven site with explanation of common issues and
> what user can do with it
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
