สำหรับสมาชิก
- archive_override
- bazel_dep
- git_override
- local_path_override
- โมดูล
- multiple_version_override
- register_execution_platforms
- register_toolchains
- single_version_override
- use_extension
- use_repo
- use_repo_rule
archive_override
None
archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)
ระบุว่าทรัพยากร Dependency นี้ควรมาจากไฟล์ที่เก็บถาวร (zip, gzip ฯลฯ) ในตำแหน่งที่เจาะจง ไม่ใช่จากรีจิสทรี คำสั่งนี้จะมีผลต่อโมดูลรากเท่านั้น กล่าวคือ หากผู้อื่นใช้โมดูลหนึ่งเป็นทรัพยากร Dependency ระบบก็จะไม่สนใจการลบล้างของโมดูลนั้น
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
module_name
|
ต้องระบุ ชื่อของทรัพยากร Dependency ของโมดูล Bazel ที่จะใช้การลบล้างนี้ |
urls
|
string หรือทำซ้ำได้ของ strings; ต้องระบุ URL ของที่เก็บถาวร ซึ่งอาจเป็น http(s):// หรือ URL file:// |
integrity
|
ค่าเริ่มต้นคือ '' checksum ของไฟล์ที่เก็บถาวรในรูปแบบ Subresource Integrity |
strip_prefix
|
ค่าเริ่มต้นคือ '' คำนำหน้าไดเรกทอรีที่จะตัดออกจากไฟล์ที่แยก |
patches
|
เรียงสตริงได้ ค่าเริ่มต้นคือ [] รายการป้ายกำกับที่ชี้ไปยังไฟล์แพตช์ที่จะใช้สำหรับโมดูลนี้ ไฟล์แพตช์ต้องอยู่ในโครงสร้างแหล่งที่มาของโปรเจ็กต์ระดับบนสุด ซึ่งจะใช้ตามลำดับรายการ |
patch_cmds
|
ซ้ำกันได้ของสตริง
ค่าเริ่มต้นคือ [] ลำดับของคำสั่ง Bash ที่จะใช้ใน Linux/Macos หลังจากใช้แพตช์ |
patch_strip
|
ค่าเริ่มต้นคือ 0 เหมือนกับ --strip ของแพตช์ Unix |
bazel_dep
None
bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)
ประกาศทรัพยากร Dependency โดยตรงในโมดูล Bazel อื่น
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
name
|
ต้องระบุ ชื่อของโมดูลที่จะเพิ่มเป็นรายการทรัพยากร Dependency โดยตรง |
version
|
ค่าเริ่มต้นคือ '' เวอร์ชันของโมดูลที่จะเพิ่มเป็นทรัพยากร Dependency โดยตรง |
max_compatibility_level
|
ค่าเริ่มต้นคือ -1 compatibility_level สูงสุดที่สนับสนุนสำหรับโมดูลที่จะเพิ่มเป็นทรัพยากร Dependency โดยตรง เวอร์ชันของโมดูลจะแสดงถึงระดับความเข้ากันได้ขั้นต่ำที่รองรับ รวมถึงระดับสูงสุดหากไม่ได้ระบุแอตทริบิวต์นี้
|
repo_name
|
ค่าเริ่มต้นคือ '' ชื่อของที่เก็บภายนอกที่แสดงถึงทรัพยากร Dependency นี้ ซึ่งจะเป็นชื่อโมดูลโดยค่าเริ่มต้น |
dev_dependency
|
ค่าเริ่มต้นคือ False หากเป็น "จริง" ระบบจะไม่สนใจการอ้างอิงนี้หากโมดูลปัจจุบันไม่ใช่โมดูลรูทหรือเปิดใช้ "--ignore_dev_dependency" |
git_override
None
git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0, init_submodules=False)
ระบุว่าทรัพยากร Dependency ควรมาจากคอมมิตของที่เก็บ Git คำสั่งนี้จะมีผลต่อโมดูลรากเท่านั้น กล่าวคือ หากผู้อื่นใช้โมดูลหนึ่งเป็นทรัพยากร Dependency ระบบก็จะไม่สนใจการลบล้างของโมดูลนั้น
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
module_name
|
ต้องระบุ ชื่อของทรัพยากร Dependency ของโมดูล Bazel ที่จะใช้การลบล้างนี้ |
remote
|
ต้องระบุ URL ของที่เก็บ Git ระยะไกล |
commit
|
ค่าเริ่มต้นคือ '' คอมมิตที่ควรจะมีการชำระเงิน |
patches
|
เรียงสตริงได้ ค่าเริ่มต้นคือ [] รายการป้ายกำกับที่ชี้ไปยังไฟล์แพตช์ที่จะใช้สำหรับโมดูลนี้ ไฟล์แพตช์ต้องอยู่ในโครงสร้างแหล่งที่มาของโปรเจ็กต์ระดับบนสุด ซึ่งจะใช้ตามลำดับรายการ |
patch_cmds
|
ซ้ำกันได้ของสตริง
ค่าเริ่มต้นคือ [] ลำดับของคำสั่ง Bash ที่จะใช้ใน Linux/Macos หลังจากใช้แพตช์ |
patch_strip
|
ค่าเริ่มต้นคือ 0 เหมือนกับ --strip ของแพตช์ Unix |
init_submodules
|
ค่าเริ่มต้นคือ False กำหนดว่าโมดูลย่อยในที่เก็บที่ดึงข้อมูลมาควรเริ่มต้นแบบเกิดซ้ำหรือไม่ |
local_path_override
None
local_path_override(module_name, path)
ระบุว่าทรัพยากร Dependency ควรมาจากไดเรกทอรีบางรายการในดิสก์ภายใน คำสั่งนี้จะมีผลต่อโมดูลรากเท่านั้น กล่าวคือ หากผู้อื่นใช้โมดูลหนึ่งเป็นทรัพยากร Dependency ระบบก็จะไม่สนใจการลบล้างของโมดูลนั้น
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
module_name
|
ต้องระบุ ชื่อของทรัพยากร Dependency ของโมดูล Bazel ที่จะใช้การลบล้างนี้ |
path
|
ต้องระบุ เส้นทางไปยังไดเรกทอรีที่มีโมดูลนี้อยู่ |
โมดูล
None
module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])
ประกาศคุณสมบัติบางอย่างของโมดูล Bazel ที่แสดงโดยที่เก็บ Bazel ปัจจุบัน พร็อพเพอร์ตี้เหล่านี้เป็นข้อมูลเมตาที่สำคัญของโมดูล (เช่น ชื่อและเวอร์ชัน) หรือส่งผลต่อลักษณะการทำงานของโมดูลปัจจุบันและการอ้างอิง ควรมีการเรียกใช้หลายครั้ง โดยสามารถละได้เฉพาะในกรณีที่โมดูลนี้เป็นโมดูลรูท (เช่น ในกรณีของโมดูลอื่นจะไม่ขึ้นกับโมดูลอื่น)
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
name
|
ค่าเริ่มต้นคือ '' ชื่อของโมดูล สามารถละไว้ได้เฉพาะในกรณีที่โมดูลนี้เป็นโมดูลราก (เช่น ในกรณีของโมดูลอื่นจะไม่ขึ้นกับโมดูลอื่น) ชื่อโมดูลที่ถูกต้องต้องมีลักษณะดังนี้ 1) มีแต่ตัวอักษรพิมพ์เล็ก (a-z) ตัวเลข (0-9) จุด (.) ขีดกลาง (-) และขีดล่าง (_) 2) ขึ้นต้นด้วยตัวอักษรพิมพ์เล็ก 3) ลงท้ายด้วยตัวอักษรพิมพ์เล็กหรือตัวเลข |
version
|
ค่าเริ่มต้นคือ '' เวอร์ชันของโมดูล สามารถละไว้ได้เฉพาะในกรณีที่โมดูลนี้เป็นโมดูลราก (เช่น ในกรณีของโมดูลอื่นจะไม่ขึ้นกับโมดูลอื่น) เวอร์ชันต้องอยู่ในรูปแบบ SemVer บรรยากาศผ่อนคลาย ดูรายละเอียดเพิ่มเติมได้ที่เอกสารประกอบ |
compatibility_level
|
ค่าเริ่มต้นคือ 0 ระดับความเข้ากันได้ของโมดูล ซึ่งควรเปลี่ยนนี้ทุกครั้งที่มีการทำการเปลี่ยนแปลงที่สำคัญซึ่งใช้ร่วมกันไม่ได้ โดยพื้นฐานแล้วโมดูลนี้เป็น "เวอร์ชันหลัก" ของโมดูลนี้ในแง่ของ SemVer เว้นแต่ว่าโมดูลดังกล่าวไม่ได้ฝังลงในสตริงเวอร์ชัน แต่เป็นช่องแยกต่างหาก โมดูลที่มีระดับความเข้ากันได้แตกต่างกันจะมีส่วนร่วมในการแปลงเวอร์ชันเสมือนเป็นโมดูลที่ใช้ชื่อต่างกัน แต่กราฟทรัพยากร Dependency ไม่สามารถมีโมดูลหลายรายการที่มีชื่อเดียวกันแต่มีระดับความเข้ากันได้ต่างกัน (เว้นแต่ว่า multiple_version_override จะมีผลอยู่) โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบ
|
repo_name
|
ค่าเริ่มต้นคือ '' ชื่อของที่เก็บที่แสดงถึงโมดูลนี้ตามที่เห็นโดยโมดูล โดยค่าเริ่มต้น ชื่อของที่เก็บจะเป็นชื่อของโมดูล คุณสามารถระบุเพื่อลดความซับซ้อนในการย้ายข้อมูลสำหรับโปรเจ็กต์ที่ใช้ชื่อที่เก็บของตัวเองซึ่งต่างจากชื่อโมดูล |
bazel_compatibility
|
สตริงซ้ำกันได้
ค่าเริ่มต้นคือ [] รายการเวอร์ชันของ Bazel ที่อนุญาตให้ผู้ใช้ประกาศว่าเวอร์ชัน Bazel ใดที่เข้ากันได้กับโมดูลนี้ การดำเนินการนี้จะไม่ส่งผลต่อความละเอียดของทรัพยากร Dependency แต่ bzlmod จะใช้ข้อมูลนี้เพื่อตรวจสอบว่าเวอร์ชัน Bazel ปัจจุบันของคุณรองรับหรือไม่ รูปแบบของค่านี้คือสตริงของค่าข้อจำกัดบางส่วนที่คั่นด้วยคอมมา ระบบรองรับข้อจำกัด 3 ประการดังนี้ <=X.X.X: เวอร์ชัน Bazel ต้องเท่ากับหรือเก่ากว่า X.X.X ซึ่งจะใช้เมื่อมีการเปลี่ยนแปลงที่ทราบว่าเข้ากันไม่ได้ในเวอร์ชันที่ใหม่กว่า >=X.X.X: เวอร์ชัน Bazel ต้องเท่ากับหรือใหม่กว่า X.X.X ใช้เมื่อคุณต้องใช้ฟีเจอร์บางอย่างซึ่งมีให้ตั้งแต่ X.X.X. -X.X.X เท่านั้น: Bazel เวอร์ชัน X.X.X ใช้งานไม่ได้ ใช้เมื่อมีข้อบกพร่องใน X.X.X ที่ทำให้เสียหาย แต่ได้รับการแก้ไขในเวอร์ชันหลังๆ |
multiple_version_override
None
multiple_version_override(module_name, versions, registry='')
ระบุว่าทรัพยากร Dependency ควรมาจากรีจิสทรีอยู่แล้ว แต่ทรัพยากรดังกล่าวควรได้รับอนุญาตให้มีอยู่หลายเวอร์ชัน โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบ คำสั่งนี้จะมีผลต่อโมดูลรากเท่านั้น กล่าวคือ หากผู้อื่นใช้โมดูลหนึ่งเป็นทรัพยากร Dependency ระบบก็จะไม่สนใจการลบล้างของโมดูลนั้น
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
module_name
|
ต้องระบุ ชื่อของทรัพยากร Dependency ของโมดูล Bazel ที่จะใช้การลบล้างนี้ |
versions
|
ซ้ำกันได้ของ string
ต้องระบุ ระบุเวอร์ชันที่อนุญาตให้ใช้ร่วมกันได้อย่างชัดแจ้ง เวอร์ชันเหล่านี้ต้องอยู่ในการเลือกล่วงหน้าสำหรับกราฟทรัพยากร Dependency อยู่แล้ว ระบบจะ "อัปเกรด" ทรัพยากร Dependency ของโมดูลนี้เป็นเวอร์ชันที่ได้รับอนุญาตสูงกว่าซึ่งใกล้เคียงที่สุดในระดับความเข้ากันได้เดียวกัน ในขณะที่ทรัพยากร Dependency ที่มีเวอร์ชันสูงกว่าเวอร์ชันที่อนุญาตที่ระดับความเข้ากันได้เดียวกันจะทำให้เกิดข้อผิดพลาด |
registry
|
ค่าเริ่มต้นคือ '' ลบล้างรีจิสทรีสำหรับโมดูลนี้ ควรใช้รีจิสทรีที่ระบุแทนการค้นหาโมดูลนี้จากรายการรีจิสทรีเริ่มต้น |
register_execution_platforms
None
register_execution_platforms(dev_dependency=False, *platform_labels)
ระบุแพลตฟอร์มการดำเนินการที่กำหนดไว้แล้วที่จะลงทะเบียนเมื่อเลือกโมดูลนี้ ควรเป็นรูปแบบเป้าหมายสัมบูรณ์ (เช่น เริ่มต้นด้วย @
หรือ //
) ดูข้อมูลเพิ่มเติมได้ที่ความละเอียดของ Toolchain
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
dev_dependency
|
ค่าเริ่มต้นคือ False หากเป็น "จริง" แพลตฟอร์มการดำเนินการจะไม่ลงทะเบียนหากโมดูลปัจจุบันไม่ใช่โมดูลรูทหรือเปิดใช้ "--ignore_dev_dependency" |
platform_labels
|
sequence ของ strings
ต้องระบุ ป้ายกำกับของแพลตฟอร์มที่จะลงทะเบียน |
register_toolchains
None
register_toolchains(dev_dependency=False, *toolchain_labels)
ระบุ Toolchain ที่กำหนดไว้ล่วงหน้าที่จะลงทะเบียนเมื่อเลือกโมดูลนี้ ควรเป็นรูปแบบเป้าหมายสัมบูรณ์ (เช่น เริ่มต้นด้วย @
หรือ //
) ดูข้อมูลเพิ่มเติมได้ที่ความละเอียดของ Toolchain
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
dev_dependency
|
ค่าเริ่มต้นคือ False หากเป็น "จริง" จะไม่มีการลงทะเบียน Toolchains หากโมดูลปัจจุบันไม่ใช่โมดูลรูทหรือเปิดใช้ "--ignore_dev_dependency" |
toolchain_labels
|
sequence ของ strings; ต้องระบุ ป้ายกำกับของ Toolchain ที่จะลงทะเบียน ป้ายกำกับอาจมี :all ได้ ซึ่งในกรณีนี้ เป้าหมายที่ระบุเครื่องมือเชนทั้งหมดในแพ็กเกจจะได้รับการลงทะเบียนโดยเรียงลำดับแบบพจนานุกรมตามชื่อ
|
single_version_override
None
single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)
ระบุว่าทรัพยากร Dependency ควรมาจากรีจิสทรี แต่ควรมีการปักหมุดเวอร์ชัน หรือลบล้างรีจิสทรี หรือรายการแพตช์ที่ใช้ คำสั่งนี้จะมีผลต่อโมดูลรากเท่านั้น กล่าวคือ หากผู้อื่นใช้โมดูลหนึ่งเป็นทรัพยากร Dependency ระบบก็จะไม่สนใจการลบล้างของโมดูลนั้น
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
module_name
|
ต้องระบุ ชื่อของทรัพยากร Dependency ของโมดูล Bazel ที่จะใช้การลบล้างนี้ |
version
|
ค่าเริ่มต้นคือ '' ลบล้างเวอร์ชันที่ประกาศของโมดูลนี้ในกราฟทรัพยากร Dependency กล่าวคือ โมดูลนี้จะถูก "ปักหมุด" ไว้กับเวอร์ชันการลบล้างนี้ คุณละเว้นแอตทริบิวต์นี้ได้หากทุกแอตทริบิวต์ต้องการลบล้างรีจิสทรีหรือแพตช์ |
registry
|
ค่าเริ่มต้นคือ '' ลบล้างรีจิสทรีสำหรับโมดูลนี้ ควรใช้รีจิสทรีที่ระบุแทนการค้นหาโมดูลนี้จากรายการรีจิสทรีเริ่มต้น |
patches
|
เรียงสตริงได้ ค่าเริ่มต้นคือ [] รายการป้ายกำกับที่ชี้ไปยังไฟล์แพตช์ที่จะใช้สำหรับโมดูลนี้ ไฟล์แพตช์ต้องอยู่ในโครงสร้างแหล่งที่มาของโปรเจ็กต์ระดับบนสุด ซึ่งจะใช้ตามลำดับรายการ |
patch_cmds
|
ซ้ำกันได้ของสตริง
ค่าเริ่มต้นคือ [] ลำดับของคำสั่ง Bash ที่จะใช้ใน Linux/Macos หลังจากใช้แพตช์ |
patch_strip
|
ค่าเริ่มต้นคือ 0 เหมือนกับ --strip ของแพตช์ Unix |
use_extension
module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)แสดงผลออบเจ็กต์พร็อกซีที่แสดงถึงส่วนขยายโมดูล โดยสามารถเรียกใช้เมธอดของส่วนขยายเพื่อสร้างแท็กส่วนขยายโมดูลได้
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
extension_bzl_file
|
ต้องระบุ ป้ายกำกับไปยังไฟล์ Starlark ที่กำหนดส่วนขยายของโมดูล |
extension_name
|
ต้องระบุ ชื่อของส่วนขยายโมดูลที่จะใช้ โดยไฟล์ Starlark จะต้องส่งออกสัญลักษณ์ที่มีชื่อนี้ |
dev_dependency
|
ค่าเริ่มต้นคือ False หากเป็น "จริง" ระบบจะไม่สนใจการใช้ส่วนขยายโมดูลนี้หากโมดูลปัจจุบันไม่ใช่โมดูลรูทหรือเปิดใช้ "--ignore_dev_dependency" |
isolate
|
ค่าเริ่มต้นคือ False ทดลอง พารามิเตอร์นี้อยู่ในขั้นทดลองและอาจเปลี่ยนแปลงได้ตลอดเวลา โปรดอย่าพึ่งพา คุณสามารถเปิดใช้การทดสอบโดยตั้งค่า ---experimental_isolated_extension_usages หากเป็นจริง การใช้งานส่วนขยายโมดูลนี้จะแยกออกจากการใช้งานอื่นๆ ทั้งหมด ทั้งในโมดูลนี้และโมดูลอื่นๆ แท็กที่สร้างขึ้นสำหรับการใช้งานนี้จะไม่ส่งผลต่อการใช้งานอื่นๆ และที่เก็บที่ส่วนขยายสร้างขึ้นสำหรับการใช้งานนี้จะแตกต่างจากที่เก็บอื่นๆ ทั้งหมดที่ส่วนขยายสร้างขึ้น ปัจจุบันพารามิเตอร์นี้อยู่ระหว่างการทดสอบและใช้ได้กับแฟล็ก |
use_repo
None
use_repo(extension_proxy, *args, **kwargs)
นำเข้าที่เก็บอย่างน้อย 1 รายการที่สร้างจากส่วนขยายโมดูลที่ระบุไปยังขอบเขตของโมดูลปัจจุบัน
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
extension_proxy
|
ต้องระบุ ออบเจ็กต์พร็อกซีส่วนขยายโมดูลที่แสดงผลโดยการเรียก use_extension
|
args
|
ต้องระบุ ชื่อของที่เก็บที่จะนำเข้า |
kwargs
|
ต้องระบุ ระบุที่เก็บบางรายการที่จะนำเข้าไปยังขอบเขตของโมดูลปัจจุบันโดยใช้ชื่ออื่น คีย์ควรเป็นชื่อที่จะใช้ในขอบเขตปัจจุบัน ส่วนค่าควรเป็นชื่อเดิมที่ส่งออกโดยส่วนขยายโมดูล |
use_repo_rule
repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)แสดงผลค่าพร็อกซีที่สามารถเรียกใช้โดยตรงในไฟล์ MODULE.bazel เป็นกฎที่เก็บ อย่างน้อย 1 ครั้ง ที่เก็บที่สร้างขึ้นในลักษณะนี้จะปรากฏต่อโมดูลปัจจุบันเท่านั้น ภายใต้ชื่อที่ประกาศโดยใช้แอตทริบิวต์
name
บนพร็อกซี นอกจากนี้ แอตทริบิวต์บูลีน dev_dependency
แบบไม่เจาะจงปลายทางยังใช้บนพร็อกซีได้ด้วยเพื่อระบุว่าระบบจะสร้างที่เก็บบางรายการเฉพาะเมื่อโมดูลปัจจุบันเป็นโมดูลรูทเท่านั้น
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
repo_rule_bzl_file
|
ต้องระบุ ป้ายกำกับไปยังไฟล์ Starlark ที่กำหนดกฎที่เก็บ |
repo_rule_name
|
ต้องระบุ ชื่อของกฎที่เก็บที่จะใช้ โดยไฟล์ Starlark จะต้องส่งออกสัญลักษณ์ที่มีชื่อนี้ |