Kompatibilitas Mundur

Laporkan masalah Lihat sumber

Halaman ini memberikan informasi tentang cara menangani kompatibilitas mundur, termasuk melakukan migrasi dari satu rilis ke rilis lainnya dan cara mengomunikasikan perubahan yang tidak kompatibel.

Bazel terus berkembang. Versi minor yang dirilis sebagai bagian dari versi utama LTS sepenuhnya kompatibel dengan versi lama. 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

  1. Sebaiknya gunakan tanda --incompatible_* untuk perubahan yang dapat menyebabkan gangguan.
  2. Untuk setiap flag --incompatible_*, masalah GitHub menjelaskan perubahan perilaku dan bertujuan untuk menyediakan urutan migrasi.
  3. Flag yang tidak kompatibel direkomendasikan untuk di-backport ke rilis LTS terbaru tanpa mengaktifkan tanda tersebut secara default.
  4. API dan perilaku yang dilindungi oleh flag --experimental_* dapat berubah kapan saja.
  5. Jangan pernah menjalankan build produksi dengan tanda --experimental_* atau --incompatible_*.

Cara mematuhi kebijakan ini

Apa itu fungsi stabil?

Secara umum, API atau perilaku tanpa flag --experimental_... dianggap sebagai fitur stabil yang didukung di Bazel.

Hal ini mencakup:

  • Bahasa dan API Starlark
  • Aturan yang dipaketkan bersama Bazel
  • API Bazel seperti Remote Execution API atau Build Event Protocol
  • Tanda dan semantiknya

Perubahan dan urutan migrasi yang tidak kompatibel

Untuk setiap perubahan yang tidak kompatibel dalam rilis baru, tim Bazel bertujuan menyediakan urutan 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 flag --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 ini secara default. Hal ini memungkinkan pengguna bermigrasi untuk perubahan yang tidak kompatibel sebelum rilis LTS berikutnya tersedia.

Menyampaikan perubahan yang tidak kompatibel

Sumber utama informasi tentang perubahan yang tidak kompatibel adalah masalah GitHub yang ditandai dengan label"tidak kompatibel-ubah".

Untuk setiap perubahan yang tidak kompatibel, masalahnya menentukan hal berikut:

  • Nama tanda yang mengontrol perubahan yang tidak kompatibel
  • Deskripsi fungsi yang diubah
  • Urutan migrasi

Saat perubahan yang tidak kompatibel siap dimigrasikan dengan Bazel di HEAD (sehingga, juga dengan rilis berkelanjutan Bazel berikutnya), perubahan tersebut harus ditandai dengan label migration-ready. Masalah perubahan yang tidak kompatibel ditutup saat tanda yang tidak kompatibel dibalik ke HEAD.