ROADMAP.md

Roadmap

Scaffold

• Configurar golang
• Adicionar pacote do github api para golang
• Adicionar sdk do github actions para golang
• Adicionar issues no repositório do github

MVP

• Definir regra de negócio para geração do changelog
  • Issues
  • PRs
• Preencher template da documentação baseado nos valores da nova release
  • Issues
  • PRs
• Validações
  • Caso o arquivo não exista, deve cria-lo
  • Se não houver dados na release atual, o changelog não deve ser gerado
  • Se não houver responsável pela PR, adicionar o criador no template do changelog
  • Se for a primeira release, dispensar necessidade da release anterior
• Acrescentar CHANGELOG da nova release no início do arquivo existente
• Transformar o script final em um action

Improvements

• Traduzir arquivos para inglês
• Gerar log do processamento dos passos
• Gerar changelog retroativo
  • Todas as tags
  • De/até tag
• Refatorações
  • Retornar erros corretamente
  • Renomear funções e variáveis corretamente
• Novas features
  • Personalizar changelog (P&D)
  • Adicionar o changelog gerado na descrição da release
• Escolher nome da action
• Adicionar testes unitários e integrados
• Adicionar fluxo de CI/CD
  • Lint
  • Build
  • Testes

Business rule

• Para issue:

  • A data de início deve ser a data de publicação da release anterior
  • A data fim deve ser a data de publicação da próxima release
  • Deve retornar apenas issues fechadas
  • O valor que deve retornar por issue deve ser o título

• Para PR:

  • A data de início deve ser a data de publicação da release anterior
  • A data fim deve ser a data de publicação da próxima release
  • Deve retornar apenas PR mergeado
  • O valor que deve retornar por PR deve ser, inicialmente, o título e, após, o valor do changelog retornado no body