Retrocompatibilidad

Informar un problema Ver fuente

En esta página, se proporciona información sobre cómo controlar la retrocompatibilidad, incluida la migración de una versión a otra y cómo comunicar los cambios incompatibles.

Bazel está evolucionando. Las versiones secundarias lanzadas como parte de una versión principal de LTS son totalmente retrocompatibles. Es posible que las nuevas versiones importantes de LTS contengan cambios incompatibles que requieran cierto esfuerzo de migración. Para obtener más información sobre el modelo de lanzamiento de Bazel, consulta la página Modelo de lanzamiento.

Resumen

  1. Se recomienda usar marcas --incompatible_* para los cambios rotundos.
  2. Para cada marca --incompatible_*, un problema de GitHub explica el cambio en el comportamiento y tiene como objetivo proporcionar una receta de migración.
  3. Se recomienda que las marcas incompatibles tengan una portabilidad a la versión anterior de LTS sin habilitar la marca de forma predeterminada.
  4. Las APIs y el comportamiento protegidos por una marca --experimental_* pueden cambiar en cualquier momento.
  5. Nunca ejecutes compilaciones de producción con las marcas --experimental_* o --incompatible_*.

Cómo cumplir con esta política

¿Qué es la funcionalidad estable?

En general, las APIs o los comportamientos sin marcas --experimental_... se consideran funciones estables y compatibles en Bazel.

Esto incluye lo siguiente:

  • Lenguaje y APIs de Starlark
  • Reglas agrupadas con Bazel
  • APIs de Bazel, como las APIs de Remote Execution o el Protocolo de eventos de compilación
  • Marcas y su semántica

Cambios incompatibles y recetas de migración

Para cada cambio incompatible en una versión nueva, el equipo de Bazel tiene como objetivo proporcionar una receta de migración que te ayude a actualizar el código (archivos BUILD y .bzl, así como cualquier uso de Bazel en secuencias de comandos, uso de la API de Bazel, etc.).

Los cambios incompatibles deben tener una marca --incompatible_* asociada y un problema de GitHub correspondiente.

Se recomienda que la marca incompatible y los cambios relevantes tengan portabilidad a versiones anteriores de la versión de LTS más reciente sin habilitar la marca de forma predeterminada. Esto permite a los usuarios migrar para los cambios incompatibles antes de que esté disponible la próxima versión de LTS.

Cómo comunicar cambios incompatibles

La fuente principal de información sobre los cambios incompatibles son los problemas de GitHub marcados con una etiqueta “incompatible-change”.

Para cada cambio incompatible, el problema especifica lo siguiente:

  • Nombre de la marca que controla el cambio incompatible
  • Descripción de la funcionalidad modificada
  • Receta de migración

Cuando un cambio incompatible esté listo para la migración con Bazel en el encabezado (por lo tanto, también con la próxima versión progresiva de Bazel), se debe marcar con la etiqueta migration-ready. El problema de cambio incompatible se cierra cuando la marca incompatible se gira en HEAD.