pagarme / superbowleto

:football: A microservice to issue, register and manage boletos
MIT License
5 stars 0 forks source link

Add catalog-info.yaml #367

Closed resource-manifest-app-pagame[bot] closed 1 year ago

resource-manifest-app-pagame[bot] commented 2 years ago

Olá! Este é o Projeto Planilha ZERO!!!

Não conhece ainda? A gente explica pra você! Com o objetivo de parar de pedirmos para vocês preencherem planilhas durante o ano para fazer Mapping Sistêmico/IT Assessment, aderimos a solução Resource Manifest que é um arquivo .yaml adicionado ao repositório de cada aplicação, assim teremos todo o mapeamento das apps direto pelo Github!!!

Quer entender mais no detalhe? Preparamos uma[documentação](https: // stonepayments.atlassian.net/wiki/spaces/GGDT/pages/2912551011/Resource+Manifest+V1) no confluence explicando mais sobre o projeto e o que deve ser preenchido em cada campo.

Agora que você já tem toda a informação, bora lá?!? O PR que você está recebendo no seu repositório adiciona um catalog-info.yaml com informações default ou de mappings anteriores, na raiz do seu projeto. Como as informações iniciais podem estar todas default ou desatualizadas, é super importante parar aquele tempinho e pensar com carinho nas informações que devem ser preenchidas. Você não precisa ter todos os dados agora, mas esse PR é só pra você não esquecer;) o ideal é tá com isso preenchidinho antes do seu primeiro deploy.

Validação Após realizar o preenchimento das informações de sua aplicação, caso fique na dúvida se está tudo certinho com o seu arquivo catalog-info.yaml, criamos dois jeitinhos marotos de você fazer a validação do seu arquivo.

  1. Temos nosso resource-manifest-app < kbd > bot < /kbd > , que válida os arquivo desde na criação e vai comentando no PR um update da validação do arquivo, se ficou algo pendente ou coisa do tipo.
  2. Clicando[aqui](https: // resource-manifest-app-antjz4nqqa-ue.a.run.app/docs/), você terá duas opções de validar seu arquivo: GET - /validate: Inserindo a branch, o repositório e o owner(organização do github) da aplicação. POST - /validate/file: Adicionando o arquivo da sua própria máquina. Escolha a opção que irá querer fazer a validação e clique em < kbd > Try it out < /kbd > .

Concluíndo... Por fim, ficaremos super felizes com o seu feedback, lembrando que essa é nossa primeira versão e que será ÓTIMO ter um retorno de vocês: sorriso_olhos_sorrindo: . E para dúvidas/feedbacks podem mandar msg no canal(INCLUIR O CANAL QUE CRIAREMOS PARA ESSA FINALIDADE). Obrigado, Times GRC e Security

GitCop commented 2 years ago

There were the following issues with your Pull Request

Check out our Git Style Guide here: https://github.com/pagarme/git-style-guide


This message was auto-generated by https://gitcop.com

GitCop commented 2 years ago

There were the following issues with your Pull Request

Check out our Git Style Guide here: https://github.com/pagarme/git-style-guide


This message was auto-generated by https://gitcop.com

GitCop commented 2 years ago

There were the following issues with your Pull Request

Check out our Git Style Guide here: https://github.com/pagarme/git-style-guide


This message was auto-generated by https://gitcop.com