简介
本指南介绍如何创建执行 Docker 构建的工作流程，然后将 Docker 映像发布到 Docker Hub 或 GitHub Packages。 通过单个工作流程，您可以将映像发布到单一注册表或多个注册表。
注意：如果你想推送到另一个第三方 Docker 注册表，“将映像发布到 GitHub Packages”部分中的示例可以用作一个很好的模板。
先决条件
建议基本了解工作流程配置选项和如何创建工作流程文件。 有关详细信息，请参阅“了解 GitHub Actions”。
您可能还发现基本了解以下内容是有帮助的：
- "加密机密"
- “自动令牌身份验证”
- “使用 Docker 注册表”
关于映像配置
本指南假定您对存储在 GitHub 仓库的 Docker 映像有完整的定义。 例如，存储库必须包含一个 Dockerfile，以及执行 Docker 构建以创建映像所需的任何其他文件。
在本指南中，我们将使用 Docker build-push-action 操作来构建 Docker 映像并将其推送到一个或多个 Docker 注册表。 有关详细信息，请参阅 build-push-action。
将映像发布到 Docker Hub
每次在 GitHub AE 上创建新版本时，都可以触发工作流来发布映像。 以下示例中的工作流在活动类型为 created 的 release 事件触发时运行。 有关 release 事件的详细信息，请参阅“触发工作流的事件”。
在下面的示例工作流中，我们使用 Docker login-action 和 build-push-action 操作来构建 Docker 映像，如果构建成功，则将构建的映像推送到 Docker Hub。
要推送到 Docker Hub，您需要有一个 Docker Hub 帐户，并创建一个 Docker Hub 仓库。 有关详细信息，请参阅 Docker 文档中的“将 Docker 容器映像推送到 Docker Hub”。
Docker Hub 所需的 login-action 选项是：
username和password：这是 Docker Hub 用户名和密码。 我们建议将 Docker Hub 用户名和密码存储为机密，使它们不会公开在工作流程文件中。 有关详细信息，请参阅“加密机密”。
Docker Hub 所需的 metadata-action 选项是：
images：你正在构建/推送到 Docker Hub 的 Docker 映像的命名空间和名称。
Docker Hub 所需的 build-push-action 选项是：
tags：你的新映像的标签，格式为DOCKER-HUB-NAMESPACE/DOCKER-HUB-REPOSITORY:VERSION。 您可以如下所示设置单个标记，或在列表中指定多个标记。push：如果设置为true，则映像将推送到注册表（如果成功构建）。
# 此工作流使用未经 GitHub 认证的操作。
# 它们由第三方提供，并受
# 单独的服务条款、隐私政策和支持
# 文档。
# GitHub 建议将操作固定到提交 SHA。
# 若要获取较新版本，需要更新 SHA。
# 还可以引用标记或分支，但该操作可能会更改而不发出警告。
name: Publish Docker image
on:
release:
types: [published]
jobs:
push_to_registry:
name: Push Docker image to Docker Hub
runs-on: ubuntu-latest
steps:
- name: Check out the repo
uses: actions/checkout@v3
- name: Log in to Docker Hub
uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
with:
images: my-docker-hub-namespace/my-docker-hub-repository
- name: Build and push Docker image
uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671
with:
context: .
file: ./Dockerfile
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}上述工作流签出 GitHub 存储库，使用 login-action 登录注册表，然后使用 build-push-action 操作：基于存储库的 Dockerfile 构建 Docker 映像；将映像推送到 Docker Hub，并向映像应用标签。
发布映像到 GitHub Packages
每次在 GitHub AE 上创建新版本时，都可以触发工作流来发布映像。 以下示例中的工作流在活动类型为 created 的 release 事件触发时运行。 有关 release 事件的详细信息，请参阅“触发工作流的事件”。
在下面的示例工作流中，我们使用 Docker login-action和 build-push-action 操作来构建 Docker 映像，如果构建成功，则将构建的映像推送到 GitHub Packages。
GitHub Packages 所需的 login-action 选项是：
registry：必须设置为docker.pkg.github.com。username：你可以使用${{ github.actor }}上下文自动使用触发工作流运行的用户的用户名。 有关详细信息，请参阅“上下文”。password：可以使用自动生成GITHUB_TOKEN的密码机密。 有关详细信息，请参阅“自动令牌身份验证”。
GitHub Packages 所需的 build-push-action 选项是：
-
push：如果设置为true，则映像将推送到注册表（如果成功构建）。 -
tags：必须采用格式docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION。例如，对于存储在
http://github.com/octo-org/octo-repo的 GitHub 上的名为octo-image的映像，tags选项应设置为docker.pkg.github.com/octo-org/octo-repo/octo-image:latest。 您可以如下所示设置单个标记，或在列表中指定多个标记。
# 此工作流使用未经 GitHub 认证的操作。
# 它们由第三方提供，并受
# 单独的服务条款、隐私政策和支持
# 文档。
# GitHub 建议将操作固定到提交 SHA。
# 若要获取较新版本，需要更新 SHA。
# 还可以引用标记或分支，但该操作可能会更改而不发出警告。
name: Publish Docker image
on:
release:
types: [published]
jobs:
push_to_registry:
name: Push Docker image to GitHub Packages
runs-on: ubuntu-latest
permissions:
packages: write
contents: read
steps:
- name: Check out the repo
uses: actions/checkout@v3
- name: Log in to GitHub Docker Registry
uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
with:
registry: docker.YOUR-HOSTNAME.com
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and push Docker image
uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671
with:
context: .
push: true
tags: |
docker.YOUR-HOSTNAME.com/${{ github.repository }}/octo-image:${{ github.sha }}
docker.YOUR-HOSTNAME.com/${{ github.repository }}/octo-image:${{ github.event.release.tag_name }}上述工作流签出 GitHub AE 存储库，使用 login-action 登录注册表，然后使用 build-push-action 操作：基于存储库的 Dockerfile 构建 Docker 映像；将映像推送到 Docker 注册表，并将提交 SHA 和发布版本应用为映像标签。
发布映像到 Docker Hub 和 GitHub Packages
在单个工作流中，你可以通过对每个注册表使用 login-action 和 build-push-action 操作将 Docker 映像发布到多个注册表。
以下示例工作流使用上述部分（“将映像发布到 Docker Hub”和“将映像发布到 GitHub Packages”）中的步骤创建推送到两个注册表的单个工作流。
# 此工作流使用未经 GitHub 认证的操作。
# 它们由第三方提供，并受
# 单独的服务条款、隐私政策和支持
# 文档。
# GitHub 建议将操作固定到提交 SHA。
# 若要获取较新版本，需要更新 SHA。
# 还可以引用标记或分支，但该操作可能会更改而不发出警告。
name: Publish Docker image
on:
release:
types: [published]
jobs:
push_to_registries:
name: Push Docker image to multiple registries
runs-on: ubuntu-latest
permissions:
packages: write
contents: read
steps:
- name: Check out the repo
uses: actions/checkout@v3
- name: Log in to Docker Hub
uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
- name: Log in to the Docker registry
uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
with:
registry: docker.YOUR-HOSTNAME.com
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
with:
images: |
my-docker-hub-namespace/my-docker-hub-repository
docker.YOUR-HOSTNAME.com/${{ github.repository }}/my-image
- name: Build and push Docker images
uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}上述工作流签出 GitHub AE 存储库，使用 login-action 两次以登录到两个注册表，并使用 metadata-action 操作生成标记和标签。
然后 build-push-action 操作构建 Docker 映像并将其推送到 Docker Hub 和 Docker 注册表。