Agendar a criação de problemas

Introdução

Este tutorial demonstra como usar a ação imjohnbo/issue-bot para criar um problema regularmente. Por exemplo, você pode criar um problema toda semana para usar como agenda para uma reunião de equipe.

No tutorial, primeiro, você criará um arquivo de fluxo de trabalho que usa a ação imjohnbo/issue-bot. 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: Weekly Team Sync
   on:
     schedule:
       - cron: 20 07 * * 1
   
   jobs:
     create_issue:
       name: Create team sync issue
       runs-on: ubuntu-latest
       permissions:
         issues: write
       steps:
         - name: Create team sync issue
           uses: imjohnbo/issue-bot@3daae12aa54d38685d7ff8459fc8a2aee8cea98b
           with:
             assignees: "monalisa, doctocat, hubot"
             labels: "weekly sync, docs-team"
             title: "Team sync"
             body: |
               ### Agenda
   
               - [ ] Start the recording
               - [ ] Check-ins
               - [ ] Discussion points
               - [ ] Post the recording
                       
               ### Discussion Points
               Add things to discuss below
   
               - [Work this week](https://github.com/orgs/github/projects/3)
             pinned: false
             close-previous: false
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

4. Personalize os parâmetros no seu arquivo do fluxo de trabalho:

   • Altere o valor de on.schedule para determinar quando deseja executar esse fluxo de trabalho. No exemplo acima, o fluxo de trabalho será executado todas as segundas � s 7h20 UTC. Para obter mais informações sobre os fluxos de trabalho agendados, confira "Eventos agendados".
   • Altere o valor de assignees para a lista de nomes de usuário do GitHub que você deseja atribuir ao problema.
   • Altere o valor de labels para a lista de rótulos que você deseja aplicar ao problema.
   • Altere o valor de title para o título que você deseja que o problema tenha.
   • Altere o valor de body para o texto desejado no corpo do problema. O caractere | permite que você use um valor de várias linhas para esse parâmetro.
   • Caso deseje fixar esse problema no seu repositório, defina pinned como true. Para obter mais informações sobre os problemas fixos, confira "Como fixar um problema no seu repositório".
   • Caso deseje fechar o problema anterior gerado por esse fluxo de trabalho sempre que um problema é criado, defina close-previous como true. O fluxo de trabalho fechará o problema mais recente que tem os rótulos definidos no campo labels. Para evitar o fechamento do problema errado, use uma etiqueta exclusiva ou uma combinação de 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 "Como criar arquivos".

Resultados esperados

Com base no parâmetro schedule (por exemplo, todas as segundas-feiras � s 7h20 UTC), o fluxo de trabalho criará um problema com os destinatários, os rótulos, o título e o corpo especificados. Se você definir pinned como true, o fluxo de trabalho fixará o problema no seu repositório. Se você definir close-previous como true, o fluxo de trabalho fechará o problema mais recente com os rótulos correspondentes.

Você pode visualizar o histórico de execução do fluxo de trabalho para ver a execução deste fluxo de trabalho periodicamente. Para obter mais informações, confira "Como ver o histórico de execução do fluxo de trabalho".

Próximas etapas

• Para saber mais sobre outras coisas que você pode fazer com a ação imjohnbo/issue-bot, como girar destinatários ou usar um modelo de problema, confira a documentação da ação imjohnbo/issue-bot.
• Pesquise o GitHub para ver exemplos de fluxos de trabalho que usam essa ação.