Adicionando etiquetas a problemas

Introdução

Este tutorial demonstra como usar o GitHub CLI em um fluxo de trabalho para identificar problemas recém-abertos ou reabertos. Por exemplo, você pode adicionar o rótulo triage sempre que um problema é aberto ou reaberto. Em seguida, veja todos os problemas que precisam ser triagem filtrando os problemas com o rótulo triage.

O GitHub CLI permite que você use facilmente a API GitHub em um fluxo de trabalho.

No tutorial, primeiro você criará um arquivo de fluxo de trabalho que usa o GitHub CLI. Então, você personalizará o fluxo de trabalho para atender às suas necessidades.

Criar o fluxo de trabalho

1. Escolha um repositório onde você deseja aplicar este fluxo de trabalho de gerenciamento de projetos. Você pode usar um repositório existente ao qual você tem acesso de gravação ou criar um novo repositório. Para obter mais informações sobre como criar um repositório, confira "Criar um repositório".

2. No repositório, crie um arquivo chamado .github/workflows/YOUR_WORKFLOW.yml, substituindo YOUR_WORKFLOW por um nome de sua escolha. Este é um arquivo do fluxo de trabaho. Para obter mais informações sobre como criar arquivos no GitHub, confira "Criar arquivos".

3. Copie o seguinte conteúdo YAML para o arquivo do fluxo de trabalho.

   YAML

   name: Label issues
   on:
     issues:
       types:
         - reopened
         - opened
   jobs:
     label_issues:
       runs-on: ubuntu-latest
       permissions:
         issues: write
       steps:
         - run: gh issue edit "$NUMBER" --add-label "$LABELS"
           env:
             GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             GH_REPO: ${{ github.repository }}
             NUMBER: ${{ github.event.issue.number }}
             LABELS: triage
   

4. Personalize os valores env no seu arquivo de fluxo de trabalho:

   • Os valores GH_TOKEN, GH_REPO e NUMBER são configurados automaticamente usando os contextos github e secrets. Não é necessário alterar esses padrões.
   • Altere o valor de LABELS para a lista de rótulos que deseja adicionar ao problema. O(s) rótulo(s) deve(m) existir em seu repositório. Separe etiquetas múltiplas com vírgulas. Por exemplo, help wanted,good first issue. Para saber mais sobre rótulos, confira Gerenciar etiquetas.

5. Faça o commit do arquivo de fluxo de trabalho para o branch padrão do seu repositório. Para obter mais informações, confira "Criar arquivos".

Testar o fluxo de trabalho

Toda vez que um problema no seu repositório for aberto ou reaberto, esse fluxo de trabalho adicionará as etiquetas que você especificou ao problema.

Teste o seu fluxo de trabalho criando um problema no seu repositório.

1. Crie um problema no seu repositório. Para saber mais, confira Criar um problema.
2. Para ver a execução do fluxo de trabalho que foi acionada criando o problema, veja o histórico de execuções do seu fluxo de trabalho. Para saber mais, confira Visualizar o histórico de execução do fluxo de trabalho.
3. Quando o fluxo de trabalho é concluído, o problema que você criou deve ter as etiquetas especificadas adicionadas.

Próximas etapas

• Para aprender mais sobre ações adicionais que você pode executar com o GitHub CLI, consulte o manual da CLI do Github.
• Para saber mais sobre diferentes eventos que podem disparar seu fluxo de trabalho, confira Eventos que disparam fluxos de trabalho.
• Pesquise o GitHub para ver exemplos de fluxos de trabalho que usam gh issue edit.