กฎ Starlark ของ Bazel อาจทำให้ใช้งานร่วมกับรุ่น LTS ของ Bazel ไม่ได้ใน 2 สถานการณ์ต่อไปนี้
- กฎนี้จะเข้ากันไม่ได้กับรุ่น LTS รุ่นต่อๆ ไปเนื่องจากฟีเจอร์ ที่ขึ้นอยู่กับ ถูกนำออกจาก Bazel ที่ HEAD
- กฎเข้ากันไม่ได้กับรุ่น LTS ปัจจุบันหรือรุ่นเก่ากว่าเนื่องจาก ฟีเจอร์ที่ต้องใช้มีใน Bazel LTS รุ่นใหม่เท่านั้น
ในขณะเดียวกัน กฎเองก็อาจส่งการเปลี่ยนแปลงที่เข้ากันไม่ได้ให้กับผู้ใช้ได้เช่นกัน เมื่อรวมกับการเปลี่ยนแปลงที่ทำให้เกิดข้อขัดข้องใน Bazel การอัปเกรดเวอร์ชันกฎและ Bazel มักทำให้ผู้ใช้ Bazel หงุดหงิด หน้านี้อธิบายวิธีที่ผู้เขียนกฎควรรักษาความเข้ากันได้ของกฎกับ Bazel เพื่อให้ผู้ใช้อัปเกรด Bazel และกฎได้ง่ายขึ้น
กระบวนการย้ายข้อมูลที่จัดการได้
ในขณะที่คุณไม่สามารถรับประกันความเข้ากันได้ระหว่างทุกๆ ของ Bazel และกฎทุกเวอร์ชัน เป้าหมายของเราคือการดูแลให้ ผู้ใช้ Bazel ยังคงสามารถจัดการกระบวนการย้ายข้อมูลได้ การย้ายข้อมูลที่จัดการได้ กระบวนการหมายถึงกระบวนการที่ผู้ใช้ไม่ได้ถูกบังคับให้อัปเกรด เวอร์ชันหลักของกฎ และเวอร์ชันหลักของ Bazel พร้อมกัน ด้วยเหตุนี้ ทำให้ผู้ใช้สามารถจัดการการเปลี่ยนแปลงที่ทำงานร่วมกันไม่ได้ จากแหล่งข้อมูลครั้งละ 1 แห่ง
ตัวอย่างเช่น มีเมทริกซ์ความเข้ากันได้ต่อไปนี้
- การย้ายข้อมูลจาก rules_foo 1.x + Bazel 4.x ไปยัง rules_foo 2.x + Bazel 5.x ถือว่าจัดการได้ยาก เนื่องจากผู้ใช้ต้องอัปเกรดเวอร์ชันหลักของ rules_foo และ Bazel พร้อมกัน
- การย้ายข้อมูลจาก rules_foo 2.x + Bazel 5.x ไปยัง rules_foo 3.x + Bazel 6.x ถือว่าจัดการได้ เนื่องจากผู้ใช้สามารถอัปเกรด rules_foo จาก 2.x เป็น 3.x ได้โดยไม่ต้องเปลี่ยนเวอร์ชันหลักของ Bazel จากนั้นจึงอัปเกรด Bazel จาก 5.x เป็น 6.x
| rules_foo 1.x | กฎ_foo 2.x | กฎ_foo 3.x | HEAD | |
|---|---|---|---|---|
| Bazel 4.x | ✅ | ❌ | ❌ | ❌ |
| Bazel 5.X | ❌ | ✅ | ✅ | ❌ |
| Bazel 6.x | ❌ | ❌ | ✅ | ✅ |
| HEAD | ❌ | ❌ | ❌ | ✅ |
❌: ไม่มีเวอร์ชันกฎหลักที่เข้ากันได้กับ Bazel LTS
✅: กฎอย่างน้อย 1 เวอร์ชันที่เข้ากันได้กับเวอร์ชันล่าสุด รุ่น Bazel LTS
แนวทางปฏิบัติแนะนำ
ในฐานะผู้เขียนกฎ Bazel คุณสามารถทำให้ผู้ใช้ดำเนินการย้ายข้อมูลได้อย่างราบรื่นโดยทำตามแนวทางปฏิบัติแนะนำต่อไปนี้
- กฎควรเป็นไปตามความหมาย การกำหนดเวอร์ชัน: เวอร์ชันย่อยของเวอร์ชันเดียวกัน เวอร์ชันหลักสามารถเข้ากันได้แบบย้อนหลัง
- กฎที่ HEAD ควรใช้ได้กับ Bazel LTS รุ่นล่าสุด
- กฎที่ HEAD ควรใช้ได้กับ Bazel ที่ HEAD คุณทำสิ่งต่อไปนี้ได้เพื่อบรรลุเป้าหมายนี้
- ตั้งค่าการทดสอบ CI ของคุณเองกับ Bazel ที่ HEAD
- เพิ่มโปรเจ็กต์ของคุณในการทดสอบดาวน์สตรีม Bazel โดยทีม Bazel จะรายงานปัญหาไปยังโปรเจ็กต์ของคุณหากการเปลี่ยนแปลงที่ทำให้เกิดข้อขัดข้องใน Bazel ส่งผลต่อโปรเจ็กต์ของคุณ และคุณต้องปฏิบัติตามนโยบายโปรเจ็กต์ดาวน์สตรีมเพื่อแก้ไขปัญหาอย่างทันท่วงที
- กฎเวอร์ชันหลักล่าสุดต้องเข้ากันได้กับรุ่น Bazel LTS ล่าสุด
- กฎเวอร์ชันหลักใหม่ควรเข้ากันได้กับ Bazel LTS เวอร์ชันล่าสุดที่กฎเวอร์ชันหลักก่อนหน้ารองรับ
การบรรลุข้อ 2 และ 3 เป็นงานที่สําคัญที่สุด เนื่องจากจะช่วยให้บรรลุข้อ 4 และ 5 ได้ อย่างเป็นธรรมชาติ
ผู้เขียนกฎสามารถดำเนินการต่อไปนี้เพื่อให้ใช้งานร่วมกับทั้ง Bazel ที่ HEAD และ Bazel LTS เวอร์ชันล่าสุดได้
- หากต้องการขอให้นําฟีเจอร์ที่เข้ากันได้แบบย้อนหลังไปพอร์ตไปยังรุ่น LTS ล่าสุด โปรดดูรายละเอียดเพิ่มเติมในกระบวนการเผยแพร่
- ใช้ bazel_features เพื่อทำการตรวจหาฟีเจอร์ Bazel
โดยทั่วไป ด้วยวิธีการที่แนะนำ กฎควรที่จะสามารถย้ายข้อมูลสำหรับ Bazel เปลี่ยนแปลงที่เข้ากันไม่ได้ และใช้ประโยชน์จากฟีเจอร์ใหม่ของ Bazel ที่ HEAD โดยไม่มี ลดความเข้ากันได้กับ Bazel LTS รุ่นล่าสุด