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ê vai 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, 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: 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.schagen para ditar quando você deseja que este fluxo de trabalho seja executado. No exemplo acima, o fluxo de trabalho será executado todas as segundas às 7h20 UTC. Para obter mais informações sobre fluxos de trabalho agendados, consulte "Eventos agendados".
   • Altere o valor de responsáveis para a lista de nomes de usuário de GitHub que você deseja atribuir ao problema.
   • Altere o valor das etiquetas de `` para a lista de etiquetas que você deseja aplicar ao problema.
   • Altere o valor do título para o título que você deseja que o problema tenha.
   • Altere o valor do texto para o texto que você quer no texto do problema. O caractere | permite que você use um valor de linhas múltiplas para este parâmetro.
   • Se quiser fixar este problema no seu repositório, defina fixado como verdadeiro. Para obter mais informações sobre problemas fixos, consulte "Fixar um problema no seu repositório".
   • Se você deseja fechar o problema anterior gerado por este fluxo de trabalho, cada vez que um novo problema for criado, defina close-previous como verdadeiro. O fluxo de trabalho fechará o problema mais recente que tem as etiquetas definidas no campo de etiquetas. 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, consulte "Criar arquivos".

Resultados esperados

Baseado no parâmetro agendar (por exemplo, toda segunda-feira às 7h20 UTC), seu fluxo de trabalho criará um novo problema com os responsáveis, etiquetas, título e texto que você especificou. Se você definir fixado como verdadeiro, o fluxo de trabalho irá fixar o problema no repositório. Se você definir close-previous como verdadeiro, o fluxo de trabalho fechará o problema mais recente com etiquetas 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, consulte "Visualizar histórico de execução de fluxo de trabalho".

Próximas etapas

• Para saber mais sobre coisas adicionais que você pode fazer com a ação imjohnbo/issue-bot, como girar responsáveis ou usar um modelo de problema, consulte a documentação da ação imjohnbo/issue-bot.
• Pesquise no GitHub exemplos de fluxos de trabalho que usam esta ação.