使用 GitHub Actions 進行快取管理

本頁包含使用 GitHub Actions 的快取儲存後端示例。

注意
有關快取儲存後端的更多詳細資訊，請參閱快取儲存後端。

內聯快取

在大多數情況下，您會希望使用內聯快取匯出器。但是，請注意inline快取匯出器僅支援min快取模式。要使用max快取模式，請使用帶有cache-to選項的登錄檔快取匯出器分別推送映象和快取，如登錄檔快取示例所示。

name: ci

on:
  push:

jobs:
  docker:
    runs-on: ubuntu-latest
    steps:
      - name: Login to Docker Hub
        uses: docker/login-action@v3
        with:
          username: ${{ vars.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Build and push
        uses: docker/build-push-action@v6
        with:
          push: true
          tags: user/app:latest
          cache-from: type=registry,ref=user/app:latest
          cache-to: type=inline

登錄檔快取

您可以使用登錄檔快取匯出器從登錄檔上的快取清單或（特殊）映象配置匯入/匯出快取。

name: ci

on:
  push:

jobs:
  docker:
    runs-on: ubuntu-latest
    steps:
      - name: Login to Docker Hub
        uses: docker/login-action@v3
        with:
          username: ${{ vars.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Build and push
        uses: docker/build-push-action@v6
        with:
          push: true
          tags: user/app:latest
          cache-from: type=registry,ref=user/app:buildcache
          cache-to: type=registry,ref=user/app:buildcache,mode=max

GitHub 快取

快取後端 API

可用性：實驗性

GitHub Actions 快取匯出器後端使用GitHub 快取服務 API來獲取和上傳快取 blob。因此，您應該只在 GitHub Action 工作流中使用此快取後端，因為url ($ACTIONS_RESULTS_URL) 和token ($ACTIONS_RUNTIME_TOKEN) 屬性只在工作流上下文中填充。

name: ci

on:
  push:

jobs:
  docker:
    runs-on: ubuntu-latest
    steps:
      - name: Login to Docker Hub
        uses: docker/login-action@v3
        with:
          username: ${{ vars.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Build and push
        uses: docker/build-push-action@v6
        with:
          push: true
          tags: user/app:latest
          cache-from: type=gha
          cache-to: type=gha,mode=max

重要
從2025 年 4 月 15 日起，僅支援 GitHub Cache service API v2。
如果在構建過程中遇到以下錯誤
ERROR: failed to solve: This legacy service is shutting down, effective April 15, 2025. Migrate to the new service ASAP. For more information: https://gh.io/gha-cache-sunset
您可能正在使用僅支援舊版 GitHub Cache service API v1 的過時工具。以下是您需要升級到的最低版本，具體取決於您的使用情況
Docker Buildx >= v0.21.0
BuildKit >= v0.20.0
Docker Compose >= v2.33.1
Docker Engine >= v28.0.0（如果您使用啟用了 containerd 映象儲存的 Docker 驅動程式進行構建）
如果您在 GitHub 託管的執行器上使用docker/build-push-action或docker/bake-action進行構建，則 Docker Buildx 和 BuildKit 已經是最新的，但在自託管執行器上，您可能需要自己更新它們。或者，您可以使用docker/setup-buildx-action操作安裝最新版本的 Docker Buildx
- name: Set up Docker Buildx
  uses: docker/setup-buildx-action@v3
  with:
   version: latest
如果您使用 Docker Compose 進行構建，您可以使用docker/setup-compose-action操作
- name: Set up Docker Compose
  uses: docker/setup-compose-action@v1
  with:
   version: latest
如果您使用啟用了 containerd 映象儲存的 Docker Engine 進行構建，您可以使用docker/setup-docker-action操作
-
  name: Set up Docker
  uses: docker/setup-docker-action@v4
  with:
    version: latest
    daemon-config: |
      {
        "features": {
          "containerd-snapshotter": true
        }
      }

快取掛載

BuildKit 預設不會在 GitHub Actions 快取中保留快取掛載。要將快取掛載放入 GitHub Actions 快取並在構建之間重用，您可以使用reproducible-containers/buildkit-cache-dance提供的解決方法。

此 GitHub Action 建立臨時容器，以使用您的 Docker 構建步驟提取和注入快取掛載資料。

以下示例演示瞭如何將此解決方法與 Go 專案一起使用。

build/package/Dockerfile中的 Dockerfile 示例

FROM golang:1.21.1-alpine as base-build

WORKDIR /build
RUN go env -w GOMODCACHE=/root/.cache/go-build

COPY go.mod go.sum ./
RUN --mount=type=cache,target=/root/.cache/go-build go mod download

COPY ./src ./
RUN --mount=type=cache,target=/root/.cache/go-build go build -o /bin/app /build/src
...

CI Action 示例

name: ci

on:
  push:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Login to Docker Hub
        uses: docker/login-action@v3
        with:
          username: ${{ vars.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: Set up QEMU
        uses: docker/setup-qemu-action@v3

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Docker meta
        id: meta
        uses: docker/metadata-action@v5
        with:
          images: user/app
          tags: |
            type=ref,event=branch
            type=ref,event=pr
            type=semver,pattern={{version}}
            type=semver,pattern={{major}}.{{minor}}

      - name: Go Build Cache for Docker
        uses: actions/cache@v4
        with:
          path: go-build-cache
          key: ${{ runner.os }}-go-build-cache-${{ hashFiles('**/go.sum') }}

      - name: Inject go-build-cache
        uses: reproducible-containers/buildkit-cache-dance@4b2444fec0c0fb9dbf175a96c094720a692ef810 # v2.1.4
        with:
          cache-source: go-build-cache

      - name: Build and push
        uses: docker/build-push-action@v6
        with:
          cache-from: type=gha
          cache-to: type=gha,mode=max
          file: build/package/Dockerfile
          push: ${{ github.event_name != 'pull_request' }}
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}
          platforms: linux/amd64,linux/arm64

有關此解決方法的更多資訊，請參閱GitHub 倉庫。

本地快取

警告
目前，舊的快取條目不會被刪除，因此快取大小持續增長。以下示例使用Move cache步驟作為解決方法（有關詳細資訊，請參閱moby/buildkit#1896）。

您還可以使用actions/cache和本地快取匯出器透過此操作利用GitHub 快取

name: ci

on:
  push:

jobs:
  docker:
    runs-on: ubuntu-latest
    steps:
      - name: Login to Docker Hub
        uses: docker/login-action@v3
        with:
          username: ${{ vars.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Cache Docker layers
        uses: actions/cache@v4
        with:
          path: ${{ runner.temp }}/.buildx-cache
          key: ${{ runner.os }}-buildx-${{ github.sha }}
          restore-keys: |
            ${{ runner.os }}-buildx-

      - name: Build and push
        uses: docker/build-push-action@v6
        with:
          push: true
          tags: user/app:latest
          cache-from: type=local,src=${{ runner.temp }}/.buildx-cache
          cache-to: type=local,dest=${{ runner.temp }}/.buildx-cache-new,mode=max

      - # Temp fix
        # https://github.com/docker/build-push-action/issues/252
        # https://github.com/moby/buildkit/issues/1896
        name: Move cache
        run: |
          rm -rf ${{ runner.temp }}/.buildx-cache
          mv ${{ runner.temp }}/.buildx-cache-new ${{ runner.temp }}/.buildx-cache