Plugin Documentation
This report describes goals, parameters details, requirements and sample usage of this plugin.
Goals
Goals available for this plugin:
Goal | Description |
---|---|
tidy:check | Checks that the pom.xml is tidy. Fails the build if mvn tidy:pom would create a different pom.xml than the current one. |
tidy:help | Display help information on tidy-maven-plugin.
Call mvn tidy:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. |
tidy:pom | Tidy up the pom.xml into the canonical order. |
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 1.3.0 to 1.4.0 | 3.6.3 | 8 |
1.2.0 | 3.2.5 | 8 |
from 1.0-beta-1 to 1.1.0 | 2.2.1 | 6 |
from 1.0-alpha-1 to 1.0-alpha-2 | 2.2.1 | 5 |
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.codehaus.mojo</groupId>
<artifactId>tidy-maven-plugin</artifactId>
<version>1.4.0</version>
</plugin>
...
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>tidy-maven-plugin</artifactId>
</plugin>
...
</plugins>
</build>
...
</project>
For more information, see "Guide to Configuring Plug-ins"