GitHub Actions 构建摘要

目录

Docker 的 GitHub Actions 用于构建和推送镜像，它们会为你的构建生成一个作业摘要，概述执行过程和使用的材料。

  • 显示所用 Dockerfile、构建时长和缓存利用率的摘要
  • 构建的输入，例如构建参数、标签和构建上下文
  • 对于使用 Bake 的构建，包含完整的构建 Bake 定义
A GitHub Actions build summary

如果你使用以下版本的 构建和推送 Docker 镜像 或 Docker Buildx Bake GitHub Actions

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

要查看作业摘要，作业完成后请在 GitHub 中打开该作业的详细信息页面。摘要适用于失败和成功的构建。如果构建失败，摘要还会显示导致构建失败的错误消息。

Builds summary error message

将构建记录导入 Docker Desktop

可用性： Beta
要求： 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/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/build-push-action@v6
        env:
          DOCKER_BUILD_RECORD_UPLOAD: false
        with:
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}

通过此配置，作业摘要仍然会生成，但不包含下载构建记录归档文件的链接。

限制

当前不支持构建摘要的情形：

  • 使用 Docker Build Cloud 进行的构建。Docker Build Cloud 的支持计划在未来版本中提供。
  • 托管在 GitHub Enterprise Servers 上的仓库。摘要只能在托管于 GitHub.com 的仓库中查看。
页面选项