GitHub Actions 构建摘要

Docker 的 GitHub Actions 用于构建和推送镜像,会为您的构建生成一个作业摘要,概述执行过程和所使用的材料:

  • 一个摘要,显示使用的 Dockerfile、构建持续时间和缓存利用率
  • 构建的输入,例如构建参数、标签、标记和构建上下文
  • 对于使用 Bake 的构建,该构建的完整 bake 定义
A GitHub Actions build summary

如果使用以下版本的 构建并推送 Docker 镜像Docker Buildx Bake GitHub Actions,Docker 构建的任务摘要将自动出现。

  • docker/build-push-action@v6
  • docker/bake-action@v5

要在作业完成后,在 GitHub 中打开作业的详细信息页面以查看作业摘要。摘要可用于失败和成功的构建。在构建失败的情况下,摘要还会显示导致构建失败的错误消息:

Builds summary error message

导入构建记录到 Docker Desktop

在 Docker Desktop 版本中引入 4.31

测试功能

导入构建目前处于 测试版

工作摘要中包含一个链接,用于下载该运行的构建记录存档。构建记录存档是一个 ZIP 文件,其中包含有关构建的详细信息(如果使用 docker/bake-action 构建多个目标,则为多个构建)。您可以将此构建记录存档导入 Docker Desktop,这为您提供了一个强大的图形界面,通过 Docker Desktop 构建 视图进一步分析构建性能。

要将构建记录存档导入到 Docker Desktop:

  1. 下载并安装 Docker Desktop

  2. 从 GitHub Actions 中的工作摘要下载构建记录存档。

  3. 在 Docker Desktop 中打开 构建 视图。

  4. 选择导入构建按钮,然后浏览您下载的.zip存档作业摘要。或者,您可以在打开导入构建对话框后,将构建记录存档ZIP文件拖放到Docker Desktop窗口中。

  5. 选择 导入 以添加构建记录。

几秒钟后,来自 GitHub Actions 运行的构建将出现在构建视图的 已完成的构建 选项卡下。要检查构建并查看所有输入、结果、构建步骤和缓存利用率的详细视图,请在列表中选择该项。

禁用作业摘要

要禁用作业摘要,请在构建步骤的 YAML 配置中设置环境变量 DOCKER_BUILD_SUMMARY

      - name: Build
        uses: docker/docker-build-push-action@v6
        env:
          DOCKER_BUILD_SUMMARY: false
        with:
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}

禁用构建记录上传

要禁用将构建记录存档上传到 GitHub,请在构建步骤的 YAML 配置中设置 DOCKER_BUILD_RECORD_UPLOAD 环境变量:

      - name: Build
        uses: docker/docker-build-push-action@v6
        env:
          DOCKER_BUILD_RECORD_UPLOAD: false
        with:
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}

使用此配置,仍会生成构建摘要,但不包含下载构建记录存档的链接。

限制

构建摘要目前不支持:

  • 使用 Docker 构建云。对 Docker 构建云的支持计划在未来的版本中发布。
  • Repositories hosted on GitHub Enterprise Servers. Summaries can only be viewed for repositories hosted on GitHub.com.