Variables del entorno

Acerca de las variables de entorno

GitHub establece las variables de entorno predeterminadas que están disponibles para cada paso en una ejecución de flujo de trabajo. Las variables de entorno distinguen mayúsculas de minúsculas. Los comandos que se ejecutan en acciones o pasos pueden crear, leer y modificar variables de entorno.

Para establecer variables de entorno personalizadas, debes especificar las variables en el archivo de flujo de trabajo. Puedes definir variables de ambiente para un paso, job o para todo el flujo de trabajo si utilizas las palabras clave jobs.<job_id>.steps[*].env, jobs.<job_id>.env, y env. Para obtener más información, consulta "Sintaxis del flujo de trabajo para GitHub".

jobs:
  weekday_job:
    runs-on: ubuntu-latest
    env:
      DAY_OF_WEEK: Mon
    steps:
      - name: "Hello world when it's Monday"
        if: ${{ env.DAY_OF_WEEK == 'Mon' }}
        run: echo "Hello $FIRST_NAME $middle_name $Last_Name, today is Monday!"
        env:
          FIRST_NAME: Mona
          middle_name: The
          Last_Name: Octocat

Para utilizar el valor de una variable de ambiente en un archivo de flujo de trabajo, deberías utilizar el contexto env. Si quieres utilizar el valor de una variable de ambiente dentro de un ejecutor, puedes utilizar el método normal del sistema operativo ejecutor para leer las variables de ambiente.

Si utilizas la clave run de los archivos del flujo de trabajo para leer las variables de ambiente desde dentro del sistema operativo ejecutor (como se muestra en el ejemplo anterior), dicha variable se sustituirá en el sistema operativo ejecutor después de que se envíe el job al ejecutor. En el caso de otras partes de un archivo de flujo de trabajo, debes utilizar el contexto env para leer las variables de ambiente; esto es porque las claves de flujo de trabajo (tales como if) requieren que se sustituya la variable durante el procesamiento de dicho flujo de trabajo antes de que se envíe al ejecutor.

También puedes utilizar el archivo de ambiente el comando de flujo de trabajo set-env para establecer una variable de ambiente que puedan utilizar los siguientes pasos en un job. Una acción puede utilizar directamente el comando de set-env o como un comando de shell en un archivo de flujo de trabajo utilizando la palabra clave run. Para obtener más información, consulta "Comandos de flujo de trabajo para las GitHub Actions."

Variables de entorno predeterminadas

Te recomendamos encarecidamente que las acciones usen variables de entorno para acceder al sistema de archivos en lugar de usar rutas de archivo codificadas de forma rígida. GitHub establece variables de entorno para que las acciones se utilicen en todos los entornos del ejecutador.

Determinar cuándo utilizar las variables de ambiente o contextos predeterminados

GitHub Actions incluye una colección de variables que se llama contextos y una recopilación de variables similar que se llaman variables de ambiente predeterminadas. Estas variables se pretenden utilizar en puntos diferentes del flujo de trabajo:

• Variables de ambiente predeterminadas: Estas variables existen únicamente en el ejecutor que está ejecutando tu job. Para obtener más información, consulta la sección "Variables de ambiente predeterminadas."
• Contextos: Puedes utilizar la mayoría de los contextos en cualquier punto de tu flujo de trabajo, incluyendo cuando no estén disponibles las variables de ambiente predeterminadas. Por ejemplo, puedes utilizar contextos con expresiones para llevar a cabo un procesamiento inicial antes de que el job se enrute a un ejecutor para su exclusión; esto te permite utilizar un contexto con la palabra clave condicional if para determinar si se debería ejecutar un paso. Una vez que el job se esté ejecutando, también debes recuperar las variables de contexto para el ejecutor que está ejecutando el trabajo, tal como runner.os. Para encontrar más detalles de dónde puedes utilizar contextos diversos dentro de un flujo de trabajo, consulta "Disponibilidad de contexto".

El siguiente ejemplo ilustra cómo estos tipos de variables de ambiente diferentes pueden utilizarse juntas en el job:

name: CI
on: push
jobs:
  prod-check:
    if: ${{ github.ref == 'refs/heads/main' }}
    runs-on: ubuntu-latest
    steps:
      - run: echo "Deploying to production server on branch $GITHUB_REF"

En este ejemplo, el contexto de la declaración if verifica el contexto de github.ref para determinar el nombre de rama actual; si el nombre es refs/heads/main, entonces los siguientes pasos subsecuentes se ejecutarán. El if verifica que se encuentre procesado por GitHub Actions, y que el job solo se envíe al ejecutor si el resultado es Verdadero. Una vez que se envía el job al ejecutor, se ejecuta el paso y se refiere al ambiente de variables $GITHUB_REF para el ejecutor.

Convenciones de nomenclatura para las variables de entorno

Cuando configuras una variable de ambiente personalizada, no puedes utilizar ninguno de los nombres de variable de ambiente predeterminados que se listan anteriormente con el prefijo GITHUB_. Si intentas anular el valor de estas variables de ambiente predeterminadas, se ignorará la tarea.

Toda variable de entorno nueva que configures y que apunte a una ubicación en el sistema de archivos debe tener un sufijo _PATH. Las variables predeterminadas HOME y GITHUB_WORKSPACE son excepciones a esta convención, porque las palabras "inicio" (home) y "espacio de trabajo" (workspace) ya implican una ubicación.