Automatizar Comentários em PRs para Garantir que as Issues sejam Linkadas e Fechadas #473
Description
Descrição
Atualmente, não há um processo automatizado que verifique se uma issue está vinculada corretamente à descrição de um PR. Isso pode ser feito automaticamente com a adição de um comentário no PR, caso a descrição não contenha uma das palavras-chave necessárias para vincular uma issue, como closes #<numero_da_issue>, fixes #<numero_da_issue>, ou resolves #<numero_da_issue>.
A automação deve verificar o PR assim que ele for aberto ou atualizado e, caso não encontre a vinculação correta na descrição, deve deixar um comentário explicando o que precisa ser feito, tanto em português quanto em inglês.
O que deve ser feito
- Criar um workflow no GitHub Actions que rode quando um PR for aberto ou atualizado.
- O workflow deve verificar a descrição do PR, procurando por palavras-chave de vinculação de issue.
- Caso a vinculação não seja encontrada, o workflow deve adicionar um comentário no PR com a explicação sobre como vincular a issue. O comentário deve ser gerado nas duas línguas, português e inglês.
- O workflow não precisa corrigir automaticamente o PR, apenas adicionar o comentário.
Exemplo de possível comentário a ser adicionado:
Fique à vontade para modificar como preferir. Essa é apenas uma sugestão.
🇧🇷🇧🇷🇧🇷
**A descrição do seu PR não menciona o fechamento da issue relacionada.** Para fechar a issue automaticamente quando este PR for mergeado, você pode adicionar um termo como `Fixes #<número-da-issue>` ou `Closes #<número-da-issue>` na descrição.
Isso ajuda a manter o repositório mais organizado e garante que a issue seja fechada automaticamente assim que o código for integrado. Para saber mais sobre como isso funciona, você pode consultar a [documentação oficial do GitHub sobre fechamento automático de issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
Então basta editar a descrição do seu PR clicando em edit
Adicionando a linha:
> Closes #número_da_issue
E finalmente, clicando em update comment:
<img width="149" alt="image" src="https://github.com/user-attachments/assets/234b5981-5031-4f49-a387-bb0b8fe8c359" />
Se precisar de ajuda para fazer isso ou tiver dúvidas, é só avisar! 😊
---
🇬🇧 🇬🇧 🇬🇧
**The description of your PR does not mention closing the related issue.** To close the issue automatically when this PR is merged, you can add a keyword like `Fixes #<issue-number>` or `Closes #<issue-number>` in the description.
This helps keep the repository more organized and ensures that the issue is automatically closed as soon as the code is merged. To learn more about how this works, you can check out the [official GitHub documentation on automatic issue closing](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
Then simply edit your PR description by clicking on "Edit."
Add the line:
> Closes #issue_number
And finally, click "Update Comment":
<img width="149" alt="image" src="https://github.com/user-attachments/assets/234b5981-5031-4f49-a387-bb0b8fe8c359" />
If you need help with this or have any questions, feel free to reach out! 😊
Links úteis
- https://docs.github.com/pt/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
- https://docs.github.com/pt/actions
- https://docs.github.com/pt/actions/writing-workflows/quickstart
Fique à vontade para utilizar GitHub Actions já existentes, caso seja útil.