Skip to main content
Publicamos actualizaciones para la documentación con frecuencia y es posible que aún se esté traduciendo esta página. Para obtener la información más reciente, consulta la documentación en inglés.

Esta versión de GitHub Enterprise se discontinuó el 2023-03-15. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.

Expresiones

Puedes evaluar las expresiones en los flujos de trabajo y acciones.

Nota: Actualmente los ejecutores hospedados en GitHub no se admiten en GitHub Enterprise Server. Puede ver más información sobre la compatibilidad futura planeada en GitHub public roadmap.

Acerca de las expresiones

Puedes utilizar expresiones para configurar variables de ambiente con programación en los 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 valores literales, referencias de contexto y funciones usando operadores. Para obtener más información sobre los contextos, consulta "Contextos".

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 ejecutarse. Cuando un condicional if es true, el paso se ejecutará.

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

${{ <expression> }}

Al usar expresiones en una condicional if, puede omitir la sintaxis de la expresión (${{ }}) porque GitHub evalúa de forma automática la condicional if como una expresión. Para obtener más información sobre ifcondicionales, consulte "Sintaxis del flujo de trabajo para Acciones de GitHub".

Advertencia: Cuando cree flujos de trabajo y acciones, siempre debe considerar si el código podría ejecutar entradas no confiables de atacantes potenciales. Se tratará a algunos contextos como una entrada no confiable, ya que un atacante podrían insertar su propio contenido malintencionado. Para obtener más información, vea «Fortalecimiento de seguridad 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> }}

Literales

Como parte de una expresión, puedes usar los tipos de datos boolean, null, number o string.

Tipo de datosValor literal
booleantrue o false
nullnull
numberCualquier formato de número compatible con JSON.
stringNo es necesario incluir las cadenas en ${{ y }}. Sin embargo, en caso de que lo hagas, debes utilizar comillas simples (') alrededor de la cadena. Para utilizar una comilla simple literal, escápala utilizando una comilla simple adicional (''). El ajuste con comillas dobles (") producirá un error.

Ejemplo de literales

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

Operadores

OperadorDescripción
( )Agrupación lógica
[ ]Índice
.Desreferencia de propiedad
!Not
<Menor que
<=Menor o igual que
>Mayor que
>=Mayor o igual que
==Igual
!=No igual a
&&Y
||Or

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:

    TipoResultado
    Null0
    Booleantrue devuelve 1.
    false devuelve 0.
    StringSe analiza desde cualquier formato de número JSON legal; de lo contrario, NaN.
    Nota: La cadena vacía devuelve 0.
    ArrayNaN
    ObjectNaN
  • Una comparación de un elemento NaN con otro elemento NaN no da como resultado true. Para obtener más información, consulta la "documentación de NaN Mozilla".

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

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

Functions

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:

TipoResultado
Null''
Boolean'true' o 'false'
NumberFormato decimal, exponencial para números grandes
ArrayLas matrices no se convierten en cadenas
ObjectLos objetos no se convierten en cadenas

contains

contains( search, item )

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

Ejemplo usando una cadena

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

Ejemplo de uso de un filtro de objetos

contains(github.event.issue.labels.*.name, 'bug') devuelve true si el problema relacionado con el evento tiene una etiqueta "bug".

Para más información, consulta "Filtros de objetos".

Ejemplo que coincide con una matriz de cadenas

En lugar de escribir github.event_name == "push" || github.event_name == "pull_request", puedes usar contains() con fromJSON() para comprobar si una matriz de cadenas contiene un item.

Por ejemplo, contains(fromJSON('["push", "pull_request"]'), github.event_name) devuelve true si github.event_name es "push" o "pull_request".

startsWith

startsWith( searchString, searchValue )

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

Ejemplo de startsWith

startsWith('Hello world', 'He') devuelve true.

endsWith

endsWith( searchString, searchValue )

Devuelve true si la cadena searchString está situada al final de la cadena searchValue. Esta función no distingue mayúsculas de minúsculas. Fusiona valores en una cadena.

Ejemplo de endsWith

endsWith('Hello world', 'ld') devuelve true.

format

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

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

Ejemplo de format

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

Devuelve 'Hello Mona the Octocat'.

Ejemplo de evasión de llaves

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

Devuelve '{Hello Mona the Octocat!}'.

join

join( array, optionalSeparator )

El valor de array puede ser una matriz o una cadena. Todos los valores de 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 de join

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

toJSON

toJSON(value)

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

Ejemplo de toJSON

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

fromJSON

fromJSON(value)

Devuelve un objeto JSON o un tipo de datos JSON para value. Puedes utilizar esta función para proporcionar un objeto JSON como una expresión evaluada o para convertir variables de ambiente desde una secuencia.

Ejemplo de devolver un objeto JSON

Este flujo de trabajo configura una matriz de JSON en un trabajo, y lo pasa al siguiente trabajo utilizando una salida 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

Ejemplo de devolver un tipo de datos JSON

Este flujo de trabajo usa fromJSON para convertir variables de entorno de una cadena a un valor booleano o entero.

name: print
on: push
env:
  continue: true
  time: 3
jobs:
  job1:
    runs-on: ubuntu-latest
    steps:
      - continue-on-error: ${{ fromJSON(env.continue) }}
        timeout-minutes: ${{ fromJSON(env.time) }}
        run: echo ...

hashFiles

hashFiles(path)

Devuelve un hash único para el conjunto de archivos que coincide con el patrón path. Puede proporcionar un único patrón path o varios patrones path separados por comas. path es relativo al directorio GITHUB_WORKSPACE y solo puede incluir archivos dentro de 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. Si el patrón path no coincide con ningún archivo, devuelve una cadena vacía. Para obtener 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 sobre los caracteres de coincidencia de patrones admitidos, consulte "Sintaxis del flujo de trabajo para Acciones de GitHub".

Ejemplo con un solo patrón

Coincide con cualquier archivo package-lock.json del repositorio.

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

Ejemplo con patrones múltiples

Crea un hash para todos los archivos package-lock.json y Gemfile.lock del repositorio.

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

Funciones de verificación del estado

Puedes usar las siguientes funciones de comprobación de estado como expresiones en condicionales if. Se aplica una comprobación de estado predeterminada de success() a menos que incluyas una de estas funciones. Para más información sobre los condicionales if, consulte "Sintaxis del flujo de trabajo para Acciones de GitHub" y "Sintaxis de metadatos para Acciones de GitHub".

success

Devuelve true cuando ninguno de los pasos anteriores ha producido un error o se ha cancelado.

Ejemplo de success

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

Siempre

Hace que el paso siempre se ejecute y devuelve true, incluso cuando se cancela. La expresión always se usa mejor en el nivel de paso o en las tareas que se espera ejecutar incluso cuando se cancela un trabajo. Por ejemplo, puedes usar always para enviar registros incluso cuando se cancela un trabajo.

Nota: Evita el uso de always para cualquier tarea que pueda sufrir un error crítico, como obtener orígenes; de lo contrario, el flujo de trabajo podría bloquearse hasta que se agote el tiempo de espera. Si quieres ejecutar un trabajo o un paso independientemente de si se ha ejecutado correctamente o no, usa la alternativa recomendada: if: success() || failure().

Ejemplo de always

if: ${{ always() }}

cancelled

Devuelve true si el flujo de trabajo se ha cancelado.

Ejemplo de cancelled

if: ${{ cancelled() }}

failure

Devuelve true cuando se produce un error en cualquier paso anterior de un trabajo. Si tienes una cadena de trabajos dependientes, failure() devuelve true si se produce un error en algún trabajo antecesor.

Ejemplo de failure

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

error con condiciones

Puedes incluir condiciones adicionales para que un paso se ejecute después de un error, pero todavía debes incluir failure() para invalidar la comprobación de estado predeterminada de success() que se aplica automáticamente a las condiciones if que no contienen una función de comprobación de estado.

Ejemplo de failure con condiciones
steps:
  ...
  - name: Failing step
    id: demo
    run: exit 1
  - name: The demo step has failed
    if: ${{ failure() && steps.demo.conclusion == 'failure' }}

Filtros de objetos

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

Por ejemplo, considera una matriz de objetos denominada fruits.

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

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

También puedes usar la sintaxis * en un objeto. Por ejemplo, supongamos que tienes un objeto denominado vegetables.


{
  "scallions":
  {
    "colors": ["green", "white", "red"],
    "ediblePortions": ["roots", "stalks"],
  },
  "beets":
  {
    "colors": ["purple", "red", "gold", "white", "pink"],
    "ediblePortions": ["roots", "stems", "leaves"],
  },
  "artichokes":
  {
    "colors": ["green", "purple", "red", "black"],
    "ediblePortions": ["hearts", "stems", "leaves"],
  },
}

El filtro vegetables.*.ediblePortions podría evaluarse como:


[
  ["roots", "stalks"],
  ["hearts", "stems", "leaves"],
  ["roots", "stems", "leaves"],
]

Dado que los objetos no conservan el orden, no se puede garantizar el orden de la salida.