Armazenar dados do fluxo de trabalho como artefatos

Sobre artefatos de fluxos de trabalho

Os artefatos permitem que você persista com os dados após um trabalho ter sido concluído e compartilhe os dados com outro trabalho no mesmo fluxo de trabalho. Um artefato é um arquivo ou uma coleção de arquivos produzidos durante a execução de um fluxo de trabalho. Por exemplo, você pode usar artefatos para salvar a sua criação e testar a saída após uma conclusão da execução do fluxo de trabalho. Todas as ações e todos os fluxos de trabalho chamados em uma execução têm acesso de gravação aos artefatos dessa execução.

Por padrão, o GitHub Enterprise Cloud armazena logs de build e artefatos por 90 dias e esse período de retenção pode ser personalizado. Para obter mais informações, confira "Limites de uso, cobrança e administração". O período de retenção para uma solicitação de pull é reiniciado sempre que alguém efetua push de um novo commit para a solicitação de pull.

Esses são alguns dos artefatos comuns cujo upload você pode fazer:

• Arquivos de log e descartes de memória;
• Resultados de testes, falhas e capturas de tela;
• Arquivos binários ou comprimidos
• Resultados de teste de estresse e resultados de cobertura do código.

Armazenar artefatos consome espaço de armazenamento em GitHub Enterprise Cloud. GitHub Actions o uso é gratuito para executores padrão hospedados no GitHub em repositórios públicos e para executores auto-hospedados. Para repositórios privados, cada conta GitHub recebe uma certa quantidade de minutos e armazenamento gratuitos para uso com executores hospedados no GitHub, dependendo do produto usado com a conta. Qualquer uso além dos valores incluídos é controlado pelos limites de gastos. Para obter mais informações, confira "Como gerenciar a cobrança do GitHub Actions".

Faz-se o upload dos artefatos durante a execução de um fluxo de trabalho e você pode visualizar o nome e o tamanho do artefato na UI. Quando se faz o download de um artefato usando a UI GitHub Enterprise Cloud, todos os arquivos cujo upload foi feito individualmente como parte do get do artefato zipado em um arquivo único. Isso significa que a cobrança é calculada com base no tamanho do artefato subido e não com base no tamanho do arquivo zip.

O GitHub Enterprise Cloud fornece duas ações que você pode usar para fazer upload e baixar artefatos de compilação. Para obter mais informações, confira as ações actions/upload-artifact e download-artifact.

Para compartilhar dados entre trabalhos:

• Upload de arquivos: dê um nome ao arquivo carregado e carregue os dados antes da conclusão do trabalho.
• Download de arquivos: só é possível baixar artefatos que foram carregados na mesma execução de fluxo de trabalho. Ao fazer o download de um arquivo, você pode fazer referenciá-lo pelo nome.

As etapas de um trabalho compartilham o mesmo ambiente na máquina executora, mas são executados em seus próprios processos individuais. Para transmitir dados entre etapas de um trabalho, você pode usar entradas e saídas. Para obter mais informações sobre entradas e saídas, confira "Sintaxe de metadados do GitHub Actions".

Comparando artefatos e memorização de dependência

Os artefatos são similares, pois fornecem a habilidade de armazenar arquivos em GitHub, mas cada recurso oferece usos diferentes e não podem ser usados de forma intercambiável.

• Use o cache quando quiser reutilizar arquivos que não são alterados com frequência entre trabalhos ou execuções de fluxo de trabalho, como dependências de build de um sistema de gerenciamento de pacotes.
• Use artefatos quando quiser salvar arquivos produzidos por um trabalho a serem exibidos após o fim de uma execução de fluxo de trabalho, como binários internos ou logs de build.

Para obter mais informações sobre dependência em cache, confira "Como armazenar dependências em cache para acelerar os fluxos de trabalho".

Fazer upload da compilação e testar artefatos

Você pode criar um fluxo de trabalho de integração contínua (CI) para criar e testar o seu código. Para obter mais informações sobre como usar o GitHub Actions para executar a CI, confira "Sobre a integração contínua".

A saída da compilação e teste de seu código muitas vezes produz arquivos que podem ser usados para depurar falhas em testes e códigos de produção que você pode implantar. É possível configurar um fluxo de trabalho para compilar e testar o código com push no repositório e relatar um status de sucesso ou falha. Você pode fazer upload da saída de compilação e teste para usar em implantações, para depurar falhas e testes com falhas e visualizar a cobertura do conjunto de teste.

Use a ação upload-artifact para carregar artefatos. Ao fazer o upload de um artefato, você pode especificar um arquivo ou diretório único, ou vários arquivos ou diretórios. Você também pode excluir certos arquivos ou diretórios e usar padrões coringa. Recomendamos que você forneça um nome para um artefato, mas se nenhum nome for fornecido, artifact será usado como o nome padrão. Para obter mais informações sobre a sintaxe, confira a ação actions/upload-artifact.

Exemplo

Por exemplo, o seu repositório ou um aplicativo web pode conter arquivos SASS e TypeScript que você deve converter para CSS e JavaScript. Pressupondo que a sua configuração de build gere os arquivos compilados no diretório dist, você implantará os arquivos no diretório dist no seu servidor de aplicativos Web se todos os testes forem concluídos com sucesso.

|-- hello-world (repository)
|   └── dist
|   └── tests
|   └── src
|       └── sass/app.scss
|       └── app.ts
|   └── output
|       └── test
|   

Este exemplo mostra como criar um fluxo de trabalho para um projeto do Node.js que compila o código no diretório src e executa os testes no diretório tests. Você pode pressupor que a execução npm test produza um relatório de cobertura de código chamado code-coverage.html armazenado no diretório output/test/.

O fluxo de trabalho carrega os artefatos de produção no diretório dist, mas exclui os arquivos markdown. Ele também carrega o relatório code-coverage.html como outro artefato.

name: Node CI

on: [push]

jobs:
  build_and_test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3
      - name: npm install, build, and test
        run: |
          npm install
          npm run build --if-present
          npm test
      - name: Archive production artifacts
        uses: actions/upload-artifact@v3
        with:
          name: dist-without-markdown
          path: |
            dist
            !dist/**/*.md
      - name: Archive code coverage results
        uses: actions/upload-artifact@v3
        with:
          name: code-coverage-report
          path: output/test/code-coverage.html

Configurar um período de retenção do artefato personalizado

Você pode definir um período de retenção personalizado para artefatos individuais criados por um fluxo de trabalho. Ao usar um fluxo de trabalho para criar um artefato, você pode usar retention-days com a ação upload-artifact. Este exemplo demonstra como definir um período de retenção personalizado de cinco dias para o artefato chamado my-artifact:

  - name: 'Upload Artifact'
    uses: actions/upload-artifact@v3
    with:
      name: my-artifact
      path: my_file.txt
      retention-days: 5

O valor retention-days não pode exceder o limite de retenção definido pelo repositório, pela organização ou pela empresa.

Fazer o download ou excluir artefatos

Durante a execução de um fluxo de trabalho, você pode usar a ação download-artifact para baixar os artefatos que foram previamente carregados na mesma execução de fluxo de trabalho.

Após a conclusão da execução de um fluxo de trabalho, você pode fazer o download ou excluir artefatos em GitHub ou usar a API REST. Para obter mais informações, confira "Como baixar artefatos de fluxo de trabalho", "Como remover artefatos de fluxo de trabalho" e a "API REST de Artefatos".

Fazer o download dos artefatos durante a execução de um fluxo de trabalho

A ação actions/download-artifact pode ser usada para baixar artefatos já carregados durante uma execução de fluxo de trabalho.

Especifique o nome de um artefato para fazer o download de um artefato individual. Se você carregar um artefato sem especificar um nome, o nome padrão será artifact.

- name: Download a single artifact
  uses: actions/download-artifact@v3
  with:
    name: my-artifact

Você também pode baixar todos os artefatos em uma execução de fluxo de trabalho sem especificar um nome. Isso pode ser útil se você estiver trabalhando com muitos artefatos.

- name: Download all workflow run artifacts
  uses: actions/download-artifact@v3

Se você fizer o download de todos os artefatos da execução de um fluxo de trabalho, será criado um diretório para cada artefato usando seu nome.

Para obter mais informações sobre a sintaxe, confira a ação actions/download-artifact.

Passando dados entre trabalhos em um fluxo de trabalho

Use as ações upload-artifact e download-artifact para compartilhar dados entre trabalhos em um fluxo de trabalho. Este exemplo de fluxo de trabalho ilustra como transmitir dados entre trabalhos em um mesmo fluxo. Para obter mais informações, confira as ações actions/upload-artifact e download-artifact.

Os trabalhos que são dependentes de artefatos de um trabalho anterior devem aguardar a finalização do trabalho dependente. Esse fluxo de trabalho usa a palavra-chave needs para garantir que job_1, job_2 e job_3 sejam executados sequencialmente. Por exemplo, job_2 exige o job_1 usando a sintaxe needs: job_1.

O Job 1 (Trabalho 1) executa estas etapas:

• Faz um cálculo matemático e salva o resultado em um arquivo de texto chamado math-homework.txt.
• Usa a ação upload-artifact para carregar o arquivo math-homework.txt com o nome de artefato homework.

O Job 2 (Trabalho 2) usa o resultado do trabalho anterior:

• Baixa o artefato homework carregado no trabalho anterior. Por padrão, a ação download-artifact baixa artefatos no diretório do workspace no qual a etapa está sendo executada. Use o parâmetro de entrada path para especificar outro diretório de download.
• Lê o valor do arquivo math-homework.txt, faz um cálculo matemático e salva o resultado em math-homework.txt novamente, substituindo o conteúdo.
• Carrega o arquivo math-homework.txt. Este upload sobrescreve o artefato carregado anteriormente porque compartilham o mesmo nome.

O Job 3 (Trabalho 3) mostra o resultado carregado no trabalho anterior:

• Baixa o artefato homework.
• Imprime o resultado da operação matemática no log.

A operação matemática completa feita nesse exemplo de fluxo de trabalho é (3 + 7) x 9 = 90.

name: Share data between jobs

on: [push]

jobs:
  job_1:
    name: Add 3 and 7
    runs-on: ubuntu-latest
    steps:
      - shell: bash
        run: |
          expr 3 + 7 > math-homework.txt
      - name: Upload math result for job 1
        uses: actions/upload-artifact@v3
        with:
          name: homework
          path: math-homework.txt

  job_2:
    name: Multiply by 9
    needs: job_1
    runs-on: windows-latest
    steps:
      - name: Download math result for job 1
        uses: actions/download-artifact@v3
        with:
          name: homework
      - shell: bash
        run: |
          value=`cat math-homework.txt`
          expr $value \* 9 > math-homework.txt
      - name: Upload math result for job 2
        uses: actions/upload-artifact@v3
        with:
          name: homework
          path: math-homework.txt

  job_3:
    name: Display results
    needs: job_2
    runs-on: macOS-latest
    steps:
      - name: Download math result for job 2
        uses: actions/download-artifact@v3
        with:
          name: homework
      - name: Print the final result
        shell: bash
        run: |
          value=`cat math-homework.txt`
          echo The result is $value

A execução do fluxo de trabalho arquivará quaisquer artefatos gerados por ele. Para obter mais informações sobre como baixar os artefatos arquivados, confira "Como baixar os artefatos de fluxo de trabalho".

Leitura adicional

• "Como gerenciar a cobrança do GitHub Actions".