Como Usar o GitHub Copilot em Arquivos de Workflow do GitHub Actions

Você quer escrever arquivos de workflow do GitHub Actions mais rápido e com menos erros de sintaxe. O GitHub Copilot pode gerar blocos YAML, sugerir nomes de actions corretos e corrigir problemas de indentação em tempo real. Este artigo explica como ativar o Copilot para seus arquivos de workflow e como escrever prompts eficazes para obter sugestões precisas.

O GitHub Copilot é um programador parceiro de IA que sugere código enquanto você digita. Em arquivos de workflow do GitHub Actions, o Copilot entende a estrutura de jobs, steps, uses e parâmetros with. Ele pode completar linhas YAML parciais ou gerar steps inteiros com base em um comentário ou algumas teclas.

Este guia aborda as etapas de configuração do Copilot no Visual Studio Code e no editor web do GitHub, os melhores prompts para padrões comuns de workflow e as limitações que você encontrará na geração de YAML.

Como o Copilot Gera Código de Workflow

O GitHub Copilot aprende com repositórios públicos do GitHub, incluindo milhares de arquivos de workflow do Actions. Quando você começa a digitar em um arquivo .yml ou .yaml, o Copilot prevê as próximas linhas com base no contexto do seu repositório, no nome do arquivo e nos padrões de workflow existentes.

O modelo entende regras de indentação YAML, identificadores de action como actions/checkout@v4 e estruturas comuns de workflow, como eventos de gatilho, matrizes de jobs e variáveis de ambiente. Ele não executa o workflow nem verifica se as versões das actions existem. Ele apenas sugere texto que corresponde a padrões que já viu.

O Copilot funciona em dois modos em arquivos de workflow. As conclusões inline aparecem como texto fantasma cinza enquanto você digita. O painel Copilot Chat aceita prompts em linguagem natural e retorna blocos de código que você pode inserir manualmente.

Pré-requisitos

Antes de começar, você precisa destes itens:

• Uma conta do GitHub com uma assinatura ativa do Copilot. Copilot Free, Copilot Pro e Copilot Enterprise oferecem suporte a sugestões em arquivos de workflow.
• Visual Studio Code com a extensão GitHub Copilot instalada, ou acesso ao editor web do GitHub com o Copilot ativado.
• Um repositório que contenha um diretório .github/workflows com pelo menos um arquivo .yml ou .yaml.

Passos para Usar o Copilot em Seus Arquivos de Workflow

Esta seção aborda os dois ambientes principais onde você pode usar o Copilot para arquivos de workflow: Visual Studio Code e o editor web do GitHub. Cada método produz a mesma qualidade de sugestões.

Método 1: Visual Studio Code

1. Instale a extensão Copilot
   Abra o VS Code, vá para a visualização de Extensões pressionando Ctrl+Shift+X, pesquise por GitHub Copilot e clique em Instalar. Após a instalação, clique no ícone de conta no canto inferior esquerdo e faça login com sua conta do GitHub que possui uma assinatura ativa do Copilot.
2. Abra um arquivo de workflow
   Navegue até a pasta do seu repositório e abra um arquivo dentro do diretório .github/workflows. O arquivo deve ter extensão .yml ou .yaml. O Copilot é ativado automaticamente quando o tipo de arquivo é reconhecido.
3. Escreva um comentário de gatilho
   Em uma nova linha, digite um comentário que descreva o step que você deseja criar. Por exemplo, # Check out the repository code. Pressione Enter. O Copilot sugere a próxima linha ou bloco com base nesse comentário.
4. Aceite ou alterne entre sugestões
   Se o texto fantasma cinza corresponder ao que você precisa, pressione Tab para aceitá-lo. Se quiser ver outras opções, pressione Alt+] para avançar ou Alt+[ para retroceder. Pressione Esc para descartar a sugestão e continuar digitando manualmente.
5. Use o Copilot Chat para workflows completos
   Abra o painel Copilot Chat pressionando Ctrl+Shift+I ou clicando no ícone do Copilot na barra lateral. Digite um prompt como Crie um workflow que execute no push, faça checkout do código, configure Node.js 20 e execute npm test. O Copilot retorna um bloco YAML completo. Copie o bloco e cole-o em seu arquivo de workflow.

Método 2: Editor Web do GitHub

1. Abra o editor web
   Vá para seu repositório no GitHub.com. Pressione a tecla ponto no seu teclado para abrir o editor VS Code baseado na web. O editor inclui o Copilot se sua conta tiver uma assinatura ativa.
2. Navegue até seu arquivo de workflow
   No explorador de arquivos à esquerda, expanda a pasta .github e depois a pasta workflows. Clique no arquivo .yml que deseja editar ou crie um novo arquivo clicando no ícone Novo Arquivo.
3. Comece a digitar ou use um comentário
   Digite algumas linhas de YAML manualmente, como name: e on:. O Copilot sugere as próximas linhas. Alternativamente, digite um comentário como # Build and push Docker image e pressione Enter para obter uma sugestão de várias linhas.
4. Aceite e faça commit
   Pressione Tab para aceitar uma sugestão. Após editar o arquivo, clique no ícone de controle de versão à esquerda, digite uma mensagem de commit e clique em Commit e Push.

Erros Comuns e Limitações

O Copilot nem sempre produz YAML de workflow correto. Você deve verificar o código gerado antes de enviá-lo ao seu repositório.

Copilot Sugere Versões Desatualizadas de Actions

O Copilot aprende com dados históricos de repositórios. Ele pode sugerir actions/checkout@v2 ou actions/setup-node@v1 mesmo que versões principais mais novas existam. Sempre verifique o GitHub Marketplace oficial para a tag de versão mais recente. Substitua o número da versão na sugestão antes de fazer commit.

Erros de Indentação em Sugestões de Múltiplas Linhas

YAML é sensível à indentação. O Copilot às vezes insere espaços extras ou usa níveis de indentação inconsistentes. Se o workflow falhar com um erro de análise YAML, abra o arquivo e verifique se todas as linhas sob uma chave usam o mesmo número de espaços. Dois espaços por nível é a convenção padrão.

Copilot Não Conhece os Segredos do Seu Repositório

O Copilot não pode ler os segredos ou variáveis de ambiente do seu repositório. Ele pode sugerir valores placeholders como YOUR_TOKEN ou my-secret. Substitua-os por nomes reais de segredos usando o contexto secrets, por exemplo ${{ secrets.DEPLOY_KEY }}.

Expressões Complexas Raramente Estão Corretas

Expressões do GitHub Actions usando a sintaxe ${{ }}, como execução condicional de jobs ou filtros de estratégia de matriz, geralmente são geradas incorretamente. O Copilot pode omitir chaves de fechamento, usar nomes de funções errados ou criar sintaxe inválida. Escreva expressões complexas manualmente e use o Copilot apenas para as partes estruturais do YAML.

Item	Copilot Free	Copilot Pro
Preço mensal	Grátis	US$ 10 por mês
Sugestões inline	Até 2.000 conclusões por mês	Ilimitado
Copilot Chat	Limitado a 50 mensagens de chat por mês	Ilimitado
Compreensão de contexto	Apenas código público	Código de repositórios públicos e privados
Melhor para	Edições ocasionais de workflow	Desenvolvimento diário de workflow

Ambos os planos oferecem suporte aos mesmos recursos de geração de arquivos de workflow. A principal diferença é o número de sugestões e mensagens de chat que você pode usar por mês. Se você edita arquivos de workflow várias vezes ao dia, o Copilot Pro oferece acesso irrestrito.

Agora você pode escrever arquivos de workflow do GitHub Actions com sugestões do Copilot no VS Code ou no editor web do GitHub. Comece instalando a extensão Copilot e abrindo um arquivo de workflow existente. Use prompts baseados em comentários para gerar steps completos e sempre verifique as versões das actions e a indentação antes de fazer commit. Para workflows avançados com expressões complexas, escreva a lógica manualmente e use o Copilot apenas para a estrutura YAML.