Bazel mem-build software dari kode sumber yang diatur dalam hierarki direktori yang disebut
workspace. File sumber di ruang kerja diatur dalam hierarki paket
bertingkat, dengan setiap paket adalah direktori yang berisi kumpulan file sumber
terkait dan satu file BUILD
. File BUILD
menentukan output software
yang dapat dibuat dari sumbernya.
Workspace
Ruang kerja adalah hierarki direktori pada sistem file yang berisi file
sumber untuk software yang ingin Anda bangun. Setiap ruang kerja memiliki file teks bernama
WORKSPACE
yang mungkin kosong, atau mungkin berisi referensi ke dependensi
eksternal yang diperlukan untuk membuat output.
Direktori yang berisi file bernama WORKSPACE
dianggap sebagai root
ruang kerja. Oleh karena itu, Bazel mengabaikan semua hierarki direktori di ruang kerja yang di-root pada
subdirektori yang berisi file WORKSPACE
, karena struktur tersebut membentuk ruang kerja lain.
Bazel juga mendukung file WORKSPACE.bazel
sebagai alias file WORKSPACE
. Jika kedua file ada, WORKSPACE.bazel
akan digunakan.
Repositori
Kode diatur dalam repositori. Direktori yang berisi file WORKSPACE
adalah root repositori utama, yang juga disebut @
. Repositori (eksternal)
lainnya ditentukan dalam file WORKSPACE
menggunakan aturan ruang kerja, atau
dibuat dari modul dan ekstensi di sistem Bzlmod. Lihat ringkasan dependensi
eksternal untuk mengetahui informasi selengkapnya.
Aturan ruang kerja yang dipaketkan dengan Bazel didokumentasikan di bagian Aturan Ruang Kerja di Ensiklopedia Pembuatan dan dokumentasi tentang aturan repositori Starlark tersemat.
Karena repositori eksternal adalah repositori itu sendiri, repositori tersebut juga sering kali berisi
file WORKSPACE
. Namun, file WORKSPACE
tambahan ini
diabaikan oleh Bazel. Secara khusus, repositori yang bergantung secara transitif tidak
ditambahkan secara otomatis.
Paket
Unit utama organisasi kode dalam repositori adalah paket. Paket adalah kumpulan file terkait dan spesifikasi cara file tersebut dapat digunakan untuk menghasilkan artefak output.
Paket ditentukan sebagai direktori yang berisi
file BUILD
bernama BUILD
atau BUILD.bazel
. Paket
menyertakan semua file dalam direktorinya, ditambah semua subdirektori di bawahnya,
kecuali yang berisi file BUILD
. Dari definisi ini, tidak ada
file atau direktori yang dapat menjadi bagian dari dua paket yang berbeda.
Misalnya, dalam hierarki direktori berikut, ada dua paket, my/app
,
dan subpaket my/app/tests
. Perhatikan bahwa my/app/data
bukan paket, tetapi
direktori yang termasuk dalam paket 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
Target
Paket adalah penampung target, yang ditentukan dalam file
BUILD
paket. Sebagian besar target adalah salah satu dari dua jenis utama, yaitu file dan aturan.
File dibagi lagi menjadi dua jenis. File sumber biasanya ditulis oleh upaya orang, dan diperiksa ke repositori. File yang dihasilkan, terkadang disebut file turunan atau file output, tidak diperiksa, tetapi dibuat dari file sumber.
Jenis target kedua dideklarasikan dengan aturan. Setiap instance aturan menentukan hubungan antara kumpulan input dan kumpulan file output. Input ke aturan dapat berupa file sumber, tetapi juga dapat berupa output aturan lainnya.
Dalam sebagian besar kasus, apakah input ke aturan adalah file sumber atau file yang dihasilkan tidak penting; yang penting hanyalah konten file tersebut. Fakta ini memudahkan penggantian file sumber yang kompleks dengan file yang dihasilkan oleh aturan, seperti yang terjadi saat beban pemeliharaan file yang sangat terstruktur secara manual menjadi terlalu melelahkan, dan seseorang menulis program untuk mendapatkannya. Tidak ada perubahan yang diperlukan bagi pemakai file tersebut. Sebaliknya, file yang dihasilkan dapat dengan mudah diganti oleh file sumber hanya dengan perubahan lokal.
Input ke aturan juga dapat mencakup aturan lainnya. Makna yang tepat dari hubungan tersebut sering kali cukup kompleks dan bergantung pada bahasa atau aturan, tetapi secara intuitif, hal ini sederhana: aturan library C++ A mungkin memiliki aturan library C++ B lain untuk input. Efek dari dependensi ini adalah file header B tersedia untuk A selama kompilasi, simbol B tersedia untuk A selama penautan, dan data runtime B tersedia untuk A selama eksekusi.
Invarian dari semua aturan adalah file yang dihasilkan oleh aturan selalu termasuk dalam paket yang sama dengan aturan itu sendiri; tidak mungkin membuat file ke dalam paket lain. Namun, tidak jarang input aturan berasal dari paket lain.
Grup paket adalah kumpulan paket yang tujuannya adalah untuk membatasi aksesibilitas
aturan tertentu. Grup paket ditentukan oleh fungsi package_group
. Grup ini
memiliki tiga properti: daftar paket yang dimuat, namanya, dan grup
paket lain yang disertakan. Satu-satunya cara yang diizinkan untuk merujuknya adalah dari
atribut visibility
aturan atau dari atribut default_visibility
fungsi package
; atribut tersebut tidak membuat atau menggunakan file. Untuk mengetahui informasi
selengkapnya, lihat dokumentasi
package_group
.