Các quy tắc Bazel Starlark có thể làm mất khả năng tương thích với các bản phát hành Bazel LTS trong 2 trường hợp sau:
- Quy tắc này làm mất khả năng tương thích với các bản phát hành LTS trong tương lai vì một tính năng mà quy tắc này phụ thuộc vào đã bị xoá khỏi Bazel tại HEAD.
- Quy tắc này làm gián đoạn khả năng tương thích với các bản phát hành LTS hiện tại hoặc cũ hơn vì một tính năng mà quy tắc này phụ thuộc chỉ có trong các bản phát hành LTS mới hơn của Bazel.
Trong khi đó, bản thân quy tắc cũng có thể gửi các thay đổi không tương thích cho người dùng. Khi kết hợp với các thay đổi có thể gây lỗi trong Bazel, việc nâng cấp phiên bản quy tắc và phiên bản Bazel thường có thể gây khó chịu cho người dùng Bazel. Trang này trình bày cách tác giả quy tắc nên duy trì khả năng tương thích của quy tắc với Bazel để giúp người dùng dễ dàng nâng cấp Bazel và các quy tắc.
Quy trình di chuyển có thể quản lý
Mặc dù rõ ràng là không thể đảm bảo khả năng tương thích giữa mọi phiên bản Bazel và mọi phiên bản của quy tắc, nhưng mục tiêu của chúng tôi là đảm bảo rằng quy trình di chuyển vẫn có thể quản lý được đối với người dùng Bazel. Quy trình di chuyển có thể quản lý được xác định là quy trình mà người dùng không bắt buộc phải nâng cấp đồng thời phiên bản chính của quy tắc và phiên bản chính của Bazel, nhờ đó cho phép người dùng xử lý các thay đổi không tương thích từ một nguồn tại một thời điểm.
Ví dụ: với ma trận tương thích sau:
- Việc di chuyển từ rules_foo 1.x + Bazel 4.x sang rules_foo 2.x + Bazel 5.x không được coi là dễ quản lý, vì người dùng cần nâng cấp phiên bản chính của rules_foo và Bazel cùng một lúc.
- Việc di chuyển từ rules_foo 2.x + Bazel 5.x sang rules_foo 3.x + Bazel 6.x được coi là có thể quản lý, vì người dùng có thể nâng cấp rules_foo từ 2.x lên 3.x mà không thay đổi phiên bản Bazel chính, sau đó nâng cấp Bazel từ 5.x lên 6.x.
| rules_foo 1.x | rules_foo 2.x | rules_foo 3.x | ĐẦU | |
|---|---|---|---|---|
| Bazel 4.x | ✅ | ❌ | ❌ | ❌ |
| Bazel 5.x | ❌ | ✅ | ✅ | ❌ |
| Bazel 6.x | ❌ | ❌ | ✅ | ✅ |
| ĐẦU | ❌ | ❌ | ❌ | ✅ |
❌: Không có phiên bản nào của phiên bản quy tắc chính tương thích với bản phát hành LTS của Bazel.
✅: Ít nhất một phiên bản của quy tắc tương thích với phiên bản mới nhất của bản phát hành LTS Bazel.
Các phương pháp hay nhất
Là tác giả của các quy tắc Bazel, bạn có thể đảm bảo quy trình di chuyển dễ quản lý cho người dùng bằng cách làm theo các phương pháp hay nhất sau:
- Quy tắc này phải tuân theo Cách tạo phiên bản ngữ nghĩa: các phiên bản phụ của cùng một phiên bản chính đều tương thích ngược.
- Quy tắc tại HEAD phải tương thích với bản phát hành LTS mới nhất của Bazel.
- Quy tắc tại HEAD phải tương thích với Bazel tại HEAD. Để đạt được điều này, bạn có thể
- Thiết lập hoạt động kiểm thử CI của riêng bạn bằng Bazel tại HEAD
- Thêm dự án của bạn vào thử nghiệm hạ nguồn Bazel; nhóm Bazel sẽ gửi vấn đề cho dự án của bạn nếu các thay đổi gây lỗi trong Bazel ảnh hưởng đến dự án của bạn và bạn phải tuân thủ chính sách dự án hạ nguồn của chúng tôi để giải quyết vấn đề kịp thời.
- Phiên bản chính mới nhất của quy tắc phải tương thích với bản phát hành LTS mới nhất của Bazel.
- Một phiên bản chính mới của quy tắc phải tương thích với bản phát hành LTS Bazel gần đây nhất mà phiên bản chính trước đó của quy tắc hỗ trợ.
Đạt được mục tiêu 2 và 3 là nhiệm vụ quan trọng nhất vì điều này giúp bạn đạt được mục tiêu 4 và 5. một cách tự nhiên.
Để dễ dàng duy trì khả năng tương thích với cả Bazel tại HEAD và bản phát hành LTS mới nhất của Bazel, tác giả quy tắc có thể:
- Yêu cầu chuyển ngược các tính năng tương thích ngược sang bản phát hành LTS mới nhất, hãy xem quy trình phát hành để biết thêm thông tin.
- Sử dụng bazel_features để phát hiện tính năng Bazel.
Nói chung, với các phương pháp được đề xuất, các quy tắc sẽ có thể di chuyển cho các thay đổi không tương thích của Bazel và tận dụng các tính năng mới của Bazel tại HEAD mà không làm mất khả năng tương thích với bản phát hành LTS mới nhất của Bazel.