Skip to main content

Entendendo o GitHub Actions

Aprenda o básico de GitHub Actions, incluindo conceitos fundamentais e terminologia essencial.

Visão geral

GitHub Actions é uma plataforma de integração contínua e entrega contínua (CI/CD) que permite automatizar a sua compilação, testar e pipeline de implantação. É possível criar fluxos de trabalho que criam e testam cada pull request no seu repositório, ou implantar pull requests mesclados em produção.

GitHub Actions vai além de apenas DevOps e permite que você execute fluxos de trabalho quando outros eventos ocorrerem no seu repositório. Por exemplo, você pode executar um fluxo de trabalho para adicionar automaticamente as etiquetas apropriadas sempre que alguém cria um novo problema no repositório.

Você deve hospedar suas próprias máquinas virtuais do Linux, do Windows ou do macOS a fim de executar fluxos de trabalho para o your enterprise. Os executores auto-hospedados podem ser físicos, virtuais, em um contêiner, no local ou em uma nuvem.

Para obter mais informações sobre como apresentar o GitHub Actions à sua empresa, confira "Apresentação do GitHub Actions à sua empresa".

Componentes de GitHub Actions

Você pode configurar um fluxo de trabalho do GitHub Actions a ser disparado quando um evento ocorrer no seu repositório, como a abertura de uma solicitação de pull ou a criação de um problema. Seu fluxo de trabalho contém um ou mais trabalhos que podem ser executados em ordem sequencial ou em paralelo. Cada trabalho será executado em um executor próprio de máquina virtual ou em um contêiner e tem uma ou mais etapas que executam um script definido por você ou uma ação, que é uma extensão reutilizável que pode simplificar o fluxo de trabalho.

Visão geral do fluxo de trabalho

Fluxos de trabalho

Um fluxo de trabalho é um processo automatizado configurável que executa um ou mais trabalhos. Os fluxos de trabalho são definidos por um arquivo YAML verificado no seu repositório e será executado quando acionado por um evento no repositório, ou eles podem ser acionados manualmente ou de acordo com um cronograma definido.

Os fluxos de trabalho são definidos no diretório .github/workflows em um repositório. Um repositório pode ter vários fluxos de trabalho, cada um dos quais pode executar um conjunto diferente de tarefas. Por exemplo, você pode ter um fluxo de trabalho para criar e testar pull requests, outro fluxo de trabalho para implantar seu aplicativo toda vez que uma versão for criada, e outro fluxo de trabalho que adiciona uma etiqueta toda vez que alguém abre um novo problema.

É possível referenciar um fluxo de trabalho em outro fluxo de trabalho. Confira "Reutilizar fluxos de trabalho".

Para obter mais informações sobre os fluxos de trabalho, confira "Como usar fluxos de trabalho".

Eventos

Um evento é uma atividade específica em um repositório que aciona a execução de um fluxo de trabalho. Por exemplo, a atividade pode originar-se de GitHub quando alguém cria uma solicitação de pull request, abre um problema ou faz envio por push de um commit para um repositório. Você também pode disparar uma execução de fluxo de trabalho de acordo com um agendamento, com um POST em uma API REST ou manualmente.

Para ver uma lista completa dos eventos que podem ser usados para disparar fluxos de trabalho, confira Eventos que disparam fluxos de trabalho.

Trabalhos

Um trabalho é um conjunto de etapas em um fluxo de trabalho executado no mesmo executor. Cada etapa é um script de shell que será executado ou uma ação que será executada. As etapas são executadas em ordem e dependem uma da outra. Uma vez que cada etapa é executada no mesmo executor, você pode compartilhar dados de um passo para outro. Por exemplo, você pode ter uma etapa que compila a sua aplicação seguida de uma etapa que testa ao aplicativo criado.

Você pode configurar as dependências de um trabalho com outros trabalhos; por padrão, os trabalhos não têm dependências e são executados em paralelo um com o outro. Quando um trabalho leva uma dependência de outro trabalho, ele irá aguardar que o trabalho depeendente seja concluído antes que possa executar. Por exemplo, você pode ter vários trabalhos de criação para diferentes arquiteturas que não têm dependências, e um trabalho de pacotes que depende desses trabalhos. Os trabalhos de criação serão executados em paralelo e, quando todos forem concluídos com sucesso, o trabalho de empacotamento será executado.

Para obter mais informações sobre trabalhos, confira "Como usar trabalhos".

Ações

Uma ação é um aplicativo personalizado para a plataforma GitHub Actions que executa uma tarefa complexa, mas frequentemente repetida. Use uma ação para ajudar a reduzir a quantidade de código repetitivo que você grava nos seus arquivos de fluxo de trabalho. Uma ação pode extrair o seu repositório git de GitHub, configurar a cadeia de ferramentas correta para seu ambiente de criação ou configurar a autenticação para seu provedor de nuvem.

Você pode gravar suas próprias ações, ou você pode encontrar ações para usar nos seus fluxos de trabalho em GitHub Marketplace.

Para obter mais informações, confira "Como criar ações".

Executores

Um executor é um servidor que executa seus fluxos de trabalho quando são acionados. Cada executor pode executar uma tarefa por vez. Você deve hospedar seus próprios executores para GitHub AE. Para obter mais informações, confira "Como hospedar executores próprios".

Criar um exemplo de fluxo de trabalho

GitHub Actions usa a sintaxe do YAML para definir o fluxo de trabalho. Cada fluxo de trabalho é armazenado como um arquivo YAML separado no seu repositório de código, em um diretório chamado .github/workflows.

Você pode criar um exemplo de fluxo de trabalho no repositório que aciona automaticamente uma série de comandos sempre que o código for carregado. Nesse fluxo de trabalho, GitHub Actions verifica o código enviado, instala a estrutura de teste bats e executa um comando básico para gerar a versão bats:bats -v.

  1. No repositório, crie o diretório .github/workflows/ para armazenar os arquivos de fluxo de trabalho.

  2. No diretório .github/workflows/, crie um arquivo chamado learn-github-actions.yml e adicione o código a seguir.

    YAML
    name: learn-github-actions
    on: [push]
    jobs:
      check-bats-version:
        runs-on: ubuntu-latest
        steps:
          - uses: actions/checkout@v2
          - uses: actions/setup-node@v2
            with:
              node-version: '14'
          - run: npm install -g bats
          - run: bats -v
  3. Faça commit dessas alterações e faça push para o seu repositório do GitHub.

Seu novo arquivo de fluxo de trabalho de GitHub Actions agora está instalado no seu repositório e será executado automaticamente toda vez que alguém fizer push de uma alteração no repositório. Para conferir os detalhes sobre o histórico de execução de um fluxo de trabalho, confira "Exibir a atividade de uma execução de fluxo de trabalho".

Entender o arquivo de fluxo de trabalho

Para ajudar você a entender como a sintaxe de YAML é usada para criar um arquivo de fluxo de trabalho, esta seção explica cada linha do exemplo Introdução:

name: learn-github-actions
Opcional - O nome do fluxo de trabalho, conforme ele será exibido na guia "Ações" do repositório do GitHub.
on: [push]
Especifica o gatilho para este fluxo de trabalho. Este exemplo usa o evento push, para que uma execução de fluxo de trabalho seja disparada sempre que alguém efetuar push de uma alteração para o repositório ou mesclar uma solicitação de pull. Isso é disparado por um push para cada branch. Para ver exemplos de sintaxe que são executados somente em pushes para branches, marcas ou caminhos específicos, confira "Sintaxe de fluxo de trabalho do GitHub Actions".
jobs:
Agrupa todos os trabalhos executados no fluxo de trabalho learn-github-actions.
check-bats-version:
Define um trabalho chamado check-bats-version. As chaves secundaárias definirão as propriedades do trabalho.
  runs-on: ubuntu-latest
Configura o trabalho a ser executado na versão mais recente de um executor do Linux do Ubuntu. Isto significa que o trabalho será executado em uma nova máquina virtual hospedada pelo GitHub. Para ver exemplos de sintaxe que usam outros executores, confira "Sintaxe de fluxo de trabalho do GitHub Actions".
  steps:
Agrupa todas as etapas que são executadas no trabalho check-bats-version. Cada item aninhado nesta seção é uma ação separada ou script do shell.
    - uses: actions/checkout@v2
A palavra-chave uses especifica que esta etapa executará v3 da ação actions/checkout. Esta é uma ação que faz o check-out do seu repositório para o executor, permitindo que você execute scripts ou outras ações com base no seu código (como ferramentas de compilação e teste). Você deve usar a ação de checkout sempre que o fluxo de trabalho for executado no código do repositório.
    - uses: actions/setup-node@v2
      with:
        node-version: '14'
Esta etapa usa a ação actions/setup-node@v2 para instalar a versão especificada do Node.js (este exemplo usa a v14). Isso insere os comandos node e npm no PATH.
    - run: npm install -g bats
A palavra-chave run instrui o trabalho a executar um comando no executor. Nesse caso, você está usando npm para instalar o pacote de teste de software bats.
    - run: bats -v
Por fim, você executará o comando bats com um parâmetro que gera a versão do software.

Visualizar o arquivo de fluxo de trabalho

Neste diagrama, você pode ver o arquivo de fluxo de trabalho que acabou de criar e como os componentes de GitHub Actions estão organizados em uma hierarquia. Cada etapa executa uma única ação ou script do shell. As etapas 1 e 2 executam ações, enquanto as etapas 3 e 4 executam scripts de shell. Para encontrar mais ações predefinidas para seus fluxos de trabalho, confira "Como localizar e personalizar ações".

Visão geral do fluxo de trabalho

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

Quando seu fluxo de trabalho é acionado, é criada uma execução de fluxo de trabalho que executa o fluxo de trabalho. Após o início de uma execução de fluxo de trabalho, você pode ver um gráfico de visualização do progresso da execução e visualizar a atividade de cada etapa em GitHub.

  1. No your enterprise, navegue até a página principal do repositório.

  2. Abaixo do nome do seu repositório, clique em Ações.

    Acesse o repositório

  3. Na barra lateral esquerda, clique no fluxo de trabalho que deseja ver.

    Captura de tela dos resultados do fluxo de trabalho

  4. Em "Execuções do fluxo de trabalho", clique no nome da execução que você deseja ver.

    Captura de tela das execuções do fluxo de trabalho

  5. Em Trabalhos ou no grafo de visualização, clique no trabalho que deseja ver.

    Selecionar trabalho

  6. Exiba os resultados detalhados de cada etapa.

    Captura de tela dos detalhes de execução do fluxo de trabalho

Próximas etapas

O GitHub Actions pode ajudá-lo a automatizar quase todos os aspectos dos processos de desenvolvimento do seu aplicativo. Pronto para começar? Aqui estão alguns recursos úteis para dar seus próximos passos com GitHub Actions:

  • Para fluxos de trabalho de CI (integração contínua) para criar e testar seu código, confira "Como automatizar builds e testes".
  • Para compilar e publicar pacotes, confira "Como publicar pacotes".
  • Para implantar projetos, confira "Implantação".
  • Para automatizar tarefas e processos em GitHub, confira "Como gerenciar problemas e solicitações de pull".
  • Para obter exemplos que demonstram recursos mais complexos do GitHub Actions, incluindo muitos dos casos de uso acima, confira " Exemplos". Você pode ver exemplos detalhados que explicam como testar seu código em um executor, acessar a CLI do GitHub e usar recursos avançados, como simultaneidade e matrizes de teste.

Entrar em contato com o suporte

Se você precisar de ajuda com qualquer questão relacionada à configuração do fluxo de trabalho, como sintaxe, executores hospedados em GitHub ou ações de build, procure um tópico existente ou inicie um novo nas variáveis de dados na categoria GitHub Actions e GitHub Packages de GitHub Community.

Se você tiver comentários ou solicitações de recursos para GitHub Actions, compartilhe-os na GitHub Community discussions for GitHub Actions.

Contatar your enterprise owner para qualquer uma das seguintes opções, se o uso ou uso pretendido se enquadra nas categorias limite:

  • Se você acredita que sua conta foi restrita incorretamente
  • Se você encontrar um erro inesperado ao executar uma de suas ações
  • Se você encontrar uma situação onde o comportamento existente contradiz o esperado, mas nem sempre documentado, comportamento

Leitura adicional