Apache Maven Project Info Reports Plugin
The Maven Project Info Reports plugin is used to generate reports information about the project.
Goals Overview
The Project Info Reports Plugin has the following goals:
- project-info-reports:ci-management is used to generate the Project Continuous Integration Management report.
- project-info-reports:dependencies is used to generate the Project Dependencies report.
- project-info-reports:dependency-convergence is used to generate the Project Dependency Convergence report for (reactor) builds.
- project-info-reports:dependency-info is used to generate code snippets to be added to build tools.
- project-info-reports:dependency-management is used to generate the Project Dependency Management report.
- project-info-reports:distribution-management is used to generate the Project Distribution Management report.
- project-info-reports:help is used to display help information on the Project Info Reports Plugin.
- project-info-reports:index is used to generate the Project index page.
- project-info-reports:issue-management is used to generate the Project Issue Management report.
- project-info-reports:licenses is used to generate the Project Licenses report.
- project-info-reports:mailing-lists is used to generate the Project Mailing Lists report.
- project-info-reports:modules is used to generate the Project Modules report.
- project-info-reports:plugin-management is used to generate the Project Plugin Management report.
- project-info-reports:plugins is used to generate the Project Plugins report.
- project-info-reports:team is used to generate the Project Team report.
- project-info-reports:scm is used to generate the Project Source Code Management report.
- project-info-reports:summary is used to generate the Project Summary report.
Incompatibility Notice
With the major version 3.0 several mojos and output filenames have been changed for alignment with their corresponding elements in the POM. In other words, mojos have the same names as their POM counterparts. To make you aware of that, see the following table for the upcoming changes:
| Goal Name | New Goal Name | Output name | New Output Name |
|---|---|---|---|
| cim | ci-management | integration.html | ci-management.html |
| mailing-list | mailing-lists | mail-lists.html | mailing-lists.html |
| project-team | team | team-list.html | team.html |
| license | licenses | license.html | licenses.html |
| issue-tracking | issue-management | issue-tracking.html | issue-management.html |
| scm | – | source-repository.html | scm.html |
| summary | – | project-summary.html | summary.html |
Details about this change can be found in MPIR-323.
Usage
General instructions on how to use the Project Info Reports Plugin can be found on the usage page. Some more specific use cases are described in the examples given below.
In case you still have questions regarding the plugin's usage, please have a look at the FAQ and feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.
If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our source repository and will find supplementary information in the guide to helping with Maven.
Examples
To provide you with better understanding on some usages of the Maven Project Info Reports Plugin, you can take a look into the following examples: