Desplegar Python a Azure App Service

Introducción

Esta guía te explica cómo utilizar las GitHub Actions para compilar y desplegar un proyecto de Python hacia Azure App Service.

Prerrequisitos

Antes de crear tu flujo de trabajo de GitHub Actions, primero necesitarás completar los siguientes pasos de configuración:

1. Crear un plan de Azure App Service.

   Por ejemplo, puedes utilizar el CLI de Azure para crear un plan de App Service nuevo:

   Shell

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

   En el comando anterior, reemplaza MY_RESOURCE_GROUP con tu Grupo de Recursos de Azure preexistente y MY_APP_SERVICE_PLAN con un nombre nuevo para el plan de App Service.

   Consulta la documentación de Azure para obtener más información sobre cómo utilizar el CLI de Azure:

   • Para la autenticación, consulta "Iniciar sesión con Azure CLI."
   • Si necesitas crear un grupo de recursos nuevo, consulta lasección "grupo az".

2. Crea una app web.

   Por ejemplo, puedes utilizar el CLI de Azure para crear una app web de Azure App Service con el tiempo de ejecución de Python:

   Shell

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

   En este comando, reemplaza los parámetros con tus propios valores, en donde MY_WEBAPP_NAME es un nombre nuevo para la app web.

3. Configura un perfil de publicación de Azure y crea un secreto de AZURE_WEBAPP_PUBLISH_PROFILE.

   Genera tus credenciales de despliegue de Azure utilizando un perfil de publicación. Para obtener más información, consulta la sección "Generar credenciales de despliegue" en la documentación de Azure.

   En tu repositorio de GitHub, crea un secreto que se llame AZURE_WEBAPP_PUBLISH_PROFILE que tenga el contenido del perfil de publicación. Para obtener más información sobre cómo crear secretos, consulta la sección "Secretos cifrados".

4. Agrega un ajuste de la app llamado SCM_DO_BUILD_DURING_DEPLOYMENT y configura su valor en 1.

5. Optionally, configure a deployment environment. Los ambientes se utilizan para describir un objetivo de despliegue general como production, staging o development. Cuando se despliega un flujo de trabajo de GitHub Actions en un ambiente, dicho ambiente se desplegará en la página principal del repositorio. Puedes utilizar ambientes para que requieran la aprobación para que un job proceda, restringir qué ramas pueden activar un flujo de trabajo o limitar el acceso a los secretos. Para obtener más información sobre cómo crear ambientes, consulta la sección "Utilizar ambientes para despliegue".

Crear un flujo de trabajo

Una vez que hayas completado los prerequisitos, puedes proceder con la creación del flujo de trabajo.

El siguiente flujo de trabajo de ejemplo demuestra cómo compilar y desplegar un proyecto de Python a Azure App Service cuando existe una subida a la rama main.

Asegúrate de configurar a AZURE_WEBAPP_NAME en la clave env del flujo de trabajo con el nombre de la app web que creaste. Si utilizas una versión de Python diferente a la 3.8, cambia la PYTHON_VERSION a la versión que utilices.

Si configuras un ambiente de despliegue, cambia el valor de environment para que sea el nombre de tu ambiente. Si no configuraste un ambiente, borra la clave environment.

# This workflow uses actions that are not certified by GitHub.
# Estas las proporcionan entidades terceras y las gobiernan
# condiciones de servicio, políticas de privacidad y documentación de soporte
# documentación.

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@v2

      - name: Set up Python version
        uses: actions/setup-python@v2
        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@v2
        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@v2
        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@v2
        with:
          name: python-app
          path: .

      - 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 }}

Recursos adicionales

Los siguientes recursos también pueden ser útiles:

• Para encontrar el flujo de trabajo inicial original, consulta el archivo azure-webapps-python.yml en el repositorio starter-workflows de GitHub Actions.
• La acción que se utilizó para desplegar la app web es la acción oficial Azure/webapps-deploy de Azure.
• Para encontrar más ejemplos de flujos de trabajo de GitHub Actions que desplieguen a Azure, consulta el repositorio actions-workflow-samples.