Ya comenzó el registro para BazelCon 2024

Se usó la API de Cloud Translation para traducir esta página.

Reglas del lugar de trabajo

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Las reglas de Workspace se usan para extraer dependencias externas, por lo general, código fuente ubicado fuera del repositorio principal.

Nota: Además de las reglas de espacio de trabajo nativas, Bazel también incorpora varias reglas de espacio de trabajo de Starlark, en particular, las que se usan para controlar repositorios de git o archivos alojados en la Web.

vincular

Ver la fuente de la regla

bind(name, actual, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

Advertencia: No se recomienda usar bind(). Consulta "Considera quitar el vínculo" para obtener una explicación detallada de sus problemas y alternativas. En particular, considera el uso de los atributos de repositorio repo_mapping.

Advertencia: No se puede usar select() en bind(). Consulta las Preguntas frecuentes sobre los atributos configurables para obtener detalles.

Le asigna un alias a un objetivo en el paquete //external.

El paquete //external no es un paquete “normal”: no hay un directorio externo, por lo que se puede considerar un “paquete virtual” que contiene todos los destinos vinculados.

Ejemplos

Para asignar un alias a un objetivo, bind en el archivo WORKSPACE. Por ejemplo, supongamos que hay un objetivo java_library llamado //third_party/javacc-v2. Para asignarle un alias, agrega lo siguiente al archivo WORKSPACE:

bind(
    name = "javacc-latest",
    actual = "//third_party/javacc-v2",
)

Ahora los destinos pueden depender de //external:javacc-latest en lugar de //third_party/javacc-v2. Si se lanza javacc-v3, se puede actualizar la regla bind y todos los archivos BUILD que dependen de //external:javacc-latest ahora dependerán de javacc-v3 sin necesidad de editarlos.

También se puede usar para que los destinos de los repositorios externos estén disponibles para tu espacio de trabajo. Por ejemplo, si hay un repositorio remoto llamado @my-ssl importado en el archivo WORKSPACE y tiene un destino cc_library //src:openssl-lib, puedes crear un alias para este destino con bind:

bind(
    name = "openssl",
    actual = "@my-ssl//src:openssl-lib",
)

Luego, en un archivo BUILD en tu lugar de trabajo, el destino vinculado se puede usar de la siguiente manera:

cc_library(
    name = "sign-in",
    srcs = ["sign_in.cc"],
    hdrs = ["sign_in.h"],
    deps = ["//external:openssl"],
)

Dentro de sign_in.cc y sign_in.h, se puede hacer referencia a los archivos de encabezado que expone //external:openssl mediante su ruta de acceso en relación con la raíz del repositorio. Por ejemplo, si la definición de la regla para @my-ssl//src:openssl-lib se ve así:

cc_library(
    name = "openssl-lib",
    srcs = ["openssl.cc"],
    hdrs = ["openssl.h"],
)

Entonces, las inclusiones de sign_in.cc podrían verse de la siguiente manera:

#include "sign_in.h"
#include "src/openssl.h"

Argumentos

Atributos

Atributos
`name`	Nombre: Obligatorio Un nombre único para este destino.
`actual`	Etiqueta (Label); el valor predeterminado es `None` El objetivo al que se le asignará un alias. Este destino debe existir, pero puede ser cualquier tipo de regla (incluida la vinculación). Si se omite este atributo, las reglas que se refieren a este objetivo en `//external` simplemente no verán este borde de dependencia. Ten en cuenta que esto es diferente de omitir la regla `bind` por completo: es un error si una dependencia `//external` no tiene una regla `bind` asociada.

name

Nombre: Obligatorio

Un nombre único para este destino.

actual

Etiqueta (Label); el valor predeterminado es None

El objetivo al que se le asignará un alias.

Este destino debe existir, pero puede ser cualquier tipo de regla (incluida la vinculación).

Si se omite este atributo, las reglas que se refieren a este objetivo en //external simplemente no verán este borde de dependencia. Ten en cuenta que esto es diferente de omitir la regla bind por completo: es un error si una dependencia //external no tiene una regla bind asociada.

local_repository

Ver la fuente de la regla

local_repository(name, path, repo_mapping)

Permite que se vinculen los destinos de un directorio local. Esto significa que el repositorio actual puede usar los destinos definidos en este otro directorio. Consulta la sección de vinculación para obtener más detalles.

Ejemplos

Supongamos que el repositorio actual es un cliente de chat, con la raíz en el directorio ~/chat-app, y desea usar una biblioteca SSL definida en un repositorio diferente: ~/ssl. La biblioteca de SSL tiene un //src:openssl-lib de destino.

Para agregar una dependencia a este objetivo, el usuario puede agregar las siguientes líneas a ~/chat-app/WORKSPACE:

local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
)

Los destinos especificarían @my-ssl//src:openssl-lib como una dependencia para depender de esta biblioteca.

Argumentos

Atributos

name

Nombre: Obligatorio

Un nombre único para este objetivo.

path

Cadena; obligatorio

Es la ruta de acceso al directorio del repositorio local.

Debe ser una ruta de acceso al directorio que contiene el archivo WORKSPACE del repositorio. La ruta de acceso puede ser absoluta o relativa al archivo WORKSPACE del repositorio principal.

repo_mapping

Diccionario: Cadena -> Cadena; el valor predeterminado es {}

Un diccionario del nombre del repositorio local al nombre del repositorio global. Esto permite controlar la resolución de dependencias de Workspace para las dependencias de este repositorio.

Por ejemplo, una entrada "@foo": "@bar" declara que, cada vez que este repositorio dependa de "@foo" (como una dependencia de "@foo//some:target"), en realidad debería resolver esa dependencia dentro de "@bar" declarado de forma global ("@bar//some:target").

new_local_repository

Ver la fuente de la regla

new_local_repository(name, build_file, build_file_content, path, repo_mapping, workspace_file, workspace_file_content)

Permite que un directorio local se convierta en un repositorio de Bazel. Esto significa que el repositorio actual puede definir y usar destinos desde cualquier lugar del sistema de archivos.

Esta regla crea un repositorio de Bazel a través de la creación de un archivo WORKSPACE y un subdirectorio que contienen símbolos de enlace al archivo BUILD y la ruta de acceso proporcionada. El archivo de compilación debe crear destinos en relación con path. En el caso de los directorios que ya contienen un archivo WORKSPACE y un archivo BUILD, se puede usar la regla local_repository.

Ejemplos

Supongamos que el repositorio actual es un cliente de chat con raíz en el directorio ~/chat-app. Le gustaría usar una biblioteca SSL que se define en un directorio diferente: ~/ssl.

El usuario puede agregar una dependencia creando un archivo BUILD para la biblioteca SSL (~/chat-app/BUILD.my-ssl) que contenga lo siguiente:

java_library(
    name = "openssl",
    srcs = glob(['*.java'])
    visibility = ["//visibility:public"],
)

Luego, puede agregar las siguientes líneas a ~/chat-app/WORKSPACE:

new_local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
    build_file = "BUILD.my-ssl",
)

Se creará un repositorio @my-ssl que creará un symlink a /home/user/ssl. Para que los destinos dependan de esta biblioteca, agrega @my-ssl//:openssl a las dependencias de un destino.

También puedes usar new_local_repository para incluir archivos individuales, no solo directorios. Por ejemplo, supongamos que tienes un archivo JAR en /home/nombredeusuario/Descargas/piano.jar. Para agregar solo ese archivo a tu compilación, agrega lo siguiente a tu archivo WORKSPACE:

new_local_repository(
    name = "piano",
    path = "/home/username/Downloads/piano.jar",
    build_file = "BUILD.piano",
)

Crea el siguiente archivo BUILD.piano:

java_import(
    name = "play-music",
    jars = ["piano.jar"],
    visibility = ["//visibility:public"],
)

Luego, los destinos pueden depender de @piano//:play-music para usar piano.jar.

Argumentos

Atributos
`name`	Nombre: Obligatorio Un nombre único para este objetivo.
`build_file`	Name; el valor predeterminado es `None` Es un archivo que se usará como archivo BUILD para este directorio. Se debe especificar build_file o build_file_content. Este atributo es una etiqueta en relación con el espacio de trabajo principal. No es necesario que el archivo tenga el nombre BUILD, pero puede tenerlo. (Algo como BUILD.nombre-nuevo-del-repositorio puede funcionar bien para distinguirlo de los archivos BUILD reales del repositorio).
`build_file_content`	String; el valor predeterminado es `""` El contenido del archivo Build de este repositorio. Se debe especificar build_file o build_file_content.
`path`	String; obligatoria Es una ruta de acceso en el sistema de archivos local. Puede ser absoluta o relativa al archivo WORKSPACE del repositorio principal.
`repo_mapping`	Diccionario: Cadena -> Cadena; el valor predeterminado es `{}` Un diccionario del nombre del repositorio local al nombre del repositorio global. Esto permite controlar la resolución de dependencias de Workspace para las dependencias de este repositorio. Por ejemplo, una entrada `"@foo": "@bar"` declara que, cada vez que este repositorio dependa de `"@foo"` (como una dependencia de `"@foo//some:target"`), en realidad debería resolver esa dependencia dentro de `"@bar"` declarado de forma global (`"@bar//some:target"`).
`workspace_file`	Name; el valor predeterminado es `None` Es el archivo que se usará como archivo WORKSPACE para este repositorio. Se puede especificar workspace_file o workspace_file_content, pero no ambos. Este atributo es una etiqueta en relación con el espacio de trabajo principal. No es necesario que el archivo se llame WORKSPACE, pero puede hacerlo. (Algo como WORKSPACE.nombre-nuevo-del-repositorio puede funcionar bien para distinguirlo de los archivos WORKSPACE reales del repositorio).
`workspace_file_content`	String; el valor predeterminado es `""` Es el contenido del archivo WORKSPACE de este repositorio. Se puede especificar workspace_file o workspace_file_content, pero no ambos.