Guía para implementar cambios rotundos

Es inevitable que hagamos cambios rotundos en Bazel. Tendremos que cambiar nuestros diseños y corregir lo que no funciona bien. Sin embargo, debemos asegurarnos de que la comunidad y el ecosistema de Bazel puedan seguir el ritmo. Para ello, el proyecto de Bazel adoptó una política de retrocompatibilidad. En este documento, se describe el proceso para que los colaboradores de Bazel realicen un cambio rotundo en Bazel para cumplir con esta política.

1. Sigue la política del documento de diseño.

2. Informa un problema de GitHub.

3. Implementa el cambio.

4. Actualiza las etiquetas.

5. Voltea la marca incompatible.

Problema de GitHub

Informa un problema de GitHub en el repositorio de Bazel. Consulta el ejemplo.

Te recomendamos lo siguiente:

• El título comienza con el nombre de la marca (el nombre de la marca comenzará con incompatible_).

• Agrega la etiqueta incompatible-change.

• La descripción contiene una descripción del cambio y un vínculo a los documentos de diseño pertinentes.

• La descripción contiene una receta de migración para explicar a los usuarios cómo deben actualizar su código. Lo ideal es que, cuando el cambio sea mecánico, incluyas un vínculo a una herramienta de migración.

• La descripción incluye un ejemplo del mensaje de error que recibirán los usuarios si no migran. Esto hará que el problema de GitHub sea más fácil de descubrir desde los motores de búsqueda. Asegúrate de que el mensaje de error sea útil y práctico. Cuando sea posible, el mensaje de error debe incluir el nombre de la marca incompatible

Para la herramienta de migración, considera contribuir a Buildifier. Puede aplicar correcciones automatizadas a los archivos BUILD, WORKSPACE y .bzl. También puede informar advertencias.

Implementación

Crea una marca nueva en Bazel. El valor predeterminado debe ser falso. El texto de ayuda debe contener la URL del problema de GitHub. Como el nombre de la marca comienza con incompatible_, necesita etiquetas de metadatos:

      metadataTags = {
        OptionMetadataTag.INCOMPATIBLE_CHANGE,
      },

En la descripción de la confirmación, agrega un breve resumen de la marca. También agrega RELNOTES: en el siguiente formulario: RELNOTES: --incompatible_name_of_flag has been added. See #xyz for details

La confirmación también debe actualizar la documentación pertinente para que no haya una ventana de confirmaciones en la que el código no sea coherente con los documentos. Como nuestra documentación tiene versiones, los cambios en los documentos no se lanzarán de forma inadvertida antes de tiempo.

Etiquetas

Una vez que se combine la confirmación y el cambio incompatible esté listo para adoptarse, agrega la etiqueta migration-ready al problema de GitHub.

Si se encuentra un problema con la marca y no se espera que los usuarios migren todavía: quita las marcas migration-ready.

Si planeas voltear la marca en la próxima versión principal, agrega la etiqueta `breaking-change-X.0" al problema.

Actualizar repositorios

Bazel CI prueba una lista de proyectos importantes en Bazel@HEAD + Downstream. La mayoría de ellos suelen ser dependencias de otros proyectos de Bazel, por lo que es importante migrarlos para desbloquear la migración para la comunidad más amplia.

Para supervisar el estado de migración de esos proyectos, puedes usar la bazelisk-plus-incompatible-flags canalización, consulta cómo funciona esta canalización aquí.

La migración de proyectos en la canalización descendente NO es responsabilidad exclusiva del autor del cambio incompatible. Sin embargo, puedes hacer lo siguiente para acelerar la migración y facilitar la vida de los usuarios de Bazel y del equipo de Bazel Green.

1. Informa problemas de GitHub para notificar a los propietarios de los proyectos descendentes que se interrumpieron debido a tu cambio incompatible.
2. Envía solicitudes de extracción para corregir proyectos descendentes.
3. Comunícate con la comunidad de Bazel para obtener ayuda con la migración (p.ej., SIG de autores de reglas de Bazel).

Voltear la marca

Antes de voltear el valor predeterminado de la marca a verdadero, asegúrate de lo siguiente:

• Se migran los repositorios principales del ecosistema.

  En la canalización bazelisk-plus-incompatible-flags, la marca debe aparecer en The following flags didn't break any passing Bazel team owned/co-owned projects.

• Se resolvieron las preguntas y las inquietudes de los usuarios.

Cuando la marca esté lista para voltearse en Bazel, pero esté bloqueada en la migración interna en Google, considera establecer el valor de la marca en falso en el archivo blazerc interno para desbloquear el volteo de la marca. De esta manera, podemos garantizar que los usuarios de Bazel dependan del nuevo comportamiento de forma predeterminada lo antes posible.

Cuando cambies el valor predeterminado de la marca a verdadero, haz lo siguiente:

• Usa RELNOTES[INC] en la descripción de la confirmación, con el siguiente formato: RELNOTES[INC]: --incompatible_name_of_flag is flipped to true. See #xyz for details Puedes incluir información adicional en el resto de la descripción de la confirmación.
• Usa Fixes #xyz en la descripción para que se cierre el problema de GitHub cuando se combine la confirmación.
• Revisa y actualiza la documentación si es necesario.
• Informa un nuevo problema #abc para hacer un seguimiento de la eliminación de la marca.

Quitar la marca

Después de que se voltee la marca en HEAD, se debe quitar de Bazel. Cuando planees quitar la marca incompatible, haz lo siguiente:

• Considera dejar más tiempo para que los usuarios migren si se trata de un cambio incompatible importante. Lo ideal es que la marca esté disponible en al menos una versión principal.
• Para la confirmación que quita la marca, usa Fixes #abc en la descripción para que se cierre el problema de GitHub cuando se combine la confirmación.