Khả năng tương thích ngược

Báo cáo vấn đề Xem nguồn Hằng đêm · 7,4 của Google. 7.3 · 7,2 · 7.1 · 7 · 6,5

Trang này cung cấp thông tin về cách xử lý khả năng tương thích ngược, bao gồm cả cách di chuyển từ bản phát hành này sang bản phát hành khác và cách truyền đạt các thay đổi không tương thích.

Bazel đang phát triển. Các phiên bản nhỏ được phát hành trong khuôn khổ LTS lớn hoàn toàn tương thích ngược. LTS chuyên ngành mới bản phát hành có thể chứa những thay đổi không tương thích đòi hỏi phải di chuyển một chút. Để biết thêm thông tin về mô hình phát hành của Bazel, vui lòng xem phần Bản phát hành Mô hình.

Tóm tắt

  1. Bạn nên sử dụng cờ --incompatible_* cho các thay đổi có thể gây lỗi.
  2. Đối với mỗi cờ --incompatible_*, một vấn đề trên GitHub sẽ giải thích về thay đổi trong hành vi và hướng đến việc cung cấp công thức di chuyển.
  3. Bạn nên chuyển các cờ không tương thích về phiên bản LTS mới nhất phát hành mà không bật cờ theo mặc định.
  4. Các API và hành vi được bảo vệ bằng cờ --experimental_* có thể thay đổi bất cứ lúc nào bất cứ lúc nào.
  5. Không bao giờ chạy bản dựng chính thức bằng cờ --experimental_* hoặc --incompatible_*.

Cách tuân thủ chính sách này

Chức năng ổn định là gì?

Nhìn chung, các API hoặc hành vi không có cờ --experimental_... được coi là các tính năng ổn định, được hỗ trợ trong Bazel.

Nội dung như vậy bao gồm:

  • Ngôn ngữ Starlark và API
  • Các quy tắc đi kèm với Bazel
  • Các API Bazel, chẳng hạn như API Thực thi từ xa hoặc Giao thức sự kiện Xây dựng
  • Cờ và ngữ nghĩa của cờ

Công thức di chuyển và thay đổi không tương thích

Đối với mỗi thay đổi không tương thích trong một bản phát hành mới, nhóm Bazel hướng đến việc cung cấp một công thức di chuyển giúp bạn cập nhật mã (tệp BUILD.bzl, cũng như mọi hoạt động sử dụng Bazel trong tập lệnh, sử dụng API Bazel, v.v.).

Các thay đổi không tương thích phải có cờ --incompatible_* được liên kết và một vấn đề tương ứng trên GitHub.

Bạn nên điều chỉnh cờ không tương thích và các thay đổi có liên quan cho bản phát hành LTS mới nhất mà không bật cờ theo mặc định. Điều này cho phép người dùng di chuyển các thay đổi không tương thích trước khi bản phát hành LTS tiếp theo ra mắt.

Thông báo về các thay đổi không tương thích

Nguồn thông tin chính về các thay đổi không tương thích là các vấn đề trên GitHub được đánh dấu bằng thẻ "incompatible-change" (thay đổi không tương thích).

Đối với mỗi thay đổi không tương thích, vấn đề sẽ chỉ định những thông tin sau:

  • Tên của cờ kiểm soát thay đổi không tương thích
  • Nội dung mô tả về chức năng đã thay đổi
  • Công thức di chuyển

Khi một thay đổi không tương thích đã sẵn sàng để di chuyển với Bazel tại HEAD (do đó, cũng với bản phát hành lăn Bazel tiếp theo), thay đổi đó phải được đánh dấu bằng nhãn migration-ready. Vấn đề thay đổi không tương thích được đóng khi cờ không tương thích được lật ở HEAD.