Các quy tắc Bazel Starlark có thể làm hỏng khả năng tương thích với các bản phát hành Bazel LTS trong hai trường hợp sau:
- Quy tắc này làm hỏng khả năng tương thích với các bản phát hành LTS trong tương lai vì có một tính năng mà quy tắc đó phụ thuộc vào sẽ bị xoá khỏi Bazel tại HEAD.
- Quy tắc này làm hỏng khả năng tương thích với các bản phát hành LTS (hỗ trợ dài hạn) hiện tại hoặc cũ hơn vì một tính năng mà công cụ này phụ thuộc vào chỉ có trong các bản phát hành Bazel LTS mới hơn.
Trong khi đó, chính quy tắc này có thể gửi các thay đổi không tương thích cho người dùng dưới dạng tốt. 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 gây khó chịu cho người dùng Bazel. Chiến dịch này Trang 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 của Bazel và mọi phiên bản của quy tắc, mục tiêu của chúng tôi là đảm bảo rằng người dùng Bazel vẫn có thể quản lý quá trình di chuyển. Quá trình di chuyển có thể quản lý được định nghĩa là một quá trình trong đó người dùng không bắt buộc phải nâng cấp phiên bản lớn của GDPR cùng lúc với phiên bản lớn của Bazel, do đó 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 thì không được áp dụ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ý được, vì trước tiên, người dùng có thể nâng cấp rules_foo từ 2.x lên 3.x mà không cần 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 quy tắc chính nào tương thích với bản phát hành Bazel LTS.
✅: Í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 Bazel LTS.
Các phương pháp hay nhất
Là tác giả 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 Tạo phiên bản ngữ nghĩa: các phiên bản nhỏ của cùng một phiên bản lớn phải 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 của Bazel mới nhất.
- 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 với Bazel tại HEAD
- Thêm dự án của bạn vào quy trình kiểm thử ngược dòng của Bazel; nhóm Bazel sẽ gửi vấn đề cho dự án của bạn nếu các thay đổi có thể gây lỗi trong Bazel ảnh hưởng đến dự án của bạn. Ngoài ra, bạn phải tuân thủ chính sách về dự án ngược dòng của chúng tôi để giải quyết vấn đề kịp thời.
- Phiên bản lớn mới nhất của quy tắc phải tương thích với Bản phát hành LTS của Bazel.
- Phiên bản lớn mới của quy tắc phải tương thích với bản phát hành LTS Bazel mới nhất được hỗ trợ bởi phiên bản lớn trước đó của quy tắc.
Đạt được 2. và 3. là nhiệm vụ quan trọng nhất vì nó cho phép đạt được 4. và 5 điểm. 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 Bazel LTS mới nhất, tác giả quy tắc có thể:
- Yêu cầu các tính năng có khả năng tương thích ngược để chuyển về phiên bản LTS mới nhất bản phát hành, hãy xem quy trình phát hành để biết thêm chi tiết.
- Sử dụng bazel_features là phát hiện tính năng Bazel.
Nhìn 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 với Bazel và tận dụng các tính năng Bazel mới tại HEAD mà không làm giảm khả năng tương thích với bản phát hành Bazel LTS mới nhất.