variables

Acerca de las variables

Puedes utilizar variables para almacenar información que quieras referenciar en tu flujo de trabajo. Referencias variables dentro de un paso de flujo de trabajo o una acción y estas se interpolan en la máquina ejecutora que ejecuta tu flujo de trabajo. Los comandos que se ejecutan en las acciones o flujos de trabajo pueden crear, leer y modificar las variables.

Puedes configurar tus propias variables personalizadas, puedes utilizar las variables predefinidas que configura GitHub automáticamente y también utilizar cualquier otra variable que se configure en el ambiente de trabajo del ejecutor. Las variables distinguen mayúsculas de minúsculas.

Definición de variables de entorno

Para establecer una variable de entorno personalizada, puedes definirla con la clave env del archivo de flujo de trabajo. El alcance de una variable personalizada establecida por este método se limita al elemento en el cual se define. Puedes definir las variables que tienen alcance para:

• Todo el flujo de trabajo, mediante el uso de env en el nivel superior del archivo de flujo de trabajo.
• El contenido de un trabajo dentro de un flujo de trabajo mediante jobs.<job_id>.env.
• Un paso específico dentro de un trabajo mediante jobs.<job_id>.steps[*].env.

name: Greeting on variable day

on:
  workflow_dispatch

env:
  DAY_OF_WEEK: Monday

jobs:
  greeting_job:
    runs-on: ubuntu-latest
    env:
      Greeting: Hello
    steps:
      - name: "Say Hello Mona it's Monday"
        run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
        env:
          First_Name: Mona

Puedes acceder a los valores de variable env mediante variables de entorno de ejecutor o mediante contextos. En el ejemplo anterior, se muestran tres variables personalizadas que se usan como variables de entorno en un comando echo: $DAY_OF_WEEK, $Greeting y $First_Name. A los valores para estas variables se les configura y da el alcance en el flujo de trabajo, job y nivel de paso respectivamente. Para obtener más información sobre el acceso a valores de variable mediante contextos, consulta "Uso de contextos para acceder a valores de variable".

Debido a que la interpolación de las variables de ambiente del ejecutor se realiza después de que un trabajo del flujo de trabajo se envíe a una máquina ejecutora, debes utilizar la sintaxis adecuada para el shell que se utiliza en el ejecutor. En este ejemplo, el flujo de trabajo especifica ubuntu-latest. De manera predeterminada, los ejecutores de Linux utilizan el shell bash, así que debe utilizar la sintaxis $NAME. Si el flujo de trabajo especificó un ejecutor Windows, tendrá que usar la sintaxis para PowerShell, $env:NAME. Para obtener más información sobre los shells, consulte "Sintaxis de flujo de trabajo para GitHub Actions".

Convenciones de nomenclatura para las variables de entorno

Cuando configuras una variable de entorno, no puedes utilizar ninguno de los nombres de variable de entorno predeterminados. Para obtener una lista completa de variables de entorno predeterminadas, consulta la sección "Variables de entorno predeterminadas" a continuación. Si intentas anular el valor de estas variables predeterminadas, se ignorará la tarea.

Toda variable nueva que configures y que apunte a una ubicación en el sistema de archivos debe tener un sufijo _PATH. Las variables predeterminadas GITHUB_ENV y GITHUB_WORKSPACE son excepciones a esta convención.

Uso de contextos para acceder a los valores de las variables

Los contextos son una manera de acceder a información acerca de las ejecuciones de flujo de trabajo, variable, entornos del ejecutor, trabajos y pasos. Para obtener más información, consulta "Contextos". Hay muchos otros contextos que puedes utilizar para propósitos diversos en tus flujos de trabajo. Para obtener más información sobre dónde puede usar varios contextos dentro de un flujo de trabajo, consulte "Disponibilidad del contexto".

Puedes acceder a los valores de variables de entorno mediante el env contexto.

Uso del contexto env para acceder a los valores de las variables de entorno

Adicionalmente a las variables de entorno del ejecutor, GitHub Actions también te permite configurar y leer los valores clave env utilizando contextos. Se pretende utilizar las variables de ambiente y contextos en puntos diferentes del flujo de trabajo.

Las variables de entorno del ejecutor siempre se interpolan en la máquina del ejecutor. Sin embargo, las GitHub Actions procesan algunas partes de los flujos de trabajo y no se envían al ejecutor. No puedes utilizar variables de ambiente en estas partes de un archivo de flujo de trabajo. En su lugar, puedes utilizar contextos. Por ejemplo, GitHub Actions siempre procesará un condicional if, el cual determina si un trabajo o paso se envía al ejecutor o no. Puedes utilizar un contexto en una declaración condicional if para acceder al valor de una variable.

env:
  DAY_OF_WEEK: Monday

jobs:
  greeting_job:
    runs-on: ubuntu-latest
    env:
      Greeting: Hello
    steps:
      - name: "Say Hello Mona it's Monday"
        if: ${{ env.DAY_OF_WEEK == 'Monday' }}
        run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
        env:
          First_Name: Mona

En esta modificación del primer ejemplo, hemos introducido un valor if condicional. Ahora, el paso del flujo de trabajo solo se ejecuta si DAYS_OF_WEEK está establecido en "Monday". Accedemos a este valor desde la instrucción condicional if mediante el contexto env.

Habitualmente, utilizarás el contexto env o github para acceder a los valores de variables en partes del flujo de trabajo que se procesan antes de que los trabajos se envíen a los ejecutores.

Context	Caso de uso	Ejemplo
env	Referencia las variables personalizadas que se definen en el flujo de trabajo.	${{ env.MY_VARIABLE }}
github	Referenciar información sobre la ejecución de flujo de trabajo y el evento que activó dicha ejecución.	${{ github.repository }}

Variables de entorno predeterminadas

Las variables de ambiente predeterminadas que configura GitHub están disponibles para cada paso en un flujo de trabajo.

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

Variable	Descripción
CI	Siempre se establece en true.
GITHUB_ACTION	Nombre de la acción actualmente en ejecución, o bien el valor id de un paso. Por ejemplo, para una acción, __repo-owner_name-of-action-repo. GitHub quita caracteres especiales y usa el nombre __run cuando el paso actual ejecuta un script sin id. Si utilizas el mismo script o acción más de una vez en el mismo job, el nombre incluirá un sufijo que consiste del número de secuencia precedido por un guión bajo. Por ejemplo, el primer script que ejecute tendrá el nombre __run y el segundo el nombre __run_2. Del mismo modo, la segunda invocación de actions/checkout será actionscheckout2.
GITHUB_ACTION_PATH	La ruta donde se ubica una acción. Esta propiedad solo es compatible en las acciones compuestas. Puedes utilizar esta ruta para acceder a los archivos que se ubican en el mismo repositorio que la acción. Por ejemplo: /home/runner/work/_actions/repo-owner/name-of-action-repo/v1.
GITHUB_ACTION_REPOSITORY	En el caso de un paso que ejecuta una acción, este es el propietario y el nombre de repositorio de la acción. Por ejemplo: actions/checkout.
GITHUB_ACTIONS	Defínalo siempre en true cuando GitHub Actions esté ejecutando el flujo de trabajo. Puedes usar esta variable para diferenciar cuando las pruebas se ejecutan de forma local o mediante GitHub Actions.
GITHUB_ACTOR	El nombre de la persona o de la aplicación que inició el flujo de trabajo. Por ejemplo: octocat.
GITHUB_BASE_REF	El nombre de la ref base o rama de destino de la solicitud de incorporación de cambios en una ejecución de flujo de trabajo. Esto solo se establece cuando el evento que desencadena una ejecución de flujo de trabajo es pull_request o pull_request_target. Por ejemplo: main.
GITHUB_HEAD_REF	La ref de encabezado de la rama de origen de la solicitud de incorporación de cambios en una ejecución de flujo de trabajo. Esta propiedad solo se establece cuando el evento que desencadena una ejecución de flujo de trabajo es pull_request o pull_request_target. Por ejemplo: feature-branch-1.
GITHUB_SHA	El SHA de confirmación que activó el flujo de trabajo. El valor de este SHA de confirmación depende del evento que activó el flujo de trabajo. Para más información, vea "Eventos que desencadenan flujos de trabajo". Por ejemplo, ffac537e6cbbf934b08745a378932722df287a53.

Detectar el sistema operativo

Puede generar un único archivo de flujo de trabajo que se pueda usar para distintos sistemas operativos mediante la variable de entorno predeterminada RUNNER_OS y la propiedad de contexto correspondiente ${{ runner.os }}. Por ejemplo, el siguiente flujo de trabajo puede ejecutarse correctamente si ha cambiado el sistema operativo de macos-latest a windows-latest sin tener que alterar la sintaxis de las variables de entorno, lo cual difiere dependiendo del shell que esté utilizando el ejecutor.

jobs:
  if-Windows-else:
    runs-on: macos-latest
    steps:
      - name: condition 1
        if: runner.os == 'Windows'
        run: echo "The operating system on the runner is $env:RUNNER_OS."
      - name: condition 2
        if: runner.os != 'Windows'
        run: echo "The operating system on the runner is not Windows, it's $RUNNER_OS."

En este ejemplo, las dos instrucciones if comprueban la propiedad os del contexto runner para determinar el sistema operativo del ejecutor. GitHub Actions procesa los condicionales if y solo los pasos en donde la comprobación se resuelve de manera que se envían los true al ejecutor. Una de las comprobaciones siempre será true y la otra false, por lo que solo se envía uno de estos pasos al ejecutor. Una vez enviado el trabajo al ejecutor, el paso se ejecuta y la variable de entorno del comando echo se interpola mediante la sintaxis adecuada ($env:NAME para PowerShell en Windows y $NAME para bash y sh en Linux y MacOS). En este ejemplo, la instrucción runs-on: macos-latest significa que se ejecutará el segundo paso.

Pasar valores entre pasos y jobs en un flujo de trabajo

Si genera un valor en un paso de un trabajo, puede utilizar dicho valor en los pasos siguientes del mismo trabajo. Para ello, asigne el valor a una variable de entorno nueva o existente y escriba lo siguiente en el archivo de entorno GITHUB_ENV. Una acción puede utilizar directamente el archivo de entorno, o puede utilizarse desde un comando de shell en el archivo de flujo de trabajo con la palabra clave run. Para más información, vea "Comandos de flujo de trabajo para GitHub Actions".

Si quieres pasar un valor desde un paso en un job que está en un flujo de trabajo a un paso en otro job del mismo flujo de trabajo, puedes definir el valor como una salida de job. Puedes entonces referenciar esta salida de job desde un paso en otro job. Para obtener más información, consulte "Sintaxis de flujo de trabajo para GitHub Actions".