Início rápido para GitHub Actions

Introdução

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.

Este guia de início rápido mostra como usar a interface do usuário do GitHub para adicionar um fluxo de trabalho que demonstra alguns dos recursos essenciais de GitHub Actions.

Para começar a usar fluxos de trabalho pré-configurados, navegue pela lista de modelos no repositório actions/starter-workflows. Para obter mais informações, confira "Usando modelos de fluxo de trabalho".

Para obter uma visão geral sobre fluxos de trabalho de GitHub Actions, confira Sobre fluxos de trabalho. Se você quiser saber mais sobre os vários componentes que compõem GitHub Actions, consulte Entendendo o GitHub Actions.

Usando modelos de fluxo de trabalho

O GitHub fornece modelos de fluxo de trabalho pré-configurados que você pode usar no estado em que se encontram ou personalizar para criar seu próprio fluxo de trabalho. O GitHub Enterprise Server analisa seu código e mostra os modelos de fluxo de trabalho que podem ser úteis para seu repositório. Por exemplo, se o seu repositório contiver o código Node.js, você verá sugestões para projetos Node.js.

Esses modelos de fluxo de trabalho são projetados para ajudar a entrar em funcionamento rapidamente, oferecendo uma variedade de configurações, como:

• CI: fluxos de trabalho de integração contínua
• Implantações: fluxos de trabalho de implantação
• Automação: fluxos de trabalho de automação
• Varredura de código: fluxos de trabalho de varredura de código
• Páginas: fluxos de trabalho de páginas

Use esses fluxos de trabalho como ponto de partida para criar seu fluxo de trabalho personalizado ou usá-los no estado em que se encontram. É possível navegar pela lista completa de modelos de fluxo de trabalho no repositório actions/starter-workflows. Para obter mais informações, confira "Usando modelos de fluxo de trabalho".

Pré-requisitos

Este guia supõe que:

• Você tem pelo menos um conhecimento básico de como usar GitHub. Se você não fizer isso, achará útil ler alguns dos artigos na documentação sobre repositórios e pull requests primeiro. Para ver exemplos, confira Início rápido para repositórios, Sobre ramificações e Sobre solicitação de pull.

• Você tem um repositório em GitHub, onde pode adicionar arquivos.

• Você tem acesso ao GitHub Actions.

  Note

  Se a guia Ações não for exibida sob o nome do repositório em GitHub, isso poderá ter ocorrido Ações está desabilitado para o repositório. Para saber mais, confira Gerenciando as configurações do GitHub Actions para um repositório.

Criar o seu primeiro fluxo de trabalho

1. Em seu repositório em GitHub, crie um arquivo de fluxo de trabalho chamado github-actions-demo.yml no diretório .github/workflows. Para fazer isso:

   • Se o diretório .github/workflows já existir, navegue até esse diretório em GitHub, clique em Adicionar arquivo e, em seguida, clique em Criar novo arquivo e nomeie o arquivo como github-actions-demo.yml.

   • Se o repositório não tiver um diretório .github/workflows, vá para a página principal do repositório em GitHub, clique em Adicionar arquivo e, em seguida, clique em Criar novo arquivo e nomeie o arquivo como .github/workflows/github-actions-demo.yml. Isso criará os diretórios .github e workflows e o arquivo github-actions-demo.yml em uma única etapa.

   Note

   Para que GitHub descubra quaisquer fluxos de trabalho GitHub Actions do repositório, você deverá salvar os arquivos do fluxo de trabalho em um diretório chamado .github/workflows.

   É possível dar ao arquivo de fluxo de trabalho qualquer nome que desejar, mas você deverá usar .yml ou .yaml como a extensão de nome de arquivo. YAML é uma linguagem de marcação comumente usada para arquivos de configuração.

2. Copie o seguinte conteúdo YAML para o arquivo github-actions-demo.yml:

   YAML

   name: GitHub Actions Demo
   run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
   on: [push]
   jobs:
     Explore-GitHub-Actions:
       runs-on: ubuntu-latest
       steps:
         - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
         - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
         - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
         - name: Check out repository code
           uses: actions/checkout@v4
         - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
         - run: echo "🖥️ The workflow is now ready to test your code on the runner."
         - name: List files in the repository
           run: |
             ls ${{ github.workspace }}
         - run: echo "🍏 This job's status is ${{ job.status }}."
   

   Neste estágio, você não precisa entender os detalhes desse fluxo de trabalho. Por enquanto, só é possível copiar e colar o conteúdo no arquivo. Depois de concluir este guia de início rápido, você poderá aprender sobre a sintaxe dos arquivos de fluxo de trabalho em Sobre fluxos de trabalho e, para obter uma explicação dos contextos de GitHub Actions, como ${{ github.actor }} e ${{ github.event_name }}, confira Acessar informações contextuais sobre execuções de fluxo de trabalho.

3. Clique em Confirmar alterações.

4. Na caixa de diálogo "Propor alterações", selecione a opção para confirmar o branch padrão ou a opção para criar um novo branch e iniciar uma solicitação de pull. Em seguida, clique em Fazer commit de alterações ou em Propor alterações.

   

O commit do arquivo de fluxo de trabalho em um branch no repositório dispara o evento push e executa o fluxo de trabalho.

Se você optar por iniciar uma solicitação de pull, poderá continuar e criar a solicitação de pull, mas isso não será necessário para os fins deste início rápido, pois a confirmação ainda foi feita em um branch e acionará o novo fluxo de trabalho.

Visualizar os resultados do seu fluxo de trabalho

1. Em GitHub, acesse a página principal do repositório.

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

   

3. Na barra lateral esquerda, clique no fluxo de trabalho que deseja exibir, neste exemplo "Demonstração do GitHub Actions".

   

4. Na lista de execuções de fluxo de trabalho, clique no nome da execução que deseja ver. Neste exemplo "USERNAME está testando o GitHub Actions".

5. Na barra lateral esquerda da página de execução do fluxo de trabalho, em Trabalhos, clique no trabalho Explore-GitHub-Actions.

   

6. O registro mostra como cada uma das etapas foi processada. Expanda qualquer um dos passos para ver seus detalhes.

   

   Por exemplo, é possível ver a lista de arquivos no repositório:

   

O fluxo de trabalho de exemplo que você acabou de adicionar é disparado cada vez que o código é enviado para o branch e mostra como GitHub Actions pode funcionar com o conteúdo do seu repositório. Para obter um tutorial detalhado, confira Entendendo o GitHub Actions.

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 criar um fluxo de trabalho do GitHub Actions, consulte "Usando modelos de fluxo de trabalho".
• Para fluxos de trabalho de CI (integração contínua), consulte "Como criar e testar".
• Para compilar e publicar pacotes, confira "Publicando pacotes".
• Para implantar projetos, confira "Casos de uso e exemplos".
• Para automatizar tarefas e processos em GitHub, confira "Como gerenciar projetos".
• Para obter exemplos que demonstram recursos mais complexos do GitHub Actions, consulte "Casos de uso e exemplos". Esses exemplos detalhados 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.