GitHub Actions 生成摘要

Docker 的 GitHub Actions 用于构建和推送镜像,会生成作业摘要 对于概述执行和使用的材料的构建:

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

如果您使用以下内容,则 Docker 构建的作业摘要会自动显示 版本Build and push Docker imagesDocker Buildx Bake GitHub Actions:

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

要查看作业摘要,请在 GitHub 中打开作业的详细信息页面,位于 作业已完成。摘要可用于 failed 和 successful 建立。如果构建失败,摘要还会显示错误 导致构建失败的消息:

Builds summary error message

将构建记录导入 Docker Desktop

在 Docker Desktop 版本中引入 4.31

Beta 版功能

导入版本目前处于 Beta 阶段

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

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

  1. 下载并安装 Docker Desktop

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

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

  4. 选择 Import build (导入生成) 按钮,然后浏览存档 您下载的 Job Summary 中。或者,您也可以拖放 打开后,将 build record 存档 ZIP 文件存档到 Docker Desktop 窗口中 Import build (导入生成) 对话框。.zip

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

几秒钟后,GitHub Actions 运行中的构建将显示在 Builds (构建) 视图中的 Completed builds (已完成的构建) 选项卡下。要检查 build 并查看 所有输入、结果、构建步骤和缓存利用率的详细视图, 在列表中选择项目。

禁用作业摘要

要禁用作业摘要,请设置环境变量 在构建步骤的 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 }}

使用此配置时,仍会生成生成摘要,但不会生成 包含用于下载 Build Record 存档的链接。

局限性

目前不支持以下各项的构建摘要:

  • 使用 Docker Build Cloud 进行构建。支持 Docker Build Cloud 计划在未来版本中发布。
  • 托管在 GitHub Enterprise Server 上的仓库。摘要只能是 查看 GitHub.com 上托管的仓库。