Apache Maven SIte站点插件

x33g5p2x  于2022-10-14 转载在 Apache  
字(1.4k)|赞(0)|评价(0)|浏览(660)

1.概述

Site Plugin用于为项目生成站点。生成的站点还包括POM中配置的项目报告。

2.插件目标

站点插件有七个目标:

  • site:site用于为单个项目生成站点。请注意,由于本地构建目录结构和部署的站点不匹配,多模块构建中模块站点之间的链接将无法工作。
  • site:deploy用于将使用Wagon支持的协议生成的站点部署到POM部分中指定的站点URL。
  • site:run启动站点,按要求呈现文档以加快编辑速度。它使用Jetty作为web服务器。
  • site:stage根据POM部分中指定的站点URL在本地登台或模拟目录中生成站点。它可以用于测试多模块构建工作中模块站点之间的链接。这个目标要求站点已经使用站点目标生成,例如通过调用mvn站点。
  • site:stage-deploy将生成的站点部署到POM部分中指定的站点URL的登台或模拟目录中。
  • site:attach-descriptor将站点描述符(site.xml)添加到要安装/部署的文件列表中。关于站点描述符的更多参考,这里有一个链接。
  • site:jar将站点输出捆绑到jar中,以便可以将其部署到存储库中。
  • site:有效site在继承和插值后计算有效site描述符。

1.用途您可以生成不同类型的报告。

  • 生成站点
  • 部署站点
  • 暂存站点
  • 运行站点

生成站点

要生成项目的站点和报告,请执行:

mvn site

默认情况下,生成的站点将位于target/site/目录中。

部署站点

为了能够部署站点,必须首先指定站点的部署位置。这在POM的元素中设置,如下所示。

<project>
  ...
  <distributionManagement>
    <site>
      <id>www.yourcompany.com</id>
      <url>scp://www.yourcompany.com/www/docs/project/</url>
    </site>
  </distributionManagement>
  ...
</project>

元素标识存储库,以便您可以在设置中为其附加凭据。xml文件使用元素,就像对任何其他存储库一样。
给出了部署的位置。在上面的示例中,我们通过scp协议使用路径/www/docs/project/复制到主机www.mycompany.com。您可以在此页面上阅读有关支持哪些协议的更多信息。如果子项目从父POM继承站点URL,它们将自动附加它们,以形成有效的部署位置。

mvn site:deploy

如果要生成站点并一次性部署,可以利用站点生命周期的站点部署阶段。为此,只需执行:

mvn site-deploy

暂存站点

要在正式部署之前查看/测试生成的网站,可以将该网站放置在特定目录中。它将使用元素或项目层次结构来链接项目及其模块。
只需执行站点:项目的阶段目标

mvn site:stage

运行站点

Site插件还可用于启动Jetty中的站点。为此,执行:

mvn site:run

4.示例

在Maven中,可以使用“mvn-site”为项目信息生成文档站点。

mvn site

生成的站点位于项目“target/site”文件夹下。

5.结论

在这个快速指南中,我们详细介绍了站点插件,并给出了使用和定制它的说明。我们还看到了不同的插件目标及其用法。
参考:https://maven.apache.org/plugins/maven-site-plugin/

相关文章

微信公众号

最新文章

更多