在CI/CD流程中部署和访问静态报告

自动化部署静态报告至Web服务器

在持续集成/持续交付（CI/CD）流程中，生成测试报告、代码分析结果或文档等静态内容是常见需求。然而，如何将这些本地生成的静态报告便捷地共享给团队成员，使其能够通过Web浏览器直接访问，是许多开发者面临的问题。手动下载和解压不仅效率低下，也与CI/CD的自动化精神相悖。本教程将以Bamboo为例，阐述一种通用的解决方案，将静态报告作为构建产物，通过CI/CD的部署功能发布到远程Web服务器。

1. 理解静态报告的本质

静态报告通常由HTML、CSS、JavaScript和JSON文件组成，不涉及后端动态处理或数据库交互。它们在本地可以通过简单的HTTP服务器命令（如python -m http.server或npx serve）查看。在CI/CD环境中，这些报告在构建成功后，会被打包成一个或多个文件，成为“构建产物”（Artifact）。

2. 选择合适的部署目标

要使静态报告可被Web浏览器访问，需要将其放置在一个能够提供HTTP服务的服务器上。常见的选择包括：

• Apache HTTP Server
• Nginx
• Caddy
• 其他任何Web服务器

这些服务器通常有一个“文档根目录”（Document Root），例如 /var/www/html (Apache/Nginx默认) 或自定义路径，放置在该目录下的文件即可通过Web访问。

3. 利用CI/CD平台的部署能力

大多数CI/CD平台（如Bamboo, Jenkins, GitLab CI, CircleCI等）都提供了部署（Deployment）功能，允许将构建产物发布到远程环境。核心步骤包括：

3.1 定义构建产物（Artifact）

首先，确保你的CI/CD构建计划将生成的静态报告定义为可发布的构建产物。这意味着在构建结束后，这些文件会被收集并存储起来，供后续的部署计划使用。

示例：Bamboo中的Artifact定义 在Bamboo的Job配置中，找到 "Artifacts" 选项卡，添加一个新的Artifact：

• Name: Static Report
• Location: report/ (假设你的报告生成在构建目录下的 report 文件夹)
• Copy pattern: **/* (复制 report 目录下的所有文件)

3.2 创建部署计划

在CI/CD平台中创建一个独立的部署计划（Deployment Project），并关联到生成静态报告的构建计划。

3.3 配置部署任务：SCP文件传输

部署计划的核心是文件传输任务。安全复制协议（SCP）是常用的选择，它通过SSH协议安全地将文件从CI/CD代理传输到远程服务器。

示例：Bamboo SCP Task 配置

• Task type: SCP Task
• Server: 配置一个指向你的Web服务器的SSH服务器连接（通常在Bamboo的共享凭证中配置）。
  • Hostname: your_web_server_ip_or_hostname
  • Username: ssh_user
  • Authentication: 使用SSH密钥或密码。
• Source path: ${bamboo.build.artifact.StaticReport.path} (引用之前定义的Artifact路径)
• Destination path: /var/www/html/your_report_directory/ (远程Web服务器的文档根目录下的子目录，例如 /var/www/html/project-reports/latest/)
• Options: 勾选 "Copy contents only" 如果你想直接将报告内容复制到目标目录，而不是复制整个Artifact目录。

注意事项：

千图设计室AI海报

千图网旗下的智能海报在线设计平台

51

查看详情

• 权限: 确保SSH用户对目标目录拥有写入权限。
• 目录结构: 考虑是否需要在目标路径下创建版本化的目录（如 project-reports/v1.0/ 或 project-reports/latest/），以便管理不同版本的报告。

3.4 配置部署任务：SSH执行命令（可选但推荐）

如果你的静态报告被打包成ZIP或TAR文件，或者需要进行额外的清理/设置操作，可以使用SSH任务在远程服务器上执行命令。

示例：Bamboo SSH Task 配置

• Task type: SSH Task

• Server: 与SCP任务相同的SSH服务器连接。

• Commands:

  # 进入目标目录
  cd /var/www/html/your_report_directory/
  
  # 如果Artifact是压缩文件，先解压
  # unzip your_report_artifact.zip -d .
  # rm your_report_artifact.zip # 解压后删除压缩包
  
  # 清理旧报告（如果需要）
  # rm -rf /var/www/html/your_report_directory/old_reports/*
  
  # 确保文件权限正确
  chmod -R 755 .
  chown -R www-data:www-data . # 假设Web服务器运行用户是www-data

  登录后复制

注意事项：

• 幂等性: 编写的SSH命令应尽量保证幂等性，即重复执行不会产生副作用。
• Web服务器用户: chown 命令中的用户和组应与你的Web服务器（如Apache/Nginx）运行的用户和组相匹配。

4. 自动化部署触发器

为了实现全自动化，配置部署计划在构建计划成功完成后自动触发。

示例：Bamboo部署计划触发器 在部署计划的 "Triggers" 选项卡中，添加一个 "After successful build" 类型的触发器，并选择对应的构建计划。

5. 访问部署的静态报告

部署成功后，你就可以通过Web浏览器访问你的报告了。 假设你的Web服务器域名是 example.com，并且你将报告部署到了 /var/www/html/project-reports/latest/，那么访问URL可能是： http://example.com/project-reports/latest/index.html (如果你的主页文件是 index.html)

总结

通过上述步骤，你可以将CI/CD流程中生成的静态报告无缝地部署到远程Web服务器，实现报告的自动化发布和便捷访问。这不仅提升了团队协作效率，也确保了报告的及时性和可追溯性。关键在于合理配置构建产物、利用SCP安全传输文件，并结合SSH任务执行必要的远程操作，最终实现一个高效、自动化的报告发布管道。

以上就是在CI/CD流程中部署和访问静态报告的详细内容，更多请关注php中文网其它相关文章！