Plugin Documentation
This report describes goals, parameters details, requirements and sample usage of this plugin.
Goals
Goals available for this plugin:
Goal | Description |
---|---|
help:active-profiles | Displays a list of the profiles which are currently active for this build. |
help:all-profiles | Displays a list of available profiles under the current project.
Note: it will list all profiles for a project. If a profile comes up with a status inactive then there might be a need to set profile activation switches/property. |
help:describe | Displays a list of the attributes for a Maven Plugin and/or goals (aka Mojo - Maven plain Old Java Object). See also: What is a Mojo? |
help:effective-pom | Displays the effective POM as an XML for this build, with the active profiles factored in, or a specified artifact. If verbose , a comment is added to each XML element describing the origin of the line. |
help:effective-settings | Displays the calculated settings as XML for this project, given any profile enhancement and the inheritance of the global settings into the user-level settings. |
help:evaluate | Evaluates Maven expressions given by the user in an interactive mode. |
help:help | Display help information on maven-help-plugin.
Call mvn help:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. |
help:system | Displays a list of the platform details like system properties and environment variables. |
System Requirements
The following specifies the minimum requirements to run this Maven plugin:
Maven | 3.6.3 |
JDK | 1.8 |
System Requirements History
The following specifies the minimum requirements to run this Maven plugin for historical versions:
Plugin Version | Maven | JDK |
---|---|---|
from 3.4.0 to 3.5.1 | 3.6.3 | 8 |
3.3.0 | 3.2.5 | 8 |
from 3.0.0 to 3.2.0 | 3.0 | 7 |
2.2 | 2.2.1 | 5 |
from 2.1 to 2.1.1 | 2.0.6 | 1.4 |
2.0.2 | 2.0 | 1.4 |
from 2.0 to 2.0.1 | - | - |
Usage
You should specify the version in your project's plugin configuration:
- <project>
- ...
- <build>
- <!-- To define the plugin version in your parent POM -->
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-help-plugin</artifactId>
- <version>3.5.1</version>
- </plugin>
- ...
- </plugins>
- </pluginManagement>
- <!-- To use the plugin goals in your POM or parent POM -->
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-help-plugin</artifactId>
- </plugin>
- ...
- </plugins>
- </build>
- ...
- </project>
For more information, see "Guide to Configuring Plug-ins"