Skip to main content

Comentar em um problema quando uma etiqueta é adicionada

Você pode usar GitHub Actions para comentar automaticamente nos problema quando uma etiqueta específica é aplicada.

Introdução

Este tutorial demonstra como usar a açãopeter-evans/create-or-update-comment para adicionar um comentário a um problema quando um rótulo específico é aplicado. Por exemplo, quando o rótulo help-wanted é adicionado a um problema, você pode adicionar um comentário para incentivar os colaboradores a trabalhar no problema.

No tutorial, primeiro, você criará um arquivo de fluxo de trabalho que usa a ação peter-evans/create-or-update-comment. 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
    # Esse fluxo de trabalho usa ações que não são certificadas pelo GitHub.
    # São fornecidas por terceiros e regidas por
    # termos de serviço, política de privacidade e suporte separados
    # online.
    
    # O GitHub recomenda fixar ações em um SHA de commit.
    # Para obter uma versão mais recente, você precisará atualizar o SHA.
    # Você também pode fazer referência a uma marca ou branch, mas a ação pode ser alterada sem aviso.
    
    name: Add comment
    on:
      issues:
        types:
          - labeled
    jobs:
      add-comment:
        if: github.event.label.name == 'help-wanted'
        runs-on: ubuntu-latest
        permissions:
          issues: write
        steps:
          - name: Add comment
            uses: peter-evans/create-or-update-comment@a35cf36e5301d70b76f316e867e7788a55a31dae
            with:
              issue-number: ${{ github.event.issue.number }}
              body: |
                This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles:
  4. Personalize os parâmetros no seu arquivo do fluxo de trabalho:

    • Substitua help-wanted em if: github.event.label.name == 'help-wanted' pelo rótulo no qual deseja trabalhar. Caso deseje trabalhar em mais de um rótulo, separe as condições com ||. Por exemplo, if: github.event.label.name == 'bug' || github.event.label.name == 'fix me' adicionará um comentário sempre que os rótulos bug ou fix me forem adicionados a um problema.
    • Altere o valor de body para o comentário que deseja adicionar. Markdown em estilo GitHub é compatível. Para obter mais informações sobre o markdown, confira "Sintaxe básica de escrita e formatação".
  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 repositório for identificado, esse fluxo de trabalho será executado. Se o rótulo adicionado for um dos rótulos especificados no arquivo de fluxo de trabalho, a ação peter-evans/create-or-update-comment adicionará o comentário especificado ao problema.

Teste seu fluxo de trabalho aplicando a sua etiqueta especificada a um problema.

  1. Abra um problema no seu repositório. Para obter mais informações, confira "Como criar um problema".
  2. Etiquete o problema com a etiqueta especificada no seu arquivo de fluxo de trabalho. Para obter mais informações, confira "Como gerenciar rótulos".
  3. Para ver a execução do fluxo de trabalho acionada etiquetando 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".
  4. Quando o fluxo de trabalho é concluído, o problema que você etiquetou deve ter um comentário adicionado.

Próximas etapas