Jenkins HTML Publisher 插件

• HTML Publisher
  • Usage
    • Installing and enabling the plugin
    • Using with Freestyle Jobs
    • Using with Pipeline Jobs

HTML Publisher

官网地址：HTML Publisher

HTML Publisher 插件可用于将构建生成的 HTML 报告发布到作业和构建页面。它旨在与 Freestyle 项目以及 Jenkins Pipeline 一起使用。

Usage

Installing and enabling the plugin

HTML Publisher 插件可以使用 插件管理 屏幕从任何连接到 Internet 的 Jenkins 安装中安装。安装后，该插件可以配置为 Jenkins Freestyle 作业的一部分，或在 Jenkins Pipeline 中使用。

Using with Freestyle Jobs

HTML Publisher 插件可以在 Jenkins 作业的后期构建部分进行配置。

• 要存档的 HTML 目录 - 相对于工作空间的要存档的报告目录的路径。
• 索引页[s] - 将用作索引页的文件的逗号分隔列表。可以使用蚂蚁图案。
• 索引页标题[s]（可选）- 索引页的可选标题，将用作选项卡名称。如果未提供，则将使用文件名。
• 报告标题 - 报告的名称。

单击 Publishing options… 将为您提供一些附加选项：

• 保留过去的 HTML 报告 - 是否保留所有存档报告或仅保留最后一个稳定版本的报告。
• 始终链接到上次构建 - 无论状态如何始终链接到上次构建的报告还是仅链接到上次成功构建的报告。
• 允许缺失报告 - 如果为 false 报告目录不存在，构建将被标记为失败。
• 包含文件 - 可选的 Ant 模式，指定报告目录中要归档的文件。默认归档给定报告目录中的所有文件。
• 报表标题中的转义下划线 - 如果为 true, 报表标题中的下划线将 _5F 与其他非字母数字字符一起转义。如果为 false 他们将保持原样。

Using with Pipeline Jobs

HTML Publisher 插件也可以用作 Jenkins Pipeline 的一部分。您需要做的就是参考 publishHTML 管道中的步骤。例如：

publishHTML (target : [allowMissing: false,
    alwaysLinkToLastBuild: true,
    keepAll: true,
    reportDir: 'reports',
    reportFiles: 'myreport.html',
    reportName: 'My Reports',
    reportTitles: 'The Report'])

有关可用步骤参数的参考，请参阅 https://jenkins.io/doc/pipeline/steps/htmlpublisher/。

为了帮助创建管道步骤，您可以使用代码段生成器并生成所需的代码。片段生成器可以在 <JENKINS-URL>/pipeline-syntax/ 找到