Plugin Documentation
This report describes goals, parameters details, requirements and sample usage of this plugin.
Goals
Goals available for this plugin:
Goal | Report? | Description |
---|---|---|
project-info-reports:ci-management | Yes | Generates the Project Continuous Integration Management report. |
project-info-reports:dependencies | Yes | Generates the Project Dependencies report. |
project-info-reports:dependency-convergence | Yes | Generates the Project Dependency Convergence report for (reactor) builds. |
project-info-reports:dependency-info | Yes | Generates code snippets of the Maven coordinates to be added to build tools. |
project-info-reports:dependency-management | Yes | Generates the Project Dependency Management report. |
project-info-reports:distribution-management | Yes | Generates the Project Distribution Management report. |
project-info-reports:help | No | Display help information on maven-project-info-reports-plugin.
Call mvn project-info-reports:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. |
project-info-reports:index | Yes | Generates the Project Index report. |
project-info-reports:issue-management | Yes | Generates the Project Issue Management report. |
project-info-reports:licenses | Yes | Generates the Project Licenses report. |
project-info-reports:mailing-lists | Yes | Generates the Mailing Lists report. |
project-info-reports:modules | Yes | Generates the Project Modules report. |
project-info-reports:plugin-management | Yes | Generates the Project Plugin Management report. |
project-info-reports:plugins | Yes | Generates the Project Plugins report. |
project-info-reports:scm | Yes | Generates the Project Source Code Management (SCM) report. |
project-info-reports:summary | Yes | Generates the Project Summary report. |
project-info-reports:team | Yes | Generates the Project Team report. |
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.6.0 to 3.6.1 | 3.6.3 | 8 |
from 3.3.0 to 3.5.0 | 3.2.5 | 8 |
from 3.0.0 to 3.2.2 | 3.0 | 7 |
from 2.7 to 2.9 | 2.2.1 | 5 |
from 2.3 to 2.6 | 2.2.0 | 5 |
2.2 | 2.1.0 | 1.4 |
from 2.1 to 2.1.2 | 2.0.6 | 1.4 |
from 2.0 to 2.0.1 | 2.0.4 | 1.4 |
from 2.0-beta-1 to 2.0-beta-3 | - | - |
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-project-info-reports-plugin</artifactId> <version>3.6.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-project-info-reports-plugin</artifactId> </plugin> ... </plugins> </build> ... <!-- To use the report goals in your POM or parent POM --> <reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-project-info-reports-plugin</artifactId> <version>3.6.1</version> </plugin> ... </plugins> </reporting> ... </project>
For more information, see "Guide to Configuring Plug-ins"