{"id":237,"date":"2010-04-14T11:02:03","date_gmt":"2010-04-14T11:02:03","guid":{"rendered":"http:\/\/www.scmgalaxy.com\/tutorials\/2010\/04\/14\/reporting-plugins-in-maven\/"},"modified":"2021-11-20T05:15:01","modified_gmt":"2021-11-20T05:15:01","slug":"reporting-plugins-in-maven","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/reporting-plugins-in-maven\/","title":{"rendered":"Reporting Plugins in Maven | Maven Plugins That Provide Reports"},"content":{"rendered":"

\"reporting-plugins-in-maven\"<\/p>\n

Reporting plugins<\/b>
\nPlugins which generate reports, are configured as reports in the POM and run under the site generation
\nlifecycle.<\/p>\n

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.<\/p>\n

Run All Reports<\/b>
\nTo include all Project Info Reports in your project, you must configure your pom.xml. Use “mvn site:site” to generate the configured reports.<\/p>\n

project
\n…<\/p>\n

…
\norg.apache.maven.plugins
\nmaven-project-info-reports-plugin
\n…<\/p>\n

…<\/p>\n

Run Selective Reports<\/b><\/p>\n

…<\/p>\n

…
\norg.apache.maven.plugins
\nmaven-project-info-reports-plugin<\/p>\n

dependencies
\nproject-team
\nmailing-list
\ncim
\nissue-tracking
\nlicense
\nscm<\/p>\n

…<\/p>\n

…<\/p>\n

Reporting plugins are configured in the POM as in this example:<\/b>
\n…<\/p>\n

org.apache.maven.plugins
\nmaven-project-info-reports-plugin<\/p>\n

…<\/p>\n

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 .<\/b><\/p>\n

Configuring multiple reports for one plugin using . Each must have a unique . For more information on UMLGraph, see the UMLGraph site and this page.<\/b><\/p>\n

…<\/p>\n

org.apache.maven.plugins
\nmaven-javadoc-plugin<\/p>\n

uml<\/p>\n

gr.spinellis.umlgraph.doclet.UmlGraph<\/p>\n

gr.spinellis
\nUmlGraph
\n4.4<\/p>\n

-views
\ntarget\/uml
\nprivate<\/p>\n

javadoc<\/p>\n

html<\/p>\n

private<\/p>\n

javadoc<\/p>\n

…<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Plugins<\/td>\nType<\/td>\nVersion<\/td>\nRelease Date<\/td>\nDescription<\/td>\nSource Repository<\/td>\nIssue Tracking<\/td>\n<\/tr>\n
changelog<\/td>\nR<\/td>\n2.1<\/td>\n2007-07-25<\/td>\nGenerate a
\nlist of recent
\nchanges from
\nyour SCM.<\/td>\n		SVN<\/td>\nJIRA<\/td>\n<\/tr>\n
changes<\/td>\nB+R<\/td>\n2.1<\/td>\n2008-11-24<\/td>\nGenerate a
\nreport from
\nissue tracking
\nor a change
\ndocument.<\/td>\n		SVN<\/td>\nJIRA<\/td>\n<\/tr>\n
checkstyle<\/td>\nB+R<\/td>\n2.3<\/td>\n2009-07-14<\/td>\nGenerate a
\ncheckstyle
\nreport.<\/td>\n		SVN<\/td>\nJIRA<\/td>\n<\/tr>\n
clover<\/td>\nB+R<\/td>\n2.4<\/td>\n2007-04-23<\/td>\nGenerate
\na Clover
\nreport. NOTE:
\nMoved to
\nAtlassian.com<\/td>\n		SVN<\/td>\nJIRA<\/td>\n<\/tr>\n
doap<\/td>\nB<\/td>\n1.0<\/td>\n2008-08-01<\/td>\nGenerate a
\nDescription
\nof a Project
\n(DOAP) file
\nfrom a POM.<\/td>\n		SVN<\/td>\nJIRA<\/td>\n<\/tr>\n
docck<\/td>\nB<\/td>\n1.0<\/td>\n2008-11-16<\/td>\nDocumentation
\nchecker
\nplugin.<\/td>\n		SVN<\/td>\nJIRA<\/td>\n<\/tr>\n
javadoc<\/td>\nB+R<\/td>\n2.6<\/td>\n2009-07-29<\/td>\nGenerate
\nJavadoc for
\nthe project.<\/td>\n		SVN<\/td>\nJIRA<\/td>\n<\/tr>\n
Jxr<\/td>\nR<\/td>\n2.1<\/td>\n2007-04-05<\/td>\nGenerate a
\nsource cross
\nreference.<\/td>\n		SVN<\/td>\nJIRA<\/td>\n<\/tr>\n
pmd<\/td>\nB+R<\/td>\n2.4<\/td>\n2008-01-08<\/td>\nGenerate a
\nPMD report.<\/td>\n		SVN<\/td>\nJIRA<\/td>\n<\/tr>\n
projectinforeports<\/td>\nR<\/td>\n2.1.2<\/td>\n2009-07-23<\/td>\nGenerate
\nstandard
\nproject
\nreports.<\/td>\n		SVN<\/td>\nJIRA<\/td>\n<\/tr>\n
surefirereport<\/td>\nR<\/td>\n2.4.3<\/td>\n2008-05-14<\/td>\nGenerate a
\nreport based
\non the results
\nof unit tests.<\/td>\n		SVN<\/td>\nJIRA<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Known Plugins That Provide Reports<\/h2>\n