Registros de Bazel

Bzlmod descubre las dependencias solicitando su información a los registros de Bazel: bases de datos de módulos de Bazel. Actualmente, Bzlmod solo admite registros de índices, directorios locales o servidores HTTP estáticos que siguen un formato específico.

Registro de índices

Un registro de índice es un directorio local o un servidor HTTP estático que contiene información sobre una lista de módulos, incluida su página principal, los responsables de mantenimiento, el archivo MODULE.bazel de cada versión y cómo recuperar la fuente de cada versión. En particular, no es necesario que publique los archivos de origen.

Un registro de índice debe seguir el siguiente formato:

• /bazel_registry.json: Es un archivo JSON que contiene metadatos del registro, como los siguientes:
  • mirrors: Especifica la lista de espejos que se usarán para los archivos de origen. La URL reflejada es una concatenación del espejo en sí y la URL de origen del módulo especificada por su archivo source.json sin el protocolo. Por ejemplo, si la URL de origen de un módulo es https://foo.com/bar/baz y mirrors contiene ["https://mirror1.com/", "https://example.com/mirror2/"], las URLs que Bazel intentará en orden son https://mirror1.com/foo.com/bar/baz, https://example.com/mirror2/foo.com/bar/baz y, por último, la URL de origen original https://foo.com/bar/baz.
  • module_base_path: Especifica la ruta de acceso base para los módulos con el tipo local_repository en el archivo source.json.
• /modules: Es un directorio que contiene un subdirectorio para cada módulo en este registro.
• /modules/$MODULE: Es un directorio que contiene un subdirectorio para cada versión de este módulo, así como lo siguiente:
  • metadata.json: Es un archivo JSON que contiene información sobre el módulo, con los siguientes campos:
    • homepage: Es la URL de la página principal del proyecto.
    • maintainers: Es una lista de objetos JSON, cada uno de los cuales corresponde a la información de un encargado del módulo en el registro. Ten en cuenta que esto no es necesariamente lo mismo que los autores del proyecto.
    • versions: Es una lista de todas las versiones de este módulo que se encuentran en este registro.
    • yanked_versions: Un mapa de las versiones eliminadas de este módulo. Las claves deben ser versiones para quitar y los valores deben ser descripciones de por qué se quita la versión, lo ideal es que contengan un vínculo a más información.
• /modules/$MODULE/$VERSION: Es un directorio que contiene los siguientes archivos:
  • MODULE.bazel: Es el archivo MODULE.bazel de esta versión del módulo.
  • source.json: Es un archivo JSON que contiene información para recuperar la fuente de esta versión del módulo.
    • El tipo predeterminado es “archive”, que representa un repositorio http_archive, con los siguientes campos:
      • url: Es la URL del archivo de origen.
      • integrity: La suma de comprobación de integridad de subrecursos del archivo
      • strip_prefix: Es un prefijo de directorio que se quita cuando se extrae el archivo fuente.
      • patches: Es un mapa que contiene archivos de parches para aplicar al archivo extraído. Los archivos de parches se encuentran en el directorio /modules/$MODULE/$VERSION/patches. Las claves son los nombres de los archivos de parches, y los valores son la suma de comprobación de integridad de los archivos de parches.
      • patch_strip: Es igual que el argumento --strip de Unix patch.
      • archive_type: Es el tipo de archivo del archivo descargado (es igual que type en http_archive). De forma predeterminada, el tipo de archivo se determina a partir de la extensión de archivo de la URL. Si el archivo no tiene extensión, puedes especificar de forma explícita una de las siguientes opciones: "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", "tar.zst", "tzst", tar.bz2, "ar" o "deb".
    • El tipo se puede cambiar para usar un repositorio de git, con estos campos:
      • type: git_repository
      • Los siguientes campos, como se describe en https://bazel.build/rules/lib/repo/git:
        • remote
        • commit
        • shallow_since
        • tag
        • init_submodules
        • verbose
        • strip_prefix
    • El tipo se puede cambiar para usar una ruta de acceso local, que representa un repositorio local_repository, con estos campos:
      • type: local_path
      • path: Es la ruta de acceso local al repositorio, que se calcula de la siguiente manera:
        • Si path es una ruta de acceso absoluta, permanecerá como está.
        • Si path es una ruta relativa y module_base_path es una ruta absoluta, se resuelve en <module_base_path>/<path>.
        • Si path y module_base_path son rutas relativas, se resuelve en <registry_path>/<module_base_path>/<path>. El registro se debe alojar de forma local y --registry=file://<registry_path> debe usarlo. De lo contrario, Bazel arrojará un error.
  • patches/: Es un directorio opcional que contiene archivos de parches y solo se usa cuando source.json tiene el tipo "archive".