Versionar API (compatível as versões do app)

[fernandascovino]

Motivo

Versionar é sempre melhor para mapear o projeto ao longo do tempo.

Como será feito

Resumo

• Versão MAJOR (e.g. 1.0.0) será a mesma que o frontend (app) pois eles dependem entre si.

• Versão MINOR (e.g. 1.1.0) para qualquer recurso novo ou alterado que seja retrocompatível.

• Versão PATCH (e.g. 1.1.1) para qualquer tipo de correção de erros ou alteração de README e arquivos sem importância.

Detalhes

MAJOR

• Planejamento prévio entre ambos projetos sobre como será a nova versão, qual o objetivo e o que deve mudar de impactante.

  A nova versão será criada a partir da versão atual, e mudanças serão aplicadas como MINOR ou PATCH.

• Usar o primeiro commit na branch principal que atende os requisitos para a nova versão MAJOR do frontend.

  A data do commit deve ser a mais próxima possível da publicação da MAJOR do frontend.

MINOR

• Adicionar, alterar ou remover qualquer funcionalidade dentro do contexto e retrocompatível com a MAJOR.

PATCH

• Quaisquer correções de erros
• Qualquer alteração em documentação em geral, como jupyter, README.

  Normalmente essas alterações são enviadas junto com atualizações MAJOR ou MINOR.

Tarefas

• Mapear versão 2.0

  • Concluído em 07/02/2023

    O commit b4378b2 staging > main - mudança no modelo, criação de ambiente local e endpoints é o commit mais antigo que o frontend v2.0 consegue utilizar. Pois ele cria a URI gtfs/<endpoint>.

• Mapear versões 2.x.x

  • Concluído em 15/02/2023

    O commit 9dcf808 [feat] filtro shape_id em gtfs/shapes > main é o único commit mais atual da branch main.

• Lançar Releases 2.x.x

• Mapear versões 1.x.x

  Serve para entender a lógica do projeto desde a gestão anterior.

  • (16/02/2022) As versões foram mapeadas. Foi decidido com a equipe que é interessante usar, porém a versão começaria de 1.1.0. (veja o comentário)

    Portanto o mapeamento será revisado, e subversões de main terão descrição mais detalhada sobre o que mudou.

---

Referências:

• https://semver.org/
• https://medium.com/fiverr-engineering/major-minor-patch-a5298e2e1798

[yxuo]

As versões 1.x.x (todas até a 2.0.0) foram mapeadas também.

Caso seja interessante, as tags serão criadas no projeto:

Versão	Data	Descrição	Commit	Comparação
1.0.0	02/07/2021	Primeiro commit	2b16f02	-
1.1.0	19/01/2022	Pronto para prod	8f21fde	1.0 vs 1.1
1.2.0	08/12/2022	Workflows, kubernetes, fixtures	d68bc5b	1.1 vs 1.2