Skip to main content

Adicionando etiquetas a problemas

Você pode usar GitHub Actions para etiquetar problemas automaticamente.

Introdução

Este tutorial demonstra como usar a ação actions/github-script em um fluxo de trabalho para rotular os 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.

A ação actions/github-script permite que você use facilmente a API do GitHub em um fluxo de trabalho.

No tutorial, primeiro, você criará um arquivo de fluxo de trabalho que usa a ação actions/github-script. 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 "Como 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 "Como 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:
          - uses: actions/github-script@v6
            with:
              script: |
                github.rest.issues.addLabels({
                  issue_number: context.issue.number,
                  owner: context.repo.owner,
                  repo: context.repo.repo,
                  labels: ["triage"]
                })
  4. Personalize o parâmetro script no seu arquivo do fluxo de trabalho:

    • Os valores issue_number, owner e repo são definidos automaticamente com o objeto context. Não é necessário alterar esses padrões.
    • Altere o valor de labels para a lista de rótulos que deseja adicionar ao problema. Separe etiquetas múltiplas com vírgulas. Por exemplo, ["help wanted", "good first issue"]. Para obter mais informações sobre rótulos, confira "Como gerenciar rótulos".
  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 "Como 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 obter mais informações, confira "Como 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 obter mais informações, confira "Como ver 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