Examen de un archivo de flujo de trabajo

Completado

Las acciones de GitHub usan la sintaxis YAML para definir el flujo de trabajo. Cada flujo de trabajo se almacena como un archivo YAML independiente en el repositorio de código, en un directorio denominado .github/workflows. El siguiente ejemplo de flujo de trabajo se desencadena cada vez que se inserta código en un repositorio. El flujo de trabajo realiza los pasos siguientes:

1. Comprueba el código insertado.
2. Instala Node.js.
3. Instala el marco de pruebas Bash Automated Testing System (BATS).
4. Ejecuta un comando para generar la versión de Bats: bats -v.

name: learn-github-actions
run-name: ${{ github.actor }} is learning GitHub Actions
on: [push]
jobs:
  check-bats-version:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm install -g bats
      - run: bats -v

Descripción del archivo de flujo de trabajo

Para ayudarle a comprender cómo se usa la sintaxis de YAML para crear un archivo de flujo de trabajo, en esta sección se explica cada línea del ejemplo anterior:

# Optional - The name of the workflow as it will appear in the "Actions" tab of the GitHub repository. If this field is omitted, the name of the workflow file will be used instead.
name: learn-github-actions

# Optional - The name for workflow runs generated that appear in the list of workflow runs on your repository's "Actions" tab. This example uses an expression with the 'github' context to display the username of the actor that triggered the workflow run. 
run-name: ${{ github.actor }} is learning GitHub Actions

# Specifies the trigger for this workflow. This example uses the 'push' event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request.
on: [push]

# Groups together all the jobs that run in the 'learn-github-actions' workflow.
jobs:

# Defines a job named 'check-bats-version'. The child keys will define properties of the job.
  check-bats-version:

# Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub.
    runs-on: ubuntu-latest

# Groups together all the steps that run in the 'check-bats-version' job. Each item nested under this section is a separate action or shell script.
    steps:

# The 'uses' keyword specifies that this step will run 'v4' of the 'actions/checkout' action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will use the repository's code.
      - uses: actions/checkout@v4

# This step uses the 'actions/setup-node@v4' action to install the specified version of the Node.js. (This example uses version 20.) This puts both the 'node' and 'npm' commands in your PATH.
      - uses: actions/setup-node@v4
        with:
          node-version: '20'

# The 'run' keyword tells the job to execute a command on the runner. In this case, you are using 'npm' to install the 'bats' software testing package.
      - run: npm install -g bats

# The 'bats' command with a parameter that outputs the software version.
      - run: bats -v

Visualización de la actividad de una ejecución de flujo de trabajo

Cuando se desencadena un flujo de trabajo, se crea una ejecución que lo lleva a cabo. Una vez iniciada la ejecución de un flujo de trabajo, puede ver un gráfico de visualización del progreso de la ejecución y ver la actividad de cada paso en GitHub. Siga estos pasos para ver la actividad:

1. Vaya a la página principal del repositorio.

2. Seleccione el botón Acciones que aparece bajo el nombre del repositorio.

3. En la barra lateral izquierda, seleccione el flujo de trabajo que desea ver.

4. En la lista de ejecuciones de flujo de trabajo, seleccione el nombre de la ejecución para ver el resumen de ejecución del flujo de trabajo.

5. En la barra lateral izquierda o en el gráfico de visualización, seleccione el trabajo que desea ver.

6. Seleccione un paso para ver los resultados detallados.

Ahora que comprende los componentes del archivo de flujo de trabajo, puede ver cómo los desarrolladores pueden personalizar el archivo para una variedad de casos de uso.