将 Python 部署到 Azure 应用服务

您可以将 Python 项目部署到 Azure 应用服务，作为持续部署 (CD) 工作流的一部分。

本文档内容

简介

本指南介绍如何使用 GitHub Actions 构建和部署 Python 项目到 Azure 应用服务。

注意：如果您的 GitHub Actions 工作流需要访问支持 OpenID Connect (OIDC) 的云提供商的资源，您可以配置您的工作流以直接身份验证到云提供商。这将使您不再需要将这些凭据存储为长期存在的密钥，并提供其他安全优势。有关更多信息，请参阅 "关于使用 OpenID Connect 加固安全" 和 "在 Azure 中配置 OpenID Connect"。

先决条件

在创建 GitHub Actions 工作流之前，您需要先完成以下设置步骤

  1. 创建 Azure 应用服务计划。

    例如，您可以使用 Azure CLI 创建新的 App Service 计划

    Bash
    az appservice plan create \
   --resource-group MY_RESOURCE_GROUP \
   --name MY_APP_SERVICE_PLAN \
   --is-linux

    在上面的命令中，将 MY_RESOURCE_GROUP 替换为您的现有 Azure 资源组，将 MY_APP_SERVICE_PLAN 替换为 App Service 计划的新名称。

    有关使用 Azure CLI 的更多信息，请参阅 Azure 文档。

  2. 创建 Web 应用。

    例如，您可以使用 Azure CLI 创建具有 Python 运行时的 Azure App Service Web 应用

    Bash
    az webapp create \
    --name MY_WEBAPP_NAME \
    --plan MY_APP_SERVICE_PLAN \
    --resource-group MY_RESOURCE_GROUP \
    --runtime "python|3.8"

    在上面的命令中，将参数替换为自己的值，其中 MY_WEBAPP_NAME 是 Web 应用的新名称。

  3. 配置 Azure 发布配置文件并创建 AZURE_WEBAPP_PUBLISH_PROFILE 密钥。

    使用发布配置文件生成 Azure 部署凭据。有关更多信息，请参阅 Azure 文档中的“生成部署凭据”。

    在您的 GitHub 存储库中，创建一个名为 AZURE_WEBAPP_PUBLISH_PROFILE 的密钥，其中包含发布配置文件的内容。有关创建密钥的更多信息，请参阅“在 GitHub Actions 中使用密钥”。

  4. 添加一个名为 SCM_DO_BUILD_DURING_DEPLOYMENT 的应用设置，并将值设置为 1。

  5. 可选地，配置部署环境。环境用于描述一般的部署目标，例如 production、staging 或 development。当 GitHub Actions 工作流部署到环境时，环境将显示在存储库的主页上。您可以使用环境来要求批准工作才能继续，限制哪些分支可以触发工作流，使用自定义部署保护规则来控制部署，或限制对密钥的访问。有关创建环境的更多信息，请参阅“使用环境进行部署”。

创建工作流

完成先决条件后，您可以继续创建工作流。

以下示例工作流演示了如何在将代码推送到 main 分支时将 Python 项目构建并部署到 Azure App Service。

确保在工作流 env 密钥中将 AZURE_WEBAPP_NAME 设置为创建的 Web 应用的名称。如果您使用的是 Python 3.8 以外的版本，请将 PYTHON_VERSION 更改为使用的版本。

如果您配置了部署环境，请将environment的值更改为您的环境名称。如果您没有配置环境，或者您的工作流位于私有仓库中并且您没有使用 GitHub Enterprise Cloud，请删除environment键。

YAML
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

# GitHub recommends pinning actions to a commit SHA.
# To get a newer version, you will need to update the SHA.
# You can also reference a tag or branch, but the action may change without warning.

name: Build and deploy Python app to Azure Web App

env:
  AZURE_WEBAPP_NAME: MY_WEBAPP_NAME   # set this to your application's name
  PYTHON_VERSION: '3.8'               # set this to the Python version to use

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Set up Python version
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Create and start virtual environment
        run: |
          python -m venv venv
          source venv/bin/activate

      - name: Set up dependency caching for faster installs
        uses: actions/cache@v3
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
          restore-keys: |
            ${{ runner.os }}-pip-

      - name: Install dependencies
        run: pip install -r requirements.txt

      # Optional: Add a step to run tests here (PyTest, Django test suites, etc.)

      - name: Upload artifact for deployment jobs
        uses: actions/upload-artifact@v4
        with:
          name: python-app
          path: |
            .
            !venv/
  deploy:
    runs-on: ubuntu-latest
    needs: build
    environment:
      name: 'production'
      url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}

    steps:
      - name: Download artifact from build job
        uses: actions/download-artifact@v4
        with:
          name: python-app
          path: .

      - name: 'Deploy to Azure Web App'
        id: deploy-to-webapp
        uses: azure/webapps-deploy@85270a1854658d167ab239bce43949edb336fa7c
        with:
          app-name: ${{ env.AZURE_WEBAPP_NAME }}
          publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}

其他资源

以下资源可能也有用