Examinar um arquivo de fluxo de trabalho

Concluído

O GitHub Actions usa a sintaxe YAML para definir o fluxo de trabalho. Cada fluxo de trabalho é armazenado como um arquivo YAML separado em seu repositório de código, em um diretório chamado .github/workflows. O exemplo de fluxo de trabalho a seguir é disparado sempre que o código é enviado por push para um repositório. O fluxo de trabalho executa as seguintes etapas:

1. Verifica o código enviado por push.
2. Instala o Node.js.
3. Instala a estrutura de teste do Bash Automated Testing System (Bats).
4. Executa um comando para gerar a versão do 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

Noções básicas sobre o arquivo de fluxo de trabalho

Para ajudá-lo a entender como a sintaxe YAML é usada para criar um arquivo de fluxo de trabalho, esta seção explica cada linha do exemplo 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

Exibir a atividade de uma execução de fluxo de trabalho

Quando um fluxo de trabalho é disparado, é criada uma execução de fluxo de trabalho que o executa. Depois que uma execução de fluxo de trabalho for iniciada, você poderá ver um grafo de visualização do progresso da execução e exibir a atividade de cada etapa no GitHub. Siga estas etapas para exibir a atividade:

1. Navegue até a página principal do repositório.

2. Selecione Ações localizado sob o nome do repositório.

3. Na barra lateral esquerda, selecione o fluxo de trabalho que você deseja ver.

4. Na lista de execuções de fluxo de trabalho, selecione o nome da execução para ver o resumo da execução do fluxo de trabalho.

5. Na barra lateral esquerda ou no grafo de visualização, selecione o trabalho que você deseja ver.

6. Selecione uma etapa para exibir resultados detalhados.

Agora que você entende os componentes do arquivo de fluxo de trabalho, você pode ver como os desenvolvedores podem personalizar o arquivo para uma variedade de casos de uso.