search

OpenBanking-Brasil / areadesenvolvedor

https://openbanking-brasil.github.io/areadesenvolvedor/
160 stars 66 forks source link

Implantação do novo processo (integrações com repos openapi e draft-openapi) #294

Closed rmGinner closed 2 years ago

rmGinner commented 2 years ago

Foram feitas as seguintes alterações:

Geral

  1. Criada a repository secret AREADEV_INTEGRATION que utiliza um Personal Access Token para realizar as integrações entre os repositórios e ativação de workflow de deploy.

Workflow Build

  1. Alteração do workflow de build, para realizar todo o processo de conversão e disponibilização da estrutura nova nos seus devidos repositórios. (script de automação: yaml2json.rb)
  2. Criado script de automação yaml2json.rb para converter os swaggers atuais nas novas estruturas dos repositórios openapi e draft-openapi.
  3. Movido as validações e compilações dos swaggers que estavam soltas no workflow de build. Agora elas estão centralizadas no arquivo compile-swagger-files.sh.
  4. Criado script de automação para gerar os arquivos index.html usados pelo Swagger para mostrar as versões da API em questão. (script de automação: generate-swagger-ui-html.sh)
  5. Incluído o Action actions/upload-artifact@v2 para fazer o upload dos arquivos validados e compilados no GtiHub.
  6. Incluído o Action benc-uk/workflow-dispatch@v1 para ativar o workflow de deploy assim que o workflow build for concluído.
  7. Criado script de automação git-repository-integration.sh que fará os comandos do Git para enviar a nova estrutura de pastas e arquivos do Swagger aos novos repositórios. (openapi e draft-openapi).
  8. Criado script de automação copy-older-api-versions.sh para converter todos os Swaggers de versões anteriores nas novas estruturas dos repositórios openapi e draft-openapi.
  9. Removido a branch master no trigger de evento push.
  10. Inclusão de validações condicionais para identificar momentos de build e ativação do workflow de deploy.

Workflow Deploy

  1. Removido código duplicado de validações e compilações do swagger no workflow de deploy. Agora os arquivos já validados e compilados, são armazenados no Github pelo workflow de build para que seja possível recuperá-los no workflow de deploy, aumentando assim a performance no momento de deploy.
  2. Incluído o Action dawidd6/action-download-artifact@v2 para realizar o download dos swaggers gerados pelo workflow de build.
  3. Removido trigger de evento de push e adicionado a trigger de evento workflow_dispatch, que será ativado pelo workflow de build.
daninrodrigues commented 2 years ago

@horochovec PR para aprovação.