切换语言

将 Docker Scout 与 GitHub Actions 集成

目录

以下示例显示了如何使用 GitHub 设置 Docker Scout 工作流 行动。该作由拉取请求触发，构建镜像并使用 Docker Scout 将新版本与在 生产。

此工作流使用 docker/scout-action GitHub Action 运行docker scout compare命令来可视化 Pull Request 的镜像 与您在生产环境中运行的镜像进行叠加。

先决条件

  • 此示例假定您在 Docker Hub 中有一个现有的镜像存储库 或在启用了 Docker Scout 的另一个注册表中。
  • 此示例使用环境来比较 在拉取请求中使用同一镜像的不同版本构建的镜像 在名为production.

步骤

首先，设置 GitHub Action 工作流程以构建镜像。这并不具体 到 Docker Scout，但您需要构建一个镜像才能拥有 可以比较的东西。

将以下内容添加到 GitHub Actions YAML 文件：

name: Docker

on:
  push:
    tags: ["*"]
    branches:
      - "main"
  pull_request:
    branches: ["**"]

env:
  # Hostname of your registry
  REGISTRY: docker.io
  # Image repository, without hostname and tag
  IMAGE_NAME: ${{ github.repository }}
  SHA: ${{ github.event.pull_request.head.sha || github.event.after }}

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write

    steps:
      # Authenticate to the container registry
      - name: Authenticate to registry ${{ env.REGISTRY }}
        uses: docker/login-action@v3
        with:
          registry: ${{ env.REGISTRY }}
          username: ${{ secrets.REGISTRY_USER }}
          password: ${{ secrets.REGISTRY_TOKEN }}
      
      - name: Setup Docker buildx
        uses: docker/setup-buildx-action@v3

      # Extract metadata (tags, labels) for Docker
      - name: Extract Docker metadata
        id: meta
        uses: docker/metadata-action@v5
        with:
          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
          labels: |
            org.opencontainers.image.revision=${{ env.SHA }}            
          tags: |
            type=edge,branch=$repo.default_branch
            type=semver,pattern=v{{version}}
            type=sha,prefix=,suffix=,format=short            

      # Build and push Docker image with Buildx
      # (don't push on PR, load instead)
      - name: Build and push Docker image
        id: build-and-push
        uses: docker/build-push-action@v6
        with:
          sbom: ${{ github.event_name != 'pull_request' }}
          provenance: ${{ github.event_name != 'pull_request' }}
          push: ${{ github.event_name != 'pull_request' }}
          load: ${{ github.event_name == 'pull_request' }}
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}
          cache-from: type=gha
          cache-to: type=gha,mode=max

这将创建工作流步骤以：

  1. 设置 Docker buildx。
  2. 对注册表进行身份验证。
  3. 从 Git 引用和 GitHub 事件中提取元数据。
  4. 构建 Docker 镜像并将其推送到注册表。

注意

此 CI 工作流将运行镜像的本地分析和评估。自 在本地评估镜像，则必须确保镜像已加载到 运行器的本地镜像存储。

如果您将镜像推送到注册表，或者如果您 构建无法加载到运行器的本地镜像存储的镜像。为 示例，多平台镜像或具有 SBOM 或来源证明的镜像 无法加载到本地镜像存储。

完成此设置后，您可以添加以下步骤来运行 图片对比：

      # You can skip this step if Docker Hub is your registry
      # and you already authenticated before
      - name: Authenticate to Docker
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKER_USER }}
          password: ${{ secrets.DOCKER_PAT }}

      # Compare the image built in the pull request with the one in production
      - name: Docker Scout
        id: docker-scout
        if: ${{ github.event_name == 'pull_request' }}
        uses: docker/scout-action@v1
        with:
          command: compare
          image: ${{ steps.meta.outputs.tags }}
          to-env: production
          ignore-unchanged: true
          only-severities: critical,high
          github-token: ${{ secrets.GITHUB_TOKEN }}

compare 命令分析镜像并评估策略合规性，以及 将结果与production环境。此示例仅包括 Critical 和 High-severity vulnerabilities 的 Pixels 和 Excludes （漏洞），并排除两个镜像中都存在的 Vulnerabilities， 仅显示更改的内容。

GitHub Action 在拉取请求评论中输出比较结果 违约。

A screenshot showing the results of Docker Scout output in a GitHub Action

展开 Policies （策略） 部分以查看策略合规性的差异 在两个镜像之间。请注意，虽然此示例中的新镜像不是 完全兼容，则输出显示新镜像的 Standing 具有 与基线相比有所改善。

GHA policy evaluation output