From 0d471a2e2793e0dadca140439aeb3dad8e8b9ad9 Mon Sep 17 00:00:00 2001 From: Sebastien Garelle Date: Fri, 6 Oct 2017 16:50:19 +0200 Subject: [PATCH] MPDF-48: Update site documentation & non supported report plugins. --- .../org/apache/maven/plugins/pdf/PdfMojo.java | 3 +- .../xdoc/examples/configuring-reports.xml.vm | 67 +++++-------------- 2 files changed, 17 insertions(+), 53 deletions(-) diff --git a/maven-pdf-plugin/src/main/java/org/apache/maven/plugins/pdf/PdfMojo.java b/maven-pdf-plugin/src/main/java/org/apache/maven/plugins/pdf/PdfMojo.java index bf3301af90..dcd61353cf 100644 --- a/maven-pdf-plugin/src/main/java/org/apache/maven/plugins/pdf/PdfMojo.java +++ b/maven-pdf-plugin/src/main/java/org/apache/maven/plugins/pdf/PdfMojo.java @@ -121,7 +121,8 @@ public class PdfMojo * @see MavenReport#generate(org.codehaus.doxia.sink.Sink, java.util.Locale) */ private final String[] failingReportClassName = - { "DependenciesReport", "TeamListReport", "DependencyConvergenceReport" }; + { "DependenciesReport", "TeamListReport", "DependencyConvergenceReport", "CheckstyleReport", + "ChangeLogReport", "DeveloperActivityReport", "FileActivityReport" }; /** * The vm line separator diff --git a/maven-pdf-plugin/src/site/xdoc/examples/configuring-reports.xml.vm b/maven-pdf-plugin/src/site/xdoc/examples/configuring-reports.xml.vm index 58c871fdad..62e3565e8f 100644 --- a/maven-pdf-plugin/src/site/xdoc/examples/configuring-reports.xml.vm +++ b/maven-pdf-plugin/src/site/xdoc/examples/configuring-reports.xml.vm @@ -31,12 +31,8 @@ under the License.

- Note for Maven 3 users: due to the changes in the reporting API, - report inclusion does not work with Maven 3. - See MPDF-41. -

-

- Since version 1.1, all Maven reports will be included by default in the generated PDF. + All Maven reports will be included by default in the generated PDF, with some exceptions. + See Maven Reporting Plugins Issues. You should configure the <reporting/> section of your POM similar than the site plugin

@@ -52,7 +48,7 @@ under the License. org.apache.maven.plugins maven-project-info-reports-plugin - 2.1.2 + 2.9 @@ -93,7 +89,7 @@ under the License. maven-project-info-reports-plugin - 2.1.2 + 2.9 @@ -137,7 +133,7 @@ under the License. - +

The Maven Project supports several reporting plugins. Unfortunately, some releases reporting plugins have known issues with the PDF plugin, mainly due to @@ -161,26 +157,22 @@ under the License. - - + - - -
ReportsRelease (2.1)Snapshot (2.2-SNAPSHOT)Release (2.3)
changelog:changelog NoYes
changelog:dev-activity NoYes
changelog:file-activity NoYes
@@ -188,25 +180,21 @@ under the License. - - + - - -
ReportsRelease (2.1)Snapshot (2.2-SNAPSHOT)Release (2.12.1)
changes:changes-reportNo Yes
changes:jira-reportNo Yes
changes:trac-reportNo Yes
@@ -218,14 +206,12 @@ under the License. - - + -
ReportsRelease (2.3)Snapshot (2.4-SNAPSHOT)Release (2.17)
checkstyle:checkstyle NoYes
@@ -233,14 +219,12 @@ under the License. - - + -
ReportsRelease (2.1)Snapshot (2.2-SNAPSHOT)Release (3.0.2)
dependency:analyze-report YesYes
@@ -248,13 +232,11 @@ under the License. - - + -
ReportsRelease (2.5)Snapshot (2.5.1-SNAPSHOT)Release (3.5)
plugin:reportNo Yes
@@ -263,19 +245,16 @@ under the License. - - + - -
ReportsRelease (2.4)Snapshot (2.5-SNAPSHOT)Release (3.8)
pmd:cpdNo Yes
pmd:pmdNo Yes
@@ -287,86 +266,72 @@ under the License. - - + - - - - + - - - - - - - - - + - -
ReportsRelease (2.1.2)Snapshot (2.2-SNAPSHOT)Release (2.9)
project-info-reports:cim YesYes
project-info-reports:dependencies NoYes
project-info-reports:dependency-convergenceYesYesNo
project-info-reports:dependency-management YesYes
project-info-reports:index YesYes
project-info-reports:issue-tracking YesYes
project-info-reports:license YesYes
project-info-reports:mailing-list YesYes
project-info-reports:plugin-management YesYes
project-info-reports:plugins YesYes
project-info-reports:project-teamYesYesNo
project-info-reports:scm YesYes
project-info-reports:summary YesYes
@@ -374,13 +339,11 @@ under the License. - - + -
ReportsRelease (2.4.3)Snapshot (2.5-SNAPSHOT)Release (2.20.1)
surefire-report:reportNo Yes