Chúng tôi không thể tránh khỏi việc thực hiện các thay đổi có thể gây lỗi cho Bazel. Chúng ta sẽ phải thay đổi thiết kế và khắc phục những vấn đề không hoạt động. Tuy nhiên, chúng ta cần để đảm bảo cộng đồng và hệ sinh thái Bazel có thể tuân thủ. Do đó, dự án Bazel đã áp dụng chính sách tương thích ngược. Tài liệu này mô tả quy trình để những người đóng góp cho Bazel thực hiện một thay đổi có thể gây lỗi trong Bazel nhằm tuân thủ chính sách này.
Tuân thủ chính sách tài liệu thiết kế.
Vấn đề trên GitHub
Báo cáo vấn đề trên GitHub trong kho lưu trữ Bazel. Xem ví dụ.
Bạn nên:
Tiêu đề bắt đầu bằng tên của cờ (tên cờ sẽ bắt đầu bằng
incompatible_).Bạn thêm nhãn
incompatible-change.Phần mô tả chứa nội dung mô tả về thay đổi và một đường liên kết đến trang tài liệu thiết kế.
Nội dung mô tả chứa công thức di chuyển để giải thích cho người dùng cách họ cần hãy cập nhật mã của mình. Tốt nhất là khi thay đổi là cơ học, hãy thêm đường liên kết đến một công cụ di chuyển.
Nội dung mô tả có một ví dụ về thông báo lỗi mà người dùng sẽ nhận được nếu chúng không di chuyển. Điều này sẽ giúp vấn đề trên GitHub dễ được phát hiện hơn trên các công cụ tìm kiếm. Đảm bảo rằng thông báo lỗi hữu ích và có thể hành động. Khi có thể, thông báo lỗi phải bao gồm tên của sự kiện không tương thích cờ.
Đối với công cụ di chuyển, hãy cân nhắc đóng góp cho
Trình tạo bản dựng.
Công cụ này có thể áp dụng bản sửa lỗi tự động cho các tệp BUILD, WORKSPACE và .bzl.
Ngoài ra, tính năng này cũng có thể báo cáo cảnh báo.
Triển khai
Tạo một cờ mới trong Bazel. Giá trị mặc định phải là false. Văn bản trợ giúp
phải chứa URL của vấn đề GitHub. Khi tên cờ bắt đầu bằng
incompatible_ thì cần có các thẻ siêu dữ liệu:
metadataTags = {
OptionMetadataTag.INCOMPATIBLE_CHANGE,
},
Trong phần mô tả cam kết, hãy thêm nội dung tóm tắt ngắn gọn về cờ.
Ngoài ra, hãy thêm RELNOTES: vào biểu mẫu sau:
RELNOTES: --incompatible_name_of_flag has been added. See #xyz for details
Cam kết cũng phải cập nhật tài liệu liên quan để không cửa sổ thay đổi trong đó mã không nhất quán với tài liệu. Vì tài liệu của chúng tôi được phân phiên bản, nên các thay đổi đối với tài liệu sẽ không vô tình được phát hành sớm.
Nhãn
Sau khi thay đổi không tương thích được chấp nhận và thay đổi đã cam kết được hợp nhất, hãy thêm nhãn migration-ready vào vấn đề trên GitHub.
Nếu bạn phát hiện vấn đề với cờ và người dùng chưa di chuyển: hãy xoá cờ migration-ready.
Nếu bạn có kế hoạch lật ngược bản phát hành chính tiếp theo, hãy thêm nhãn "breaking-change-X.0" vào vấn đề.
Đang cập nhật kho lưu trữ
Bazel CI kiểm thử danh sách các dự án quan trọng tại Bazel@HEAD + Downstream. Hầu hết trong số họ thường
các phần phụ thuộc của các dự án Bazel khác, do đó, bạn cần di chuyển các dự án đó để bỏ chặn quá trình di chuyển cho cộng đồng nói chung. Để theo dõi trạng thái di chuyển của các dự án đó, bạn có thể sử dụng quy trình bazelisk-plus-incompatible-flags.
Hãy xem cách hoạt động của quy trình này tại đây.
Nhóm hỗ trợ nhà phát triển của chúng tôi theo dõi nhãn migration-ready. Sau khi bạn thêm nhãn này vào vấn đề trên GitHub, họ sẽ xử lý những việc sau:
Tạo một nhận xét trong vấn đề trên GitHub để theo dõi danh sách các lỗi và dự án phụ cần di chuyển (xem ví dụ)
Gửi vấn đề về GitHub để thông báo cho chủ sở hữu của mọi dự án ở hạ nguồn bị hỏng do thay đổi không tương thích của bạn (xem ví dụ)
Tiếp tục liên hệ để đảm bảo bạn đã giải quyết mọi vấn đề trước ngày phát hành dự kiến
Việc di chuyển các dự án trong quy trình hạ nguồn KHÔNG hoàn toàn thuộc trách nhiệm của tác giả thay đổi không tương thích, nhưng bạn có thể làm như sau để đẩy nhanh quá trình di chuyển và mang lại trải nghiệm dễ dàng hơn cho cả người dùng Bazel và Nhóm Bazel Green.
Gửi yêu cầu phát hành để khắc phục các dự án phụ thuộc.
Liên hệ với cộng đồng Bazel để được trợ giúp về việc di chuyển (ví dụ: Bazel Rules Authors SIG).
Lật cờ
Trước khi chuyển giá trị mặc định của cờ thành true, vui lòng đảm bảo rằng:
Các kho lưu trữ cốt lõi trong hệ sinh thái được di chuyển.
Trên quy trình
bazelisk-plus-incompatible-flags, cờ này sẽ xuất hiện bên dướiThe following flags didn't break any passing Bazel team owned/co-owned projects.Tất cả vấn đề trong danh sách kiểm tra đều được đánh dấu là đã khắc phục/đã đóng.
Chúng tôi đã giải quyết các thắc mắc và mối lo ngại của người dùng.
Khi cờ đã sẵn sàng tung ra trong Bazel nhưng bị chặn trong quá trình di chuyển nội bộ tại Google, vui lòng cân nhắc đặt giá trị cờ thành false trong tệp blazerc nội bộ để bỏ chặn việc tung cờ. Bằng cách này, chúng tôi có thể đảm bảo rằng người dùng Bazel phụ thuộc vào hành vi mới theo mặc định sớm nhất có thể.
Khi thay đổi cờ mặc định thành true, vui lòng:
- Sử dụng
RELNOTES[INC]trong phần mô tả cam kết, với định dạng sau:RELNOTES[INC]: --incompatible_name_of_flag is flipped to true. See #xyz for detailsBạn có thể đưa thêm thông tin vào phần còn lại của nội dung mô tả cam kết. - Sử dụng
Fixes #xyztrong nội dung mô tả để đóng vấn đề trên GitHub khi bạn hợp nhất thay đổi. - Xem xét và cập nhật tài liệu nếu cần.
- Hãy báo cáo một vấn đề mới
#abcđể theo dõi việc xoá cờ.
Xoá cờ
Sau khi cờ được lật ở HEAD, cờ này sẽ bị xoá khỏi Bazel. Khi bạn dự định xoá cờ không tương thích:
- Hãy cân nhắc để người dùng có thêm thời gian di chuyển nếu đó là sự thay đổi không tương thích lớn. Lý tưởng nhất là cờ này phải có trong ít nhất một bản phát hành chính.
- Đối với thay đổi xoá cờ, hãy sử dụng
Fixes #abctrong phần mô tả để đóng vấn đề trên GitHub khi thay đổi được hợp nhất.