Flowkits

Versionamento para Flowkits

7min

Introdução ao Versionamento Semântico de Flowkits

Na Fluid, adotamos o Versionamento Semântico 2.0.0 para nossos Flowkits, garantindo uma abordagem clara e consistente na gestão de versões. Esta metodologia ajuda os usuários a compreenderem facilmente as mudanças ocorridas em cada atualização do Flowkit e a tomarem decisões informadas sobre a implementação e a manutenção de seus fluxos de trabalho.

Estrutura de versionamento

O versionamento dos Flowkits é estruturado em três componentes principais: MAJOR.MINOR.PATCH. Cada componente tem um propósito específico:

  • Versão Maior (MAJOR):
    • Indica mudanças significativas que podem causar incompatibilidades com versões anteriores;

Incremente a versão major quando houver alterações substanciais que possam afetar a invocação, funcionalidade ou integridade de algum dos fluxos que compõe este flowkit, como por exemplo: mudança no contrato do payload de entrada ou de response do fluxo.

  • Versão Menor (MINOR):
    • Representa a adição de novas funcionalidades que ainda mantêm a compatibilidade com versões anteriores;

Incremente a versão minor para atualizações que introduzem melhorias ou novas capacidades sem comprometer a operação ou contrato de quem usa algum fluxo desse flowkit.

  • Versão de Correção (PATCH):
    • Utilizada para correções de erros que não afetam a compatibilidade.

Incremente a versão patch quando incluir correções ou melhorias em funcionalidades como transformação de dados com Rules, Template ou De/para, indicando que esta atualização do flowkit deverá ser aplicada para todos que o ativaram.

Extensões ao Formato Básico

Além do formato básico, o versionamento semântico permite o uso de rótulos para pré-lançamentos e metadados de construção. Isso oferece maior flexibilidade e informação sobre o estágio de desenvolvimento e a natureza específica da versão.

Aplicação na Criação e Ativação de Flowkits

Quando você cria ou ativa um Flowkit:

  • Verifique a Versão Atual: Certifique-se de estar utilizando a versão mais adequada para suas necessidades, considerando as mudanças introduzidas em cada nível de versionamento.
  • Mantenha-se Informado: Ao escolher uma versão, leve em conta as possíveis implicações das mudanças na compatibilidade com seus fluxos atuais e necessidades de outros usuários que ativaram este flowkit.
  • Atualização Cuidadosa: Ao atualizar para uma nova versão maior, revise cuidadosamente os detalhes das mudanças para garantir a continuidade e compatibilidade dos seus fluxos.

Conclusão

O versionamento semântico fornece uma estrutura clara e previsível para o gerenciamento de atualizações dos Flowkits. Ao aderir a esta metodologia, buscamos oferecer aos nossos usuários a confiança de que suas integrações e automações continuarão a funcionar de maneira eficaz, mesmo diante de constantes melhorias e evoluções na plataforma Fluid.

Updated 28 Dec 2023
Doc contributor
Doc contributor
Did this page help you?