Bazel compila software a partir del código fuente organizado en un árbol de directorios llamado
lugar de trabajo. Los archivos de origen del lugar de trabajo se organizan en una jerarquía anidada de paquetes, en la que cada paquete es un directorio que contiene un conjunto de archivos de origen relacionados y un archivo BUILD. En el archivo BUILD, se especifica qué resultados de software se pueden compilar a partir de la fuente.
Espacio de trabajo
Un lugar de trabajo es un árbol de directorios en el sistema de archivos que contiene los archivos fuente para el software que quieres compilar. Cada lugar de trabajo tiene un archivo de texto llamado WORKSPACE que puede estar vacío o contener referencias a dependencias externas necesarias para compilar los resultados.
Los directorios que contienen un archivo llamado WORKSPACE se consideran la raíz de un lugar de trabajo. Por lo tanto, Bazel ignora los árboles de directorios de un lugar de trabajo con permisos de administrador en
un subdirectorio que contiene un archivo WORKSPACE, a medida que forman otro lugar de trabajo.
Bazel también admite el archivo WORKSPACE.bazel como alias del archivo WORKSPACE. Si existen ambos archivos, se usa WORKSPACE.bazel.
Repositorios
El código se organiza en repositorios. El directorio que contiene el archivo WORKSPACE es la raíz del repositorio principal, también llamado @. Otros repositorios (externos) se definen en el archivo WORKSPACE con las reglas del lugar de trabajo, o se generan a partir de módulos y extensiones del sistema Bzlmod. Consulta la descripción general de las dependencias externas para obtener más información.
Las reglas del lugar de trabajo incluidas en Bazel se documentan en la sección Reglas de lugar de trabajo de la Enciclopedia de compilación y en la documentación sobre las reglas del repositorio de Starlark incorporadas.
Como los repositorios externos son repositorios en sí mismos, a menudo también contienen un archivo WORKSPACE. Sin embargo, Bazel ignora
estos archivos WORKSPACE adicionales. En particular, los repositorios que dependen de que de forma transitiva no se agregan automáticamente.
Paquetes
La unidad principal de organización de código en un repositorio es el paquete. Un paquete es una colección de archivos relacionados y una especificación de cómo se pueden usar para producir artefactos de salida.
Un paquete se define como un directorio que contiene un archivo llamado BUILD (o BUILD.bazel). Un paquete incluye todos los archivos en su directorio, además de todos los subdirectorios debajo de él, excepto aquellos que contienen un archivo BUILD.
A partir de esta definición, ningún archivo o directorio puede formar parte de dos paquetes diferentes.
Por ejemplo, en el siguiente árbol de directorios, hay dos paquetes, my/app, y el subpaquete my/app/tests. Ten en cuenta que my/app/data no es un paquete, sino un directorio que pertenece al paquete my/app.
src/my/app/BUILD
src/my/app/app.cc
src/my/app/data/input.txt
src/my/app/tests/BUILD
src/my/app/tests/test.cc
Destinos
Un paquete es un contenedor de destinos, que se definen en el archivo BUILD del paquete. La mayoría de los objetivos son uno de dos tipos principales: files y rules.
Además, los archivos se dividen en dos tipos. Por lo general, los archivos fuente se escriben con el esfuerzo de otras personas y se registran en el repositorio. Los archivos generados, a veces llamados archivos derivados o archivos de salida, no se registran, pero se generan a partir de archivos fuente.
El segundo tipo de objetivo se declara con una regla. Cada instancia de regla especifica la relación entre un conjunto de archivos de entrada y un conjunto de archivos de salida. Las entradas a una regla pueden ser archivos de origen, pero también pueden ser las salidas de otras reglas.
Si la entrada a una regla es un archivo de origen o un archivo generado, en la mayoría de los casos, no tiene importancia; lo que importa es solo el contenido de ese archivo. Esto facilita el reemplazo de un archivo fuente complejo por un archivo generado producido por una regla, como cuando la carga de mantener manualmente un archivo altamente estructurado se vuelve demasiado agotadora y alguien escribe un programa para derivarlo. No se requiere ningún cambio a los consumidores de ese archivo. Por el contrario, un archivo generado se puede reemplazar con facilidad por un archivo de origen solo con cambios locales.
Las entradas a una regla también pueden incluir otras reglas. El significado preciso de estas relaciones suele ser bastante complejo y depende del lenguaje o las reglas, pero de forma intuitiva es simple: una regla de una biblioteca C++ A podría tener otra regla de biblioteca C++ B para una entrada. El efecto de esta dependencia es que los archivos de encabezado de B están disponibles para A durante la compilación, los símbolos de B están disponibles para A durante la vinculación y los datos del tiempo de ejecución de B están disponibles para A durante la ejecución.
Una variante de todas las reglas es que los archivos que genera una regla siempre pertenecen al mismo paquete que la regla en sí; no es posible generar archivos en otro paquete. Sin embargo, no es inusual que las entradas de una regla provengan de otro paquete.
Los grupos de paquetes son conjuntos de paquetes cuyo propósito es limitar la accesibilidad de ciertas reglas. Los grupos de paquetes se definen con la función package_group. Tienen tres propiedades: la lista de paquetes que contienen, su nombre y otros grupos de paquetes que incluyen. Las únicas formas permitidas de hacer referencia a ellas son desde el atributo visibility de las reglas o desde el atributo default_visibility de la función package. No generan ni consumen archivos. Para obtener más información, consulta la documentación de package_group.