Apache Maven 站点插件

配置报告

Maven 有几个报告，您可以将它们添加到您的网站以显示项目的当前状态。这些报告采用插件目标的形式，就像那些用于构建项目的报告一样。

Maven Project Info Reports Plugin通过从 POM 中提取信息来提供许多标准报告，例如：

持续集成
依赖项
问题跟踪
执照
邮件列表
项目团队
源存储库

要了解更多信息，请参阅项目信息报告插件。

要将这些报告添加到您的站点，您必须将插件添加到 POM 中的<reporting>元素。以下示例显示如何配置标准项目信息报告，以友好的格式显示来自 POM 的信息：

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
        <version>2.6</version>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

如果您在站点描述符中包含了适当的<menu ref="reports"/>标记，那么当您重新生成站点时，这些项目将出现在名为“项目报告”的菜单中。

注意：许多报告插件提供了一个名为outputDirectory或类似的参数来指定其报告输出的目的地。此参数仅在报告插件独立运行时才相关，即直接从命令行调用。相反，当报告作为站点的一部分生成时，Maven 站点插件的配置将确定有效的输出目录，以确保所有报告最终都位于一个公共位置。

查看插件页面中的报告插件（“类型”列中的“R”值），以获取来自 Apache Maven 团队的可用报告插件列表。

从插件中选择报告：配置报告集

默认情况下，当您在报告部分添加插件时，插件中可用的每个报告目标都会呈现一次。

如果您只想从插件中选择一些报告，或者如果您想使用不同的配置多次运行报告，则需要配置报告集：

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
        <version>2.6</version>
        <reportSets>
          <reportSet>
            <reports><!-- select reports -->
              <report>index</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.9</version>
        <reportSets>
          <reportSet><!-- by default, id = "default" -->
            <reports><!-- select non-aggregate reports -->
              <report>javadoc</report>
              <report>test-javadoc</report>
            </reports>
          </reportSet>
          <reportSet><!-- aggregate reportSet, to define in poms having modules -->
            <id>aggregate</id>
            <inherited>false</inherited><!-- don't run aggregate in child modules -->
            <reports>
              <report>aggregate</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

注意：不要忘记为提供聚合器报告的插件定义 reportSets，例如 maven-javadoc-plugin、maven-jxr-plugin 或 maven-checkstyle-plugin，否则除了非汇总报告。

有关可用配置的完整描述，请参阅POM 参考中的 reportSet 文档。