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 Build Cloud的构建。计划在未来的版本中支持Docker Build Cloud。
  • 托管在GitHub Enterprise Server上的存储库。只能查看托管在GitHub.com上的存储库的摘要。