Versionamento para Flowkits
Versionamento para Flowkits
A Fluid adota o Versionamento Semântico (SemVer) para Flowkits. Isso garante que criadores e consumidores de Flowkits tomem decisões informadas sobre quando atualizar e quais impactos esperar.
Criando um Flowkit? Use esta página para decidir quando incrementar cada componente da versão.
Ativando um Flowkit? Use esta página para entender o que mudou entre versões antes de atualizar uma ativação existente. Consulte também Ativando pelo Console.
Estrutura de versão
A versão de um Flowkit segue o formato major.minor.patch:
Quando incrementar cada componente
Major — mudanças que quebram compatibilidade
Incremente o major quando houver alterações que possam afetar quem já ativou o Flowkit — ou seja, quando a atualização exigir ação por parte do consumidor para continuar funcionando.
Exemplos:
- Mudança no contrato do payload de entrada ou de resposta de um fluxo
- Remoção de um fluxo que fazia parte do Flowkit
- Alteração de um parâmetro obrigatório que muda o comportamento esperado
Minor — novas funcionalidades compatíveis com versões anteriores
Incremente o minor quando adicionar melhorias ou novos fluxos sem comprometer o que já está em uso.
Exemplos:
- Adição de um novo fluxo ao Flowkit
- Novo parâmetro opcional
- Suporte a um conector adicional
Patch — correções sem impacto na compatibilidade
Incremente o patch para correções de erros ou ajustes em transformações de dados, condições e mapeamentos que não afetam a interface do Flowkit com os sistemas integrados.
Exemplos:
- Correção em um passo de transformação de dados
- Ajuste em lógica de condição sem alterar o contrato
- Melhoria de performance interna em um fluxo
Boas práticas para criadores
- Sempre verifique se a mudança afeta quem já ativou o Flowkit antes de decidir o tipo de incremento
- Documente as mudanças de cada versão na seção de documentação do Flowkit
- Prefira minor e patch sempre que possível — versões major geram fricção para os consumidores
- Em atualizações major, considere manter a versão anterior disponível por um período de transição
Boas práticas para consumidores
- Antes de atualizar uma ativação para uma nova versão major, leia a documentação do Flowkit e valide em homologação
- Versões minor e patch são geralmente seguras de atualizar sem revisão aprofundada
- Mantenha um registro de qual versão está ativa em cada workspace para facilitar troubleshooting