Configuring Reports
Since version 1.1, all Maven reports will be included by default in the generated PDF. You should configure the <reporting/> section of your POM similar than the site plugin
For instance, you could have the following:
<project> ... <reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-project-info-reports-plugin</artifactId> <version>2.1.2</version> <reportSets> <reportSet> <reports> <report>project-team</report> ... </reports> </reportSet> </reportSets> </plugin> ... </plugins> </reporting> ... <project>
- to exclude the reporting generation inside the PDF, you should add
-DincludeReports=false
in the command line. - only internal reporting plugins will be added in the PDF, external reporting plugins like Javadoc will be skipped.
Enhancements
Having many reports increases hugely the build time, so it is recommended to select only the wanted
reports to be included in the PDF. It is recommended to define a reporting
profile in your
pom, similar to the following:
<project> ... <profiles> <profile> <id>pdf</id> <reporting> <plugins> <plugin> <artifactId>maven-project-info-reports-plugin</artifactId> <version>2.1.2</version> <reportSets> <reportSet> <reports> <report>cim</report> <!-- take too long time <report>dependencies</report> --> <report>dependency-convergence</report> <report>dependency-management</report> <!-- already present <report>index</report> --> <report>issue-tracking</report> <report>license</report> <report>mailing-list</report> <report>plugin-management</report> <report>plugins</report> <report>project-team</report> <report>scm</report> <report>summary</report> </reports> </reportSet> </reportSets> </plugin> </plugins> </reporting> <build> <defaultGoal>pdf:pdf</defaultGoal> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-pdf-plugin</artifactId> <version>1.6.2-SNAPSHOT</version> </plugin> </plugins> </build> </profile> ... </profiles> ... <project>