Deploying Node.js to Azure App Service

Introducción

This guide explains how to use GitHub Actions to build, test, and deploy a Node.js project to 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.

   For example, you can use the Azure CLI to create an Azure App Service web app with a Node.js runtime:

   Shell

   az webapp create \
       --name MY_WEBAPP_NAME \
       --plan MY_APP_SERVICE_PLAN \
       --resource-group MY_RESOURCE_GROUP \
       --runtime "NODE|14-lts"

   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".

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 crear, probar y desplegar el proyecto de Node.js a Azure App Service cuando haya 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. If the path to your project is not the repository root, change AZURE_WEBAPP_PACKAGE_PATH to your project path. If you use a version of Node.js other than 10.x, change NODE_VERSION to the version that you use.

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.

on:
  push:
    branches:
      - main

env:
  AZURE_WEBAPP_NAME: MY_WEBAPP_NAME   # set this to your application's name
  AZURE_WEBAPP_PACKAGE_PATH: '.'      # set this to the path to your web app project, defaults to the repository root
  NODE_VERSION: '14.x'                # set this to the node version to use

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Set up Node.js
      uses: actions/setup-node@v2
      with:
        node-version: ${{ env.NODE_VERSION }}
        cache: 'npm'

    - name: npm install, build, and test
      run: |
        npm install
        npm run build --if-present
        npm run test --if-present
    - name: Upload artifact for deployment job
      uses: actions/upload-artifact@v2
      with:
        name: node-app
        path: .

  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: node-app

    - name: 'Deploy to Azure WebApp'
      id: deploy-to-webapp 
      uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
      with:
        app-name: ${{ env.AZURE_WEBAPP_NAME }}
        publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
        package: ${{ env.AZURE_WEBAPP_PACKAGE_PATH }}

Recursos adicionales

Los siguientes recursos también pueden ser útiles:

• Para encontrar el flujo de trabajo inicial original, consulta el archivo azure-webapps-node.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.
• La guía rápida de "Crear una app web de Node.js en Azure" dentro de la documentación de la app web de Azure demuestra cómo utilizar VS Code con la Extensión de Azure App Service.