Sintaxis de contexto y de expresiones para acciones de GitHub

Acerca de los contextos y las expresiones

Puedes usar expresiones para establecer variables programáticamente en archivos de flujo de trabajo y contextos de acceso. Una expresión puede ser cualquier combinación de valores literales, referencias a un contexto, o funciones. Puedes combinar literales, referencias de contexto y funciones usando operadores.

Las expresiones se utilizan comúnmente con la palabra clave condicional if en un archivo de flujo de trabajo para determinar si un paso debe ejecutar. Cuando un condicional if es true, se ejecutará el paso.

Debes usar una sintaxis específica para decirle a GitHub que evalúe una expresión en lugar de tratarla como una cadena.

${{ <expression> }}

Podrías omitir la sintaxis de expresión cuando utilizas expresiones en un condicional if (${{ }}) ya que GitHub evalúa automáticamente el condicional if como una expresión. Para obtener más información acerca de los condicionales if, consulta la sección "sintaxis de flujo de trabajo para GitHub Actions".

Expresión de ejemplo en un condicional if

steps:
  - uses: actions/hello-world-javascript-action@v1.1
    if: ${{ <expression> }}

Ejemplo de parámetros en una variable de entorno

env:
  my_env_var: ${{ <expression> }}

Contextos

Los contextos son una manera de acceder a información acerca de las ejecuciones de flujo de trabajo, los entornos del ejecutor, los trabajos y los pasos. Los contextos usan la sintaxis de expresión.

${{ <context> }}

Como parte de una expresión, puedes acceder a la información del contexto usando una de dos sintaxis.

• Sintaxis de índice: github['sha']
• Sintaxis de desreferencia de propiedad: github.sha

Para usar la sintaxis de desreferencia de propiedad, el nombre de la propiedad debe cumplir con lo siguiente:

• comenzar con a-Z o _.
• estar seguida por a-Z 0-9 - o _.

contexto github

El contexto de github contiene información sobre la ejecución del flujo de trabajo y el evento que desencadenó la ejecución. Puedes leer la mayoría de los datos de contexto de github en las variables del entorno. Para más información sobre las variables de entorno, consulta "Utilizando variables de entorno."

contexto de env

El contexto de Env contiene las variables de entorno que se han establecido en un flujo de trabajo, puesto o paso. Para obtener más información acerca de la configuración de variables de entorno en tu flujo de trabajo, consulta "Sintaxis de flujo de trabajo para GitHub Actions".

La sintaxis de contexto env te permite usar el valor de una variable de entorno en tu archivo de flujo de trabajo. Si quieres usar el valor de una variable de entorno dentro de un ejecutor, usa el método normal del sistema operativo del ejecutor para leer las variables de entorno.

Solo puedes usar el contexto de env en el valor de las llaves with y name, o en un condicional if del paso. Para obtener más información sobre la sintaxis del paso, consulta "Sintaxis de flujo de trabajo para GitHub Actions".

contexto de job

El contexto trabajo contiene información sobre el trabajo de ejecución actual.

contexto de steps

El contexto steps contiene información sobre los pasos en el trabajo actual que ya se ha ejecutado.

Contexto de runner

El contexto de runner contiene información sobre el ejecutor que está ejecutando el trabajo actual.

Contexto needs

El contexto needs contiene salidas de todos los jobs que se definen como dependencia del job actual. Para obtener más información sobre la definición de dependencias de jobs, consulta la sección "Sintaxis de flujos de trabajo para GitHub Actions".

Ejemplo de impresión de información de contexto de un archivo de registro

Para inspeccionar la información accesible en cada contexto, puedes utilizar este ejemplo de archivo de flujo de trabajo.

.github/workflows/main.yml

on: push

jobs:
  one:
    runs-on: ubuntu-16.04
    steps:
      - name: Dump GitHub context
        env:
          GITHUB_CONTEXT: ${{ toJson(github) }}
        run: echo "$GITHUB_CONTEXT"
      - name: Dump job context
        env:
          JOB_CONTEXT: ${{ toJson(job) }}
        run: echo "$JOB_CONTEXT"
      - name: Dump steps context
        env:
          STEPS_CONTEXT: ${{ toJson(steps) }}
        run: echo "$STEPS_CONTEXT"
      - name: Dump runner context
        env:
          RUNNER_CONTEXT: ${{ toJson(runner) }}
        run: echo "$RUNNER_CONTEXT"
      - name: Dump strategy context
        env:
          STRATEGY_CONTEXT: ${{ toJson(strategy) }}
        run: echo "$STRATEGY_CONTEXT"
      - name: Dump matrix context
        env:
          MATRIX_CONTEXT: ${{ toJson(matrix) }}
        run: echo "$MATRIX_CONTEXT"

Literales

Como parte de una expresión, puedes usar tipos de datos boolean, null, number o string. Los literales booleanos no distinguen minúsculas de mayúsculas, por lo que puedes usar true o True.

Ejemplo

env:
  myNull: ${{ null }}
  myBoolean: ${{ false }}
  myIntegerNumber: ${{ 711 }}
  myFloatNumber: ${{ -9.2 }}
  myHexNumber: ${{ 0xff }}
  myExponentialNumber: ${{ -2.99-e2 }}
  myString: ${{ 'Mona the Octocat' }}
  myEscapedString: ${{ 'It''s open source!' } }}

Operadores

GitHub realiza comparaciones de igualdad flexible.

• Si los tipos no coinciden, GitHub fuerza el tipo a un número. GitHub fusiona los tipos de datos con un número usando estas conversiones:

  Tipo	Resultado
  Null	0
  Boolean	true devuelve 1 falso devuelve 0
  Cadena	Analizado desde cualquier formato de número JSON legal, de lo contrario NaN. Nota: la cadena vacía devuelve 0.
  Array	NaN
  Object	NaN

• Una comparación de un NaN con otro NaN no genera true. Para obtener más información, consulta "Documentos de Mozilla NaN".

• GitHub ignora las mayúsculas y minúsculas al comparar cadenas.

• Los objetos y matrices solo se consideran iguales cuando son la misma instancia.

Funciones

GitHub ofrece un conjunto de funciones integradas que puedes usar en expresiones. Algunas funciones fusionan valores en una cadena para realizar las comparaciones. GitHub fusiona los tipos de datos con una cadena usando estas conversiones:

Contiene

contiene (buscar, elemento)

Arroja true si search contiene item. Si search es una matriz, esta función arroja true si el item es un elemento de la matriz. Si search es una cadena, esta función arroja true si el item es una subcadena de search. Esta función no distingue mayúsculas de minúsculas. Fusiona valores en una cadena.

Ejemplo usando una matriz

contains(github.event.issue.labels.*.name, 'bug')

Ejemplo usando una cadena

contains('Hello world', 'llo') devuelve true

startsWith

startsWith( searchString, searchValue )

Devuelve true cuando searchString contiene searchValue. Esta función no distingue mayúsculas de minúsculas. Fusiona valores en una cadena.

Ejemplo

startsWith('Hello world', 'He') regresa a true

endsWith

endsWith( searchString, searchValue )

Devuelve true si searchString contiene searchValue. Esta función no distingue mayúsculas de minúsculas. Fusiona valores en una cadena.

Ejemplo

endsWith('Hello world', 'He') devuelve true

format

format( string, replaceValue0, replaceValue1, ..., replaceValueN)

Reemplaza valores en la cadena, con la variable replaceValueN. Las variables en la cadena se especifican con la sintaxis {N}, donde N es un entero. Debes especificar al menos un replaceValue y una cadena. No existe un máximo para el número de variables (replaceValueN) que puedes usar. Escapar llaves usando llaves dobles.

Ejemplo

Devuelve 'Hello Mona the Octocat'

format('Hello {0} {1} {2}', 'Mona', 'the', 'Octocat')

Ejemplo de evasión de llaves

Devuelve '{Hello Mona the Octocat!}'

format('{{Hello {0} {1} {2}!}}', 'Mona', 'the', 'Octocat')

join

join( array, optionalSeparator )

El valor para array puede ser una matriz o una cadena. Todos los valores en array se concatenan en una cadena. Si proporcionas optionalSeparator, se inserta entre los valores concatenados. De lo contrario, se usa el separador predeterminado ,. Fusiona valores en una cadena.

Ejemplo

join(github.event.issue.labels.*.name, ', ') puede devolver 'bug, help wanted'

toJson

toJSON(value)

Devuelve una representación JSON con formato mejorado de valor. Puedes usar esta función para depurar la información suministrada en contextos.

Ejemplo

toJSON(job) puede devolver { "status": "Success" }

fromJson

fromJSON(value)

Devuelve un objeto de JSON para value. Puedes utilizar esta función para proporcionar un objeto de JSON como una expresión evaluada.

Ejemplo

Este flujo de trabajo configura una matriz de JSON en un job, y lo pasa al siguiente job utilizando un resultado y fromJSON.

name: build
on: push
jobs:
  job1:
    runs-on: ubuntu-latest
    outputs:
      matrix: ${{ steps.set-matrix.outputs.matrix }}
    steps:
    - id: set-matrix
      run: echo "::set-output name=matrix::{\"include\":[{\"project\":\"foo\",\"config\":\"Debug\"},{\"project\":\"bar\",\"config\":\"Release\"}]}"
  job2:
    needs: job1
    runs-on: ubuntu-latest
    strategy:
      matrix: ${{fromJson(needs.job1.outputs.matrix)}}
    steps:
    - run: build

hashFiles

hashFiles(path)

Arroja un solo hash para el conjunto de archivos que coincide con el patrón de path. Puedes proporcionar un patrón de path o path múltiples se parados por comas. El path está relacionado con el directorio GITHUB_WORKSPACE y solo puede incluir archivos dentro del directorio GITHUB_WORKSPACE. Esta función calcula un hash SHA-256 individual para cada archivo coincidente, y luego usa esos hashes para calcular un hash SHA-256 final para el conjunto de archivos. Para más información sobre SHA-256, consulta "SHA-2".

Puedes usar caracteres de coincidencia de patrones para encontrar nombres de archivos. La coincidencia de patrones no distingue mayúsculas de minúsculas en Windows. Para obtener más información acerca de los caracteres compatibles con los patrones, consulta "Sintaxis de flujo de trabajo para GitHub Actions".

Ejemplo con un solo patrón

Encuentra cualquier archivo package-lock.json en el repositorio.

hashFiles('**/package-lock.json')

Ejemplo con patrones múltiples

Crea un hash para cualquier archivo de package-lock.json y de Gemfile.lock en el repositorio.

hashFiles('**/package-lock.json', '**/Gemfile.lock')

Funciones de verificación de estado del trabajo

Puedes usar las siguientes funciones de verificación de estado como expresiones en condicionales if (si). Si la expresión if no contiene ninguna de las funciones de estado, se obtendrá automáticamente con success(). Para obtener información sobre los condicionales if, consulta "Sintaxis de flujo de trabajo para acciones de GitHub".

success

Arroja true cuando no falló ni se canceló ninguno de los pasos anteriores.

Ejemplo

Pasos:
  ...
  - name: The job has succeeded
    if: ${{ success() }}

always

Siempre arroja true, incluso cuando se cancela. No se ejecutará un trabajo o paso cuando una falla crítica impida que la tarea se ejecute. Por ejemplo, si fallaron las fuentes.

Ejemplo

if: ${{ always() }}

cancelled

Devuelve true si se canceló el flujo de trabajo.

Ejemplo

if: ${{ cancelled() }}

failure

Arroja true cuando falla cualquiera de los pasos anteriores de un trabajo.

Ejemplo

Pasos:
  ...
  - name: The job has failed
    if: ${{ failure() }}

Filtros de objetos

Puedes usar la sintaxis * para aplicar un filtro y seleccionar los elementos coincidentes en una recopilación.

Por ejemplo, considera una matriz de objetos llamada fruits.

[
  { "name": "apple", "quantity": 1 },
  { "name": "orange", "quantity": 2 },
  { "name": "pear", "quantity": 1 }
]

El filtro fruits.*.name devuelve la matriz [ "apple", "orange", "pear" ]