Comandos de flujo de trabajo para Acciones de GitHub

Acerca de los comandos de flujo

Las acciones pueden comunicarse con la máquina del ejecutor para establecer variables de entorno, valores de salida utilizados por otras acciones, agregar mensajes de depuración a los registros de salida y otras tareas.

La mayoría de los comandos de los flujos de trabajo utilizan el comando echo en un formato específico, mientras que otras se invocan si escribes a un archivo. Para obtener más información, consulta la sección "Archivos de ambiente".

echo ":: Workflow-Command Parameter1 ={data}, parameter2 ={data}::{command value}"

Utilizar comandos de flujo de trabajo para acceder a las funciones de toolkit

El actions/toolkit incluye varias funciones que se pueden ejecutar como comandos de flujo de trabajo. Utiliza la sintaxis :: para ejecutar los comandos de flujo de trabajo dentro de tu archivo YAML; estos comandos se envían entonces a través de stdout. Por ejemplo, en vez de utilizar código para configurar una salida, como se muestra aquí:

core.setOutput('SELECTED_COLOR', 'green');

Puedes utilizar el comando set-output en tu flujo de trabajo para configurar el mismo valor:

      - name: Set selected color
        run: echo '::set-output name=SELECTED_COLOR::green'
        id: random-color-generator
      - name: Get color
        run: echo "The selected color is ${{ steps.random-color-generator.outputs.SELECTED_COLOR }}"

La siguiente tabla muestra qué funciones del toolkit se encuentran disponibles dentro de un flujo de trabajo:

| core.error | error | | core.endGroup | endgroup | | core.exportVariable | Accesible utilizando el archivo de ambiente GITHUB_ENV | | core.getInput | Accesible utilizando la variable de ambiente INPUT_{NAME} | | core.getState | Accesible utilizando la variable de ambienteSTATE_{NAME} | | core.isDebug | Accesible utilizando la variable de ambiente RUNNER_DEBUG | | core.saveState | save-state | | core.setCommandEcho | echo | | core.setFailed | Utilizada como un atajo para ::error y exit 1 | | core.setOutput | set-output | | core.setSecret | add-mask | | core.startGroup | grupo | | core.warning | advertencia |

Configurar un parámetro de salida

::set-output name={name}::{value}

Establece un parámetro de salida de la acción.

Opcionalmente, también puedes declarar parámetros de salida en el archivo de metadatos de una acción. Para obtener más información, consulta "Sintaxis de metadatos para GitHub Actions".

Ejemplo

echo "::set-output name=action_fruit::strawberry"

Agregar un mensaje de depuración

::debug::{message}

Imprime un mensaje de depuración para el registro. Debes crear un archivo ACTIONS_STEP_DEBUG designado secretamente con el valor true para ver los mensajes de depuración establecidos por este comando en el registro. Para obtener más información, consulta la sección "Habilitar el registro de depuración."

Ejemplo

echo "::debug::Set the Octocat variable"

Configurar un mensaje de aviso

::notice file={name},line={line},endLine={endLine},title={title}::{message}

Crea un mensaje de aviso e imprime el mensaje en la bitácora. Este mensaje creará una anotación, la cual puede asociar el mensaje con un archivo particular de tu repositorio. Opcionalmente, tu mensaje puede especificar una posición dentro del archivo.

| Parámetro | Valor | | :- | :- | | título | Título personalizado | | archivo | Nombre de archivo | | código | Número de columna, comenzando en 1 | | endColumn | Número de columna final | | línea | Número de línea, comenzando en 1 | | endLine | Número de línea final |

Ejemplo

echo "::notice file=app.js,line=1,col=5,endColumn=7::Missing semicolon"

Configurar un mensaje de advertencia

::warning file={name},line={line},endLine={endLine},title={title}::{message}

Crea un mensaje de advertencia e imprime el mensaje en el registro. Este mensaje creará una anotación, la cual puede asociar el mensaje con un archivo particular de tu repositorio. Opcionalmente, tu mensaje puede especificar una posición dentro del archivo.

| Parámetro | Valor | | :- | :- | | título | Título personalizado | | archivo | Nombre de archivo | | código | Número de columna, comenzando en 1 | | endColumn | Número de columna final | | línea | Número de línea, comenzando en 1 | | endLine | Número de línea final |

Ejemplo

echo "::warning file=app.js,line=1,col=5,endColumn=7::Missing semicolon"

Configurar un mensaje de error

::error file={name},line={line},endLine={endLine},title={title}::{message}

Crea un mensaje de error e imprime el mensaje en el registro Este mensaje creará una anotación, la cual puede asociar el mensaje con un archivo particular de tu repositorio. Opcionalmente, tu mensaje puede especificar una posición dentro del archivo.

| Parámetro | Valor | | :- | :- | | título | Título personalizado | | archivo | Nombre de archivo | | código | Número de columna, comenzando en 1 | | endColumn | Número de columna final | | línea | Número de línea, comenzando en 1 | | endLine | Número de línea final |

Ejemplo

echo "::error file=app.js,line=1,col=5,endColumn=7::Missing semicolon"

Agrupar líneas de las bitácoras

::group::{title}
::endgroup::

Crea un grupo expansible en la bitácora. Para crear un grupo, utiliza el comando group y especifica un title. Todo lo que imprimas en la bitácora entre los comandos group y endgroup se anidará dentro de una entrada expansible en la misma.

Ejemplo

echo "::group::My title"
echo "Inside group"
echo "::endgroup::"

Enmascarar un valor en el registro

::add-mask::{value}

El enmascaramiento de un valor impide que una cadena o variable se imprima en el registro. Cada palabra enmascarada separada por un espacio en blanco se reemplaza con el carácter *. Puedes usar una variable de entorno o cadena para el valor de la máscara.

Ejemplo de enmascaramiento de una cadena

Cuando imprimas "Mona The Octocat" en el registro, verás "***".

echo "::add-mask::Mona The Octocat"

Ejemplo de enmascaramiento de una variable de entorno

Cuando imprimes la variable MY_NAME o el valor "Mona The Octocat" en el registro, verás "***" en lugar de "Mona The Octocat".

MY_NAME="Mona The Octocat"
echo "::add-mask::$MY_NAME"

Detener e iniciar comandos de flujo de trabajo

::stop-commands::{endtoken}

Deja de procesar cualquier comando de flujo de trabajo. Este comando especial te permite registrar lo que sea sin ejecutar accidentalmente un comando de flujo de trabajo. Por ejemplo, podrías dejar de registrar para producir un script completo que tenga comentarios.

Para parar el procesamiento de los comandos de flujo de trabajo, pasa un token único a stop-commands. Para resumir los comandos de flujo de trabajo de procesamiento, pasa el mismo token que utilizaste para detener los comandos de flujo de trabajo.

::{endtoken}::

Ejemplo deteniendo e iniciando los comandos de un flujo de trabajo

jobs:
  workflow-command-job:
    runs-on: ubuntu-latest
    steps:
      - name: disable workflow commands
        run: |
          echo '::warning:: this is a warning'
          echo "::stop-commands::`echo -n ${{ github.token }} | sha256sum | head -c 64`"
          echo '::warning:: this will NOT be a warning'
          echo "::`echo -n ${{ github.token }} | sha256sum | head -c 64`::"
          echo '::warning:: this is a warning again'

Hacer eco en las salidas de comando

::echo::on
::echo::off

Habilita o inhabilita el hacer eco en los comandos de los flujos de trabajo. Por ejemplo, si utilizas el comando set-output en un flujo de trabajo, este configura un parámetro de salida pero la bitácora de la ejecución del flujo de trabajo no muestra al comando mismo. Si habilitas el eco del comando, entonces la bitácora lo mostrará, tal como en ::set-output name={name}::{value}.

El eco de comando se encuentra inhabilitado predeterminadamente. Sin embargo, los comandos de flujo de trabajo hacen eco si existen errores para procesarlos.

Los comandos add-mask, debug, warning y error no son compatibles con el eco porque sus salidas ya hicieron eco en la bitácora.

También puedes habilitar el eco de comandos globalmente si activas la generación de bitácoras de depuración de pasos utilizando el secreto ACTIONS_STEP_DEBUG. Para obtener más información, consulta la sección "Habilitar el registro de depuración". Como contraste, el comando de flujo de trabajo echo te permite habilitar el eco de comandos en un nivel más granular en vez de habilitarlo para cada flujo de trabajo en un repositorio.

Ejemplo de cómo alternar el eco de comandos

jobs:
  workflow-command-job:
    runs-on: ubuntu-latest
    steps:
      - name: toggle workflow command echoing
        run: |
          echo '::set-output name=action_echo::disabled'
          echo '::echo::on'
          echo '::set-output name=action_echo::enabled'
          echo '::echo::off'
          echo '::set-output name=action_echo::disabled'

El paso anterior imprime las siguientes líneas en la bitácora:

::set-output name=action_echo::enabled
::echo::off

Únicamente el segundo comando set-output y el de echo se incluyen en la bitácora, ya que el eco de comandos solo se habilitó cuando se ejecutaron. Aunque no siempre hace eco, el parámetro de salida se configura en todos los casos.

Enviar valores a las acciones pre y post

Puedes utilizar el comando save-state para crear variables de ambiente para compartir con tus acciones pre: o post: de flujo de trabajo. Por ejemplo, puedes crear un archivo con la acción pre:, pasar la ubicación del archivo a la acción main:, y después, utilizar la acción post: para borrar el archivo. Como alternativa, puedes crear un archivo con la acción main:, pasar la ubicación del archivo a la acción post:, y también utilizar la acción post: para borrar el archivo.

Si tienes varias acciones pre: o post:, solo podrás acceder al valor que se guardó en la acción donde se utilizó save-state. Para obtener más información sobre la acción post:, consulta la sección "Sintaxis de metadatos para GitHub Actions".

El comando save-state solo puede ejecutarse dentro de una acción y no está disponible para archivos YAML. El valor guardado se almacena en un valor de ambiente con el prefijo STATE_.

Este ejemplo utiliza JavaScript para ejecutar el comando save-state. La variable de ambiente resultante se nombra STATE_processID con el valor de 12345:

console.log('::save-state name=processID::12345')

La variable STATE_processID se encontrará entonces exclusivamente disponible para el script de limpieza que se ejecuta bajo la acción main. Este ejemplo se ejecuta en main y utiliza JavaScript para mostrar el valor asignado a la variable de ambiente STATE_processID:

console.log("The running PID from the main action is: " +  process.env.STATE_processID);

Environment files

Durante la ejecución de un flujo de trabajo, el ejecutor genera archivos temporales que pueden utilizarse para llevar a cabo ciertas acciones. La ruta a estos archivos se expone a través de variables de ambiente. Necesitarás utilizar codificación UTF-8 cuando escribas en estos archivos para garantizar el procesamiento adecuado de los comandos. Se pueden escribir varios comandos en el mismo archivo, separados por líneas nuevas.

jobs:
  legacy-powershell-example:
    uses: windows-2019
    steps:
      - shell: powershell
        run: echo "mypath" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append

jobs:
  modern-pwsh-example:
    uses: windows-2019
    steps:
      - shell: pwsh
        run: echo "mypath" | Out-File -FilePath $env:GITHUB_PATH -Append # no need for -Encoding utf8

Configurar una variable de ambiente

echo "{environment_variable_name}={value}" >> $GITHUB_ENV

You can make an environment variable available to any subsequent steps in a workflow job by defining or updating the environment variable and writing this to the GITHUB_ENV environment file. El paso que crea o actualiza la variable de ambiente no tiene acceso al valor nuevo, pero todos los pasos subsecuentes en un job tendrán acceso. The names of environment variables are case-sensitive, and you can include punctuation. Para obtener más información, consulta "Variables del entorno".

Ejemplo

steps:
  - name: Set the value
    id: step_one
    run: |
      echo "action_state=yellow" >> $GITHUB_ENV
  - name: Use the value
    id: step_two
    run: |
      echo "${{ env.action_state }}" # This will output 'yellow'

Secuencias de línea múltiple

Para las secuencias de lìnea mùltiple, puedes utilizar un delimitador con la siguiente sintaxis.

{name}<<{delimiter}
{value}
{delimiter}

Ejemplo

En este ejemplo, utilizamos EOF como delimitador y configuramos la variable de ambiente JSON_RESPONSE para el valor de la respuesta de curl.

steps:
  - name: Set the value
    id: step_one
    run: |
      echo 'JSON_RESPONSE<<EOF' >> $GITHUB_ENV
      curl https://httpbin.org/json >> $GITHUB_ENV
      echo 'EOF' >> $GITHUB_ENV

Agregar una ruta de sistema

echo "{path}" >> $GITHUB_PATH

Antepone un directorio a la variable de sistema PATH y la hace disponible automáticamente para todas las acciones subsecuentes en el job actual; la acción que se está ejecutando actualmente no puede acceder a la variable de ruta actualizada. Para ver las rutas definidas actualmente para tu job, puedes utilizar echo "$PATH" en un paso o en una acción.

Ejemplo

Este ejemplo demuestra cómo agregar el directorio $HOME/.local/bin del usuario al PATH:

echo "$HOME/.local/bin" >> $GITHUB_PATH