Reporting plugins
Plugins which generate reports, are configured as reports in the POM and run under the site generation
lifecycle.
This plugin consists of several reports that you can run selectively, individually or even run all of them. Please see below for instructions on how to configure your pom.xml to do this.
Run All Reports
To include all Project Info Reports in your project, you must configure your pom.xml. Use “mvn site:site” to generate the configured reports.
project
…
…
org.apache.maven.plugins
maven-project-info-reports-plugin
…
…
Run Selective Reports
…
…
org.apache.maven.plugins
maven-project-info-reports-plugin
dependencies
project-team
mailing-list
cim
issue-tracking
license
scm
…
…
Reporting plugins are configured in the POM as in this example:
…
org.apache.maven.plugins
maven-project-info-reports-plugin
…
Configuration in the reporting section also applies if plugin goals are invoked individually. The converse is not true– if you configure the plugin inside , that configuration will NOT apply to .
Configuring multiple reports for one plugin using . Each must have a unique . For more information on UMLGraph, see the UMLGraph site and this page.
…
org.apache.maven.plugins
maven-javadoc-plugin
uml
gr.spinellis.umlgraph.doclet.UmlGraph
gr.spinellis
UmlGraph
4.4
-views
target/uml
private
javadoc
html
private
javadoc
…
Plugins | Type | Version | Release Date | Description | Source Repository | Issue Tracking |
changelog | R | 2.1 | 2007-07-25 | Generate a list of recent changes from your SCM. |
SVN | JIRA |
changes | B+R | 2.1 | 2008-11-24 | Generate a report from issue tracking or a change document. |
SVN | JIRA |
checkstyle | B+R | 2.3 | 2009-07-14 | Generate a checkstyle report. |
SVN | JIRA |
clover | B+R | 2.4 | 2007-04-23 | Generate a Clover report. NOTE: Moved to Atlassian.com |
SVN | JIRA |
doap | B | 1.0 | 2008-08-01 | Generate a Description of a Project (DOAP) file from a POM. |
SVN | JIRA |
docck | B | 1.0 | 2008-11-16 | Documentation checker plugin. |
SVN | JIRA |
javadoc | B+R | 2.6 | 2009-07-29 | Generate Javadoc for the project. |
SVN | JIRA |
Jxr | R | 2.1 | 2007-04-05 | Generate a source cross reference. |
SVN | JIRA |
pmd | B+R | 2.4 | 2008-01-08 | Generate a PMD report. |
SVN | JIRA |
projectinforeports | R | 2.1.2 | 2009-07-23 | Generate standard project reports. |
SVN | JIRA |
surefirereport | R | 2.4.3 | 2008-05-14 | Generate a report based on the results of unit tests. |
SVN | JIRA |
Known Plugins That Provide Reports
- Project-Info-Reports – Standard Reports
- Javadoc – Javadoc
- JXR – Source Cross-Reference
- Surefire-Report – Surefire Test Report
- Changes – Changes & JIRA Report
- Taglist – Taglist Report (For TODO, @deprecated, etc.)
- PMD – PMD Report for Source-code analysis
- How to Choose Wireless Access Points for Office - December 13, 2024
- Online Real Estate Courses: Navigating the Shift to Digital Education - December 13, 2024
- From Concept to Implementation: IoT Services Redefining Modern Solutions - December 13, 2024