Repositori, ruang kerja, paket, dan target

Bazel membuat software dari kode sumber yang disusun dalam pohon direktori yang disebut repositori. Kumpulan repositori yang ditentukan terdiri dari ruang kerja. File sumber dalam repositori disusun 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 sumber.

Repositori

File sumber yang digunakan dalam build Bazel disusun dalam repositori (sering disingkat menjadi repo). Repo adalah pohon direktori dengan file penanda batas di root-nya; file penanda batas tersebut dapat berupa MODULE.bazel, REPO.bazel, atau dalam konteks lama, WORKSPACE atau WORKSPACE.bazel.

Repo tempat perintah Bazel saat ini dijalankan disebut repo utama. Repo lain (eksternal) ditentukan oleh aturan repo; lihat ringkasan dependensi eksternal untuk mengetahui informasi selengkapnya.

Ruang kerja

Ruang kerja adalah lingkungan yang digunakan bersama oleh semua perintah Bazel yang dijalankan dari repo utama yang sama. Ruang kerja mencakup repo utama dan kumpulan semua repo eksternal yang ditentukan.

Perhatikan bahwa secara historis, konsep "repositori" dan "ruang kerja" telah digabungkan; istilah "ruang kerja" sering digunakan untuk merujuk ke repositori utama, dan terkadang bahkan digunakan sebagai sinonim dari "repositori".

Paket

Unit utama organisasi kode dalam repositori adalah paket. Paket adalah kumpulan file terkait dan spesifikasi tentang cara file tersebut dapat digunakan untuk menghasilkan artefak output.

Paket ditentukan sebagai direktori yang berisi file BUILD yang diberi nama BUILD atau BUILD.bazel. Paket mencakup semua file di 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 pohon 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, 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 dihasilkan 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 dari aturan lain.

Apakah input ke aturan adalah file sumber atau file yang dihasilkan, dalam sebagian besar kasus tidak relevan; 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 mempertahankan file yang sangat terstruktur secara manual menjadi terlalu melelahkan, dan seseorang menulis program untuk menurunkannya. Tidak ada perubahan yang diperlukan untuk konsumen file tersebut. Sebaliknya, file yang dihasilkan dapat dengan mudah diganti dengan file sumber hanya dengan perubahan lokal.

Input ke aturan juga dapat mencakup aturan lain. Arti sebenarnya dari hubungan tersebut sering kali cukup kompleks dan bergantung pada bahasa atau aturan, tetapi secara intuitif 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; file tidak dapat dihasilkan ke paket lain. Namun, input aturan sering kali 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 paket memiliki tiga properti: daftar paket yang dikandungnya, namanya, dan grup paket lain yang disertakannya. Satu-satunya cara yang diizinkan untuk merujuknya adalah dari atribut visibility aturan atau dari atribut default_visibility fungsi package; grup paket tidak menghasilkan atau menggunakan file. Untuk mengetahui informasi selengkapnya, lihat package_group dokumentasi.

Label