michael-o commented on code in PR #461: URL: https://github.com/apache/maven-site/pull/461#discussion_r1350059190
########## 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: > So just change "a system property `-Dmaven.plugin.validation=...`" into "a Maven user property `-Dmaven.plugin.validation=...`" as `-D` is really just that: defines user property. Correct, I agree with that. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
