Comentar em um problema quando uma etiqueta é adicionada

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

Observação: Executores hospedados em GitHub não são atualmente compatíveis com GitHub Enterprise Server. Você pode ver mais informações sobre suporte futuro planejado no Itinerário público do GitHub.

Introdução

Este tutorial demonstra como usar a ação peter-evans/create-or-update-comment para comentar em um problema quando uma etiqueta específica é aplicada. Por exemplo, quando a etiqueta help-wanted é adicionada a um problema, você pode adicionar um comentário para incentivar os contribuidores a trabalhar no problema.

No tutorial, primeiro você vai 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, consulte "Criar um repositório".

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

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

    YAML
    # This workflow uses actions that are not certified by GitHub.
    # São fornecidas por terceiros e regidas por
    # termos de serviço, política de privacidade e suporte separados
    # documentação.
    
    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. **Certifique-se de fazer referência a esse problema no seu pull request.** :sparkles: Obrigado pela sua contribuição! :sparkles:
  4. Personalize os parâmetros no seu arquivo do fluxo de trabalho:

    • Substitua help-wanted em if: github.event.label.name == 'help-wanted' pela etiqueta na qual você deseja agir. Se você desejar atuar em mais de uma etiqueta, separe as condições com ||. Por exemplo, if: github.event.label.name == 'bug' ➜ github.event.label. ame == 'corrija-me' irá comentar sempre que as etiquetas bug ou fix me forem adicionadas a um problema.
    • Altere o valor de texto para o comentário que você deseja adicionar. Markdown em estilo GitHub é compatível. Para obter mais informações sobre markdown, consulte "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, consulte "Criar arquivos".

Testar o fluxo de trabalho

Toda vez que um problema no repositório for identificado, esse fluxo de trabalho será executado. Se a etiqueta que foi adicionada for uma das etiquetas que você especificou no seu arquivo de fluxo de trabalho, a ação peter-evans/create-or-update-comment irá adicionar o comentário que você especificou para o 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, consulte "Criar um problema".
  2. Etiquete o problema com a etiqueta especificada no seu arquivo de fluxo de trabalho. Para obter mais informações, consulte "Gerenciar etiquetas".
  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, consulte "Visualizar histórico de execução de 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

  • Para saber outras coisas, você pode fazer com a ação peter-evans/create-or-update-comment, como adicionar reações, acesse a documentação de ação peter-evans/create-or-update-comment.

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.