Halaman ini memberikan informasi tentang cara menangani kompatibilitas mundur, termasuk bermigrasi dari satu rilis ke rilis lainnya dan cara menyampaikan perubahan yang tidak kompatibel.
Bazel terus berkembang. Versi minor yang dirilis sebagai bagian dari versi utama LTS sepenuhnya kompatibel dengan versi sebelumnya. Rilis LTS utama yang baru mungkin berisi perubahan yang tidak kompatibel yang memerlukan beberapa upaya migrasi. Untuk mengetahui informasi selengkapnya tentang model rilis Bazel, lihat halaman Model Rilis.
Ringkasan
- Sebaiknya gunakan flag
--incompatible_*
untuk perubahan yang menyebabkan error. - Untuk setiap flag
--incompatible_*
, masalah GitHub menjelaskan perubahan perilaku dan bertujuan untuk memberikan resep migrasi. - Flag yang tidak kompatibel direkomendasikan untuk di-backport ke rilis LTS terbaru tanpa mengaktifkan flag secara default.
- API dan perilaku yang dilindungi oleh tanda
--experimental_*
dapat berubah kapan saja. - Jangan pernah menjalankan build produksi dengan flag
--experimental_*
atau--incompatible_*
.
Cara mematuhi kebijakan ini
- Untuk pengguna Bazel - cara mengupdate Bazel
- Untuk kontributor - praktik terbaik untuk perubahan yang tidak kompatibel
- Untuk pengelola rilis - cara memperbarui label masalah dan rilis
Apa yang dimaksud dengan fungsi stabil?
Secara umum, API atau perilaku tanpa flag --experimental_...
dianggap sebagai fitur yang stabil dan didukung di Bazel.
Hal ini mencakup:
- Bahasa dan API Starlark
- Aturan yang dipaketkan dengan Bazel
- Bazel API seperti Remote Execution API atau Build Event Protocol
- Flag dan semantiknya
Perubahan dan resep migrasi yang tidak kompatibel
Untuk setiap perubahan yang tidak kompatibel dalam rilis baru, tim Bazel bertujuan untuk menyediakan
resep migrasi yang membantu Anda mengupdate kode (file BUILD
dan .bzl
, serta
penggunaan Bazel dalam skrip, penggunaan Bazel API, dan sebagainya).
Perubahan yang tidak kompatibel harus memiliki tanda --incompatible_*
terkait dan
masalah GitHub yang sesuai.
Flag yang tidak kompatibel dan perubahan yang relevan direkomendasikan untuk di-backport ke rilis LTS terbaru tanpa mengaktifkan flag secara default. Hal ini memungkinkan pengguna untuk bermigrasi untuk perubahan yang tidak kompatibel sebelum rilis LTS berikutnya tersedia.
Menyampaikan perubahan yang tidak kompatibel
Sumber informasi utama tentang perubahan yang tidak kompatibel adalah masalah GitHub yang ditandai dengan label"incompatible-change".
Untuk setiap perubahan yang tidak kompatibel, masalah ini menentukan hal berikut:
- Nama tanda yang mengontrol perubahan yang tidak kompatibel
- Deskripsi fungsi yang diubah
- Resep migrasi
Jika perubahan yang tidak kompatibel siap untuk dimigrasikan dengan Bazel di HEAD
(oleh karena itu, juga dengan rilis rolling Bazel berikutnya), perubahan tersebut harus ditandai dengan
label migration-ready
. Masalah perubahan yang tidak kompatibel ditutup saat
tanda tidak kompatibel dibalik di HEAD.