注: GitHub 托管的运行器目前在 GitHub Enterprise Server 上不受支持。 您可以在 GitHub 公共路线图 上查看有关未来支持计划的更多信息。
简介
本指南说明如何使用 GitHub Actions 构建并部署 Docker 容器到 Azure App Service。
基本要求
在创建 GitHub Actions 工作流程之前,首先需要完成以下设置步骤:
-
创建 Azure App Service 计划。
例如,可以使用 Azure CLI 创建新的应用服务计划:
Shell az appservice plan create \ --resource-group MY_RESOURCE_GROUP \ --name MY_APP_SERVICE_PLAN \ --is-linux
在上述命令中,将
MY_ResourcesURCE_GROUP
替换为您原有的 Azure 资源组,MY_APP_SERVICE_PLAN
替换为应用服务计划的新名称。请查看 Azure 文档以了解更多有关使用 Azure CLI 的信息:
- 有关身份验证,请参阅“使用 Azure CLI 登录”。
- 如果需要创建新的资源组,请参阅“az 组”。
-
创建 Web 应用。
例如,可以使用 Azure CLI 创建 Azure App Service web app:
Shell az webapp create \ --name MY_WEBAPP_NAME \ --plan MY_APP_SERVICE_PLAN \ --resource-group MY_RESOURCE_GROUP \ --deployment-container-image-name nginx:latest
在上面的命令中,将参数替换为您自己的值,其中
MY_WEBAPP_NAME
是 Web 应用的新名称。 -
配置 Azure 发布配置文件并创建
AZURE_WEBAPP_PUBLISH_PROFILE
机密。使用发布配置文件生成 Azure 部署凭据。 更多信息请参阅 Azure 文档中的“生成部署凭据”。
在 GitHub 仓库中,创建一个名为
AZURE_WEBAPP_PUBLISH_PROFILE
的机密,其中包含发布配置文件的内容。 有关创建机密的更多信息,请参阅“� 密密� �”。 -
设置 web app 的注册表凭据。
创建具有
repo
和read:packages
作用域的个人访问令牌。 更多信息请参阅“创建个人访问令牌”。将
DOCKER_REGISTRY_SERVER_URL
设置为https://ghcr.io
,将DOCKER_REGISTRY_SERVER_USERNAME
设置为拥有该存储库的 GitHub 用户名或组织,将DOCKER_REGISTRY_SERVER_PASSWORD
设置为上面的个人访问令牌。 这将提供 Web 应用凭据,以便在工作流程将新构建的� 像推送到注册表后,它可以拉取容器� 像。 可以使用以下 Azure CLI 命令执行此操作:az webapp config appsettings set \ --name MY_WEBAPP_NAME \ --resource-group MY_RESOURCE_GROUP \ --settings DOCKER_REGISTRY_SERVER_URL=https://ghcr.io DOCKER_REGISTRY_SERVER_USERNAME=MY_REPOSITORY_OWNER DOCKER_REGISTRY_SERVER_PASSWORD=MY_PERSONAL_ACCESS_TOKEN
-
Optionally, configure a deployment environment. 环境用于描述一般的部署目� �,如
生产
、暂存
或开发
。 当 GitHub Actions 工作流程部署到某个环境时,该环境将显示在存储库的主页上。 您可以使用环境来要求批准才能继续作业,限制哪些分支可以触发工作流程,或限制对机密的访问。 有关创建环境的更多信息,请参阅“使用环境进行部署”。
创建工作流程
完成先决条件后,可以继续创建工作流程。
以下示例工作流演程示在推送到 main
分支时,如何构建 Docker 容器并将其部署到 Azure App Service。
确保在工作流程 env
中将 AZURE_WEBAPP_NAME
密钥设置为您创建的 web 应用程序名称。
如果配置了部署环境,请将 environment
的值更改为环境的名称。 如果未配置环境,则� 除 environment
键。
# 此工作流使用未经 GitHub 认证的操作。
# 它们由第三方提供,并受
# 单独的服务条款、隐私政策和支持
# 文档管理。
name: Build and deploy a container to an Azure Web App
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name
on:
push:
branches:
- main
permissions:
contents: 'read'
packages: 'write'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
- name: Log in to GitHub container registry
uses: docker/login-action@v1.10.0
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Lowercase the repo name
run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
- name: Build and push container image to registry
uses: docker/build-push-action@v2
with:
push: true
tags: ghcr.io/${{ env.REPO }}:${{ github.sha }}
file: ./Dockerfile
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: 'production'
url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}
steps:
- name: Lowercase the repo name
run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
- name: Deploy to Azure Web App
id: deploy-to-webapp
uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
with:
app-name: ${{ env.AZURE_WEBAPP_NAME }}
publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
images: 'ghcr.io/${{ env.REPO }}:${{ github.sha }}'
其他资源
以下资源也可能有用:
- 有关原始入门工作流程,请参阅 GitHub Actions
starter-workflows
仓库中的azure-container-webapp.yml
。 - 用于部署 Web 应用的操作是正式的 Azure
Azure/webapps-deploy
操作。 - 有关部署到 Azure 的 GitHub 操作工作流程的更多示例,请参阅 actions-workflow-samples 存储库。