Compatibilidade com versões anteriores

Esta página fornece informações sobre como lidar com a compatibilidade com versões anteriores, incluindo a migração de uma versão para outra e como comunicar mudanças incompatíveis.

O Bazel está evoluindo. As versões secundárias lançadas como parte de uma versão principal de LTS são totalmente compatíveis com versões anteriores. As alterações entre as versões principais de LTS podem conter alterações incompatíveis que exigem algum esforço de migração. Para mais informações sobre como a cadência de lançamento do Bazel funciona, consulte Anúncio das versões de Suporte de longo prazo (LTS) do Bazel.

Resumo

  1. É recomendável usar sinalizações --incompatible_* para alterações interruptivas.
  2. Para cada sinalização --incompatible_*, um problema do GitHub explica a mudança de comportamento e visa fornecer um roteiro de migração.
  3. As APIs e o comportamento protegidos por uma flag --experimental_* podem mudar a qualquer momento.
  4. Nunca execute builds de produção com sinalizações --experimental_* ou --incompatible_*.

Como seguir essa política

O que é uma funcionalidade estável?

Em geral, APIs ou comportamentos sem sinalizações --experimental_... são considerados recursos estáveis e compatíveis no Bazel.

Isso inclui:

  • Linguagem e APIs Starlark
  • Regras incluídas no Bazel
  • APIs do Bazel, como APIs de execução remota ou protocolo de evento de build
  • Sinalizações e a semântica delas

Mudanças incompatíveis e roteiros de migração

Para cada mudança incompatível em uma nova versão, a equipe do Bazel visa fornecer uma receita de migração que ajuda a atualizar seu código (arquivos BUILD e .bzl, bem como qualquer uso do Bazel em scripts, uso da API Bazel e assim por diante).

As alterações incompatíveis precisam ter uma sinalização --incompatible_* associada e um problema correspondente do GitHub.

Informar alterações incompatíveis

A principal fonte de informações sobre mudanças incompatíveis são os problemas do GitHub marcados com um rótulo"incompatible-change".

Para cada alteração incompatível, o problema especifica o seguinte:

  • Nome da sinalização que controla a alteração incompatível
  • Descrição da funcionalidade alterada
  • Receita de migração

Quando uma mudança incompatível estiver pronta para migração com o Bazel em HEAD (portanto, também na próxima versão contínua do Bazel), ela precisa ser marcada com o rótulo migration-ready. O problema de alteração incompatível é encerrado quando a sinalização incompatível é inserida em HEAD.