ความเข้ากันได้ของกฎ

รายงานปัญหา ดูแหล่งที่มา รุ่น Nightly · 7.4 7.3 · 7.2 · 7.1 · 7.0 · 6.5

กฎ Starlark ของ Bazel อาจทำให้ใช้งานร่วมกับรุ่น LTS ของ Bazel ไม่ได้ใน 2 สถานการณ์ต่อไปนี้

  1. กฎดังกล่าวทำให้ใช้งานร่วมกับรุ่น LTS ในอนาคตไม่ได้เนื่องจากมีการนําฟีเจอร์ที่กฎดังกล่าวใช้อยู่ออกจาก Bazel ที่ HEAD
  2. กฎเข้ากันไม่ได้กับรุ่น 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 rules_foo 2.x กฎ_foo 3.x HEAD
Bazel 4.X ✅ ❌ ❌ ❌
Bazel 5.X ❌ ✅ ✅ ❌
Bazel 6.x ❌ ❌ ✅ ✅
HEAD ❌ ❌ ❌ ✅

❌: กฎเวอร์ชันหลักไม่มีเวอร์ชันใดที่เข้ากันได้กับรุ่น LTS ของ Bazel

✅: กฎอย่างน้อย 1 เวอร์ชันที่เข้ากันได้กับเวอร์ชันล่าสุด รุ่น Bazel LTS

แนวทางปฏิบัติแนะนำ

ในฐานะผู้เขียนกฎ Bazel คุณสามารถทำให้ผู้ใช้ดำเนินการย้ายข้อมูลได้อย่างราบรื่นโดยทำตามแนวทางปฏิบัติแนะนำต่อไปนี้

  1. กฎควรเป็นไปตามการกำหนดเวอร์ชันทางอรรถศาสตร์: เวอร์ชันย่อยของเวอร์ชันหลักเดียวกันจะใช้งานร่วมกันได้ย้อนหลัง
  2. กฎที่ HEAD ควรใช้ได้กับ Bazel LTS รุ่นล่าสุด
  3. กฎที่ HEAD ควรใช้ได้กับ Bazel ที่ HEAD เพื่อให้บรรลุเป้าหมายนี้ คุณสามารถ
    • ตั้งค่าการทดสอบ CI ของคุณเองด้วย Bazel ที่ HEAD
    • เพิ่มโปรเจ็กต์ของคุณในการทดสอบดาวน์สตรีม Bazel โดยทีม Bazel จะรายงานปัญหาไปยังโปรเจ็กต์ของคุณหากการเปลี่ยนแปลงที่ทำให้เกิดข้อขัดข้องใน Bazel ส่งผลต่อโปรเจ็กต์ของคุณ และคุณต้องปฏิบัติตามนโยบายโปรเจ็กต์ดาวน์สตรีมเพื่อแก้ไขปัญหาอย่างทันท่วงที
  4. กฎเวอร์ชันหลักล่าสุดจะต้องเข้ากันได้กับเวอร์ชันล่าสุด รุ่น Bazel LTS
  5. กฎเวอร์ชันหลักใหม่ควรเข้ากันได้กับ LTS ของ Bazel เวอร์ชันล่าสุด รุ่นที่รองรับโดยกฎเวอร์ชันหลักก่อนหน้านี้

การบรรลุข้อ 2 และ 3 เป็นงานที่สําคัญที่สุด เนื่องจากจะช่วยให้บรรลุข้อ 4 และ 5 ได้ อย่างเป็นธรรมชาติ

เพื่อให้เข้ากันได้กับทั้ง Bazel ที่ HEAD และเวอร์ชันล่าสุดได้ง่ายขึ้น รุ่น Bazel LTS ผู้เขียนกฎจะทำสิ่งต่อไปนี้ได้

  • หากต้องการขอให้นําฟีเจอร์ที่เข้ากันได้แบบย้อนหลังไปพอร์ตไปยังรุ่น LTS ล่าสุด โปรดดูรายละเอียดเพิ่มเติมในกระบวนการเผยแพร่
  • ใช้ bazel_features เพื่อทำการตรวจหาฟีเจอร์ Bazel

โดยทั่วไป ด้วยวิธีการที่แนะนำ กฎควรที่จะสามารถย้ายข้อมูลสำหรับ Bazel เปลี่ยนแปลงที่เข้ากันไม่ได้ และใช้ประโยชน์จากฟีเจอร์ใหม่ของ Bazel ที่ HEAD โดยไม่มี ลดความเข้ากันได้กับ Bazel LTS รุ่นล่าสุด