Aturan Starlark Bazel dapat merusak kompatibilitas dengan rilis Bazel LTS dalam dua skenario berikut:
- Aturan ini merusak kompatibilitas dengan rilis LTS mendatang karena fitur yang diperlukan dihapus dari Bazel di HEAD.
- Aturan ini merusak kompatibilitas dengan rilis LTS saat ini atau yang lebih lama karena fitur yang menjadi dependensinya hanya tersedia di rilis Bazel LTS yang lebih baru.
Sementara itu, aturan itu sendiri juga dapat mengirimkan perubahan yang tidak kompatibel bagi penggunanya. Jika digabungkan dengan perubahan yang menyebabkan error di Bazel, mengupgrade versi aturan dan versi Bazel sering kali menjadi sumber frustrasi bagi pengguna Bazel. Halaman ini membahas cara penulis aturan harus mempertahankan kompatibilitas aturan dengan Bazel untuk memudahkan pengguna mengupgrade Bazel dan aturan.
Proses migrasi yang dapat dikelola
Meskipun jelas tidak memungkinkan untuk menjamin kompatibilitas antara setiap versi Bazel dan setiap versi aturan, tujuan kami adalah memastikan bahwa proses migrasi tetap dapat dikelola oleh pengguna Bazel. Proses migrasi yang dapat dikelola didefinisikan sebagai proses saat pengguna tidak dipaksa untuk mengupgrade versi utama aturan dan versi utama Bazel secara bersamaan, sehingga memungkinkan pengguna menangani perubahan yang tidak kompatibel dari satu sumber pada satu waktu.
Misalnya, dengan matriks kompatibilitas berikut:
- Bermigrasi dari rules_foo 1.x + Bazel 4.x ke rules_foo 2.x + Bazel 5.x tidak dianggap dapat dikelola, karena pengguna perlu mengupgrade versi utama rules_foo dan Bazel secara bersamaan.
- Bermigrasi dari rules_foo 2.x + Bazel 5.x ke rules_foo 3.x + Bazel 6.x dianggap dapat dikelola, karena pengguna dapat mengupgrade rules_foo dari 2.x ke 3.x terlebih dahulu tanpa mengubah versi utama Bazel, lalu mengupgrade Bazel dari 5.x ke 6.x.
| rules_foo 1.x | rules_foo 2.x | rules_foo 3.x | KEPALA | |
|---|---|---|---|---|
| Bazel 4.x | ✅ | ❌ | ❌ | ❌ |
| Bazel 5.x | ❌ | ✅ | ✅ | ❌ |
| Bazel 6.x | ❌ | ❌ | ✅ | ✅ |
| KEPALA | ❌ | ❌ | ❌ | ✅ |
❌: Tidak ada versi aturan utama yang kompatibel dengan rilis LTS Bazel.
✅: Setidaknya satu versi aturan kompatibel dengan versi terbaru rilis Bazel LTS.
Praktik terbaik
Sebagai penulis aturan Bazel, Anda dapat memastikan proses migrasi yang dapat dikelola bagi pengguna dengan mengikuti praktik terbaik berikut:
- Aturan harus mengikuti Pembuatan Versi Semantik: versi minor dari versi utama yang sama kompatibel dengan versi sebelumnya.
- Aturan di HEAD harus kompatibel dengan rilis Bazel LTS terbaru.
- Aturan di HEAD harus kompatibel dengan Bazel di HEAD. Untuk mencapainya,
Anda dapat
- Menyiapkan pengujian CI Anda sendiri dengan Bazel di HEAD
- Tambahkan project Anda ke pengujian downstream Bazel; tim Bazel akan melaporkan masalah ke project Anda jika perubahan yang menyebabkan error di Bazel memengaruhi project Anda, dan Anda harus mengikuti kebijakan project downstream kami untuk mengatasi masalah secara tepat waktu.
- Versi utama terbaru dari aturan harus kompatibel dengan rilis LTS Bazel terbaru.
- Versi utama baru dari aturan harus kompatibel dengan rilis LTS Bazel terakhir yang didukung oleh versi utama aturan sebelumnya.
Mencapai 2. dan 3. adalah tugas yang paling penting karena memungkinkan pencapaian 4. dan 5. secara alami.
Untuk mempermudah kompatibilitas dengan Bazel di HEAD dan rilis LTS Bazel terbaru, penulis aturan dapat:
- Minta fitur yang kompatibel dengan versi lama untuk di-backport ke rilis LTS terbaru, lihat proses rilis untuk detail selengkapnya.
- Gunakan bazel_features untuk melakukan deteksi fitur Bazel.
Secara umum, dengan pendekatan yang direkomendasikan, aturan harus dapat dimigrasikan untuk perubahan yang tidak kompatibel dengan Bazel dan menggunakan fitur Bazel baru di HEAD tanpa mengurangi kompatibilitas dengan rilis LTS Bazel terbaru.