Aturan Bazel Starlark dapat merusak kompatibilitas dengan rilis Bazel LTS dalam dua skenario berikut:
- Aturan ini melanggar kompatibilitas dengan rilis LTS mendatang karena fitur yang menjadi dependensinya akan dihapus dari Bazel di HEAD.
- Aturan ini melanggar kompatibilitas dengan rilis LTS saat ini atau yang lebih lama karena fitur yang menjadi dependensinya hanya tersedia dalam rilis Bazel LTS yang lebih baru.
Sementara itu, aturan itu sendiri juga dapat mengirimkan perubahan yang tidak kompatibel untuk penggunanya. Jika digabungkan dengan perubahan yang dapat menyebabkan gangguan pada Bazel, mengupgrade versi aturan dan versi Bazel sering kali dapat menjadi sumber frustrasi bagi pengguna Bazel. Halaman ini membahas cara penulis aturan mempertahankan kompatibilitas aturan dengan Bazel untuk memudahkan pengguna mengupgrade Bazel dan aturan.
Proses migrasi yang dapat dikelola
Meskipun jelas tidak mungkin 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 harus mengupgrade versi utama rules_foo dan Bazel secara bersamaan.
- Migrasi 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 tanpa mengubah versi Bazel utama, lalu mengupgrade Bazel dari 5.x ke 6.x.
| rules_foo 1.x | rules_foo 2.x | rules_foo 3.x | HEAD | |
|---|---|---|---|---|
| Bazel 4.x | ✅ | ❌ | ❌ | ❌ |
| Bazel 5.x | ❌ | ✅ | ✅ | ❌ |
| Bazel 6.x | ❌ | ❌ | ✅ | ✅ |
| HEAD | ❌ | ❌ | ❌ | ✅ |
❌: Tidak ada versi aturan utama yang kompatibel dengan rilis Bazel LTS.
✅: Setidaknya satu versi aturan kompatibel dengan versi rilis Bazel LTS terbaru.
Praktik terbaik
Sebagai pembuat aturan Bazel, Anda dapat memastikan proses migrasi yang mudah dikelola bagi pengguna dengan mengikuti praktik terbaik berikut:
- Aturan ini harus mengikuti Pembuatan Versi Semantik: versi minor dari versi utama yang sama kompatibel dengan versi lama.
- Aturan di HEAD harus kompatibel dengan rilis Bazel LTS terbaru.
- Aturan di HEAD harus kompatibel dengan Bazel di HEAD. Untuk mencapai hal ini,
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 dapat menyebabkan gangguan pada Bazel memengaruhi project Anda, dan Anda harus mengikuti kebijakan project downstream untuk mengatasi masalah secara tepat waktu.
- Versi utama aturan terbaru harus kompatibel dengan rilis Bazel LTS terbaru.
- Versi utama aturan baru 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 menjaga kompatibilitas dengan Bazel di HEAD dan rilis Bazel LTS terbaru, pembuat 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 bermigrasi untuk perubahan yang tidak kompatibel dengan Bazel dan menggunakan fitur Bazel baru di HEAD tanpa menurunkan kompatibilitas dengan rilis Bazel LTS terbaru.