กฎที่เก็บ Git

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

โหลดฟังก์ชันต่อไปนี้ได้จาก @bazel_tools//tools/build_defs/repo:git.bzl

กฎสำหรับการโคลนที่เก็บ Git ภายนอก

git_repository

git_repository(name, branch, build_file, build_file_content, commit, init_submodules, patch_args,
               patch_cmds, patch_cmds_win, patch_tool, patches, recursive_init_submodules, remote,
               repo_mapping, shallow_since, strip_prefix, tag, verbose, workspace_file,
               workspace_file_content)

โคลนที่เก็บ Git ภายนอก

โคลนที่เก็บ Git, ตรวจสอบแท็กที่ระบุ หรือคอมมิต และ ทำให้เป้าหมายพร้อมสำหรับการเชื่อมโยง รวมถึงระบุรหัสของคอมมิตที่ดึงข้อมูลจริงและวันที่ของคอมมิตนั้น และแสดงผลพจนานุกรมที่มีพารามิเตอร์ซึ่งให้กฎเวอร์ชันที่ทําซ้ำได้ (ซึ่งไม่จำเป็นต้องเป็นแท็ก)

ก่อนอื่น Bazel จะพยายามดึงข้อมูลแบบไม่เจาะลึกเฉพาะการคอมมิตที่ระบุ ถ้าล้มเหลว (มักจะเป็นเพราะไม่มีการสนับสนุนของเซิร์ฟเวอร์) จะกลับไปใช้ ดึงข้อมูลที่เก็บอย่างเต็มรูปแบบ

ให้ใช้ http_archive เป็น git_repository เหตุผลมีดังนี้

กฎที่เก็บ Git ขึ้นอยู่กับ git(1) ของระบบในขณะที่เครื่องมือดาวน์โหลด HTTP สร้างขึ้น ลงใน Bazel และไม่มีทรัพยากร Dependency ของระบบ
http_archive รองรับรายการ urls เป็นมิเรอร์ และ git_repository รองรับเพียง remote รายการเดียว
http_archive ใช้ได้กับแคชที่เก็บ แต่ไม่ใช้ได้กับ git_repository ดูข้อมูลเพิ่มเติมที่ #5116

Attributes

`name`	ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับที่เก็บนี้
`branch`	สตริง ไม่บังคับ ในที่เก็บระยะไกลเพื่อตรวจสอบ ต้องระบุสาขา แท็ก หรือคอมมิตอย่างใดอย่างหนึ่งเท่านั้น
`build_file`	ป้ายกํากับ (ไม่บังคับ) ไฟล์ที่จะใช้เป็นไฟล์ BUILD สําหรับที่เก็บข้อมูลนี้ แอตทริบิวต์นี้เป็นป้ายกำกับแบบสัมบูรณ์ (ใช้ "@//" สําหรับที่เก็บข้อมูลหลัก) ไฟล์นี้ไม่จำเป็นต้องตั้งชื่อว่า BUILD แต่สามารถเป็น (ชื่ออย่างเช่น BUILD.new-repo-name อาจเหมาะที่จะแยกออกจากไฟล์ BUILD จริงของที่เก็บ
`build_file_content`	สตริง ไม่บังคับ เนื้อหาของไฟล์ BUILD สำหรับที่เก็บนี้
`commit`	String; ไม่บังคับ ให้ตรวจสอบ ต้องระบุ Branch, แท็ก หรือคอมมิตอย่างแม่นยำ
`init_submodules`	บูลีน ไม่บังคับ โคลนโมดูลย่อยในที่เก็บหรือไม่
`patch_args`	รายการสตริง ไม่บังคับ อาร์กิวเมนต์ที่กำหนดให้เครื่องมือแพตช์ ค่าเริ่มต้นจะเป็น -p0 แต่โดยปกติแล้วจะต้องใช้ -p1 สำหรับแพตช์ที่สร้างโดย git หากระบุอาร์กิวเมนต์ -p หลายรายการ อาร์กิวเมนต์สุดท้ายจะมีผล หากระบุอาร์กิวเมนต์อื่นที่ไม่ใช่ -p ไว้ Bazel จะกลับไปใช้เครื่องมือบรรทัดคำสั่งแพตช์แทนการใช้งานแพตช์ของ Bazel เมื่อกลับไปใช้เครื่องมือบรรทัดคำสั่งแพตช์และไม่ได้ระบุแอตทริบิวต์ Patch_tool ระบบจะใช้ "patch"
`patch_cmds`	รายการสตริง (ไม่บังคับ) ลำดับคำสั่ง Bash ที่จะใช้ใน Linux/Macos หลังจากติดตั้งแพตช์แล้ว
`patch_cmds_win`	รายการสตริง (ไม่บังคับ) ลำดับของคำสั่ง Powershell ที่จะนำไปใช้ใน Windows หลังจากใช้แพตช์ หากไม่ได้ตั้งค่าแอตทริบิวต์นี้ ระบบจะเรียกใช้ patch_cmds ใน Windows ซึ่งต้องมีไฟล์ Bash อยู่
`patch_tool`	สตริง ไม่บังคับ ยูทิลิตีการแก้ไข(1) ที่จะใช้ หากระบุไว้ Bazel จะใช้เครื่องมือแพตช์ที่ระบุแทนการติดตั้งใช้งานแพตช์ของ Bazel เนทีฟ
`patches`	รายการป้ายกำกับ (ไม่บังคับ) รายการไฟล์ที่จะใช้เป็นแพตช์หลังจากแตกไฟล์เก็บถาวร โดยค่าเริ่มต้น ปลั๊กอินจะใช้การติดตั้งแพตช์ของ Bazel ซึ่งไม่รองรับการจับคู่ Fuzz Match และแพตช์ไบนารี แต่ Bazel จะกลับไปใช้เครื่องมือบรรทัดคำสั่งแพตช์หากมีการระบุแอตทริบิวต์ "patch_tool" หรือมีอาร์กิวเมนต์อื่นที่ไม่ใช่ "-p" ในแอตทริบิวต์ "patch_args"
`recursive_init_submodules`	บูลีน ไม่บังคับ ต้องการโคลนโมดูลย่อยแบบซ้ำที่เก็บหรือไม่
`remote`	String; ต้องระบุ URI ของที่เก็บ Git ระยะไกล
`repo_mapping`	Dictionary: String -> String; ต้องระบุ พจนานุกรมจากชื่อที่เก็บในเครื่องเป็นชื่อที่เก็บส่วนกลาง ซึ่งช่วยให้ควบคุมการแก้ไขข้อกำหนดของพื้นที่ทำงานสำหรับข้อกำหนดของที่เก็บข้อมูลนี้ได้ ตัวอย่างเช่น รายการ `"@foo": "@bar"` ประกาศว่าเมื่อใดก็ตามที่ที่เก็บข้อมูลนี้ใช้ @foo (เช่น ใช้ @foo//some:target) ก็ควรแก้ไขการพึ่งพานั้นภายใน @bar ที่ประกาศไว้ทั่วโลก ("@bar//some:target")
`shallow_since`	String; ไม่บังคับ วันที่ที่ไม่บังคับ ไม่ใช่หลังวันที่คอมมิตที่ระบุ ไม่อนุญาตอาร์กิวเมนต์หากมีการระบุแท็กหรือสาขา (ซึ่งสามารถโคลนด้วย --depth=1 ได้เสมอ) การตั้งค่าวันที่ดังกล่าวใกล้กับคอมมิตที่ระบุอาจทําให้โคลนของที่เก็บแบบตื้นได้ แม้ว่าเซิร์ฟเวอร์จะไม่รองรับการดึงข้อมูลการคอมมิตของ arbitary ก็ตาม เราไม่แนะนำให้ใช้แอตทริบิวต์นี้เนื่องจากอาจทำให้การดึงข้อมูลไม่สำเร็จเนื่องจากข้อบกพร่องในการใช้งาน --shallow-since ของ git
`strip_prefix`	สตริง ไม่บังคับ คำนำหน้าไดเรกทอรีที่จะตัดออกจากไฟล์ที่แยก
`tag`	สตริง ไม่บังคับ แท็กในที่เก็บระยะไกลเป็น "ตรวจสอบแล้ว" ต้องระบุสาขา แท็ก หรือคอมมิตอย่างใดอย่างหนึ่งเท่านั้น
`verbose`	บูลีน ไม่บังคับ
`workspace_file`	ป้ายกํากับ (ไม่บังคับ) ไฟล์ที่จะใช้เป็นไฟล์ `WORKSPACE` สําหรับที่เก็บข้อมูลนี้ คุณสามารถระบุ "workspace_file" หรือ "workspace_file_content" อย่างใดอย่างหนึ่ง หรือจะระบุทั้ง 2 อย่างก็ได้
`workspace_file_content`	สตริง ไม่บังคับ เนื้อหาสำหรับไฟล์ WORKSPACE ของที่เก็บข้อมูลนี้ คุณสามารถระบุ "workspace_file" หรือ "workspace_file_content" อย่างใดอย่างหนึ่ง หรือจะระบุทั้ง 2 อย่างก็ได้

new_git_repository

new_git_repository(name, branch, build_file, build_file_content, commit, init_submodules,
                   patch_args, patch_cmds, patch_cmds_win, patch_tool, patches,
                   recursive_init_submodules, remote, repo_mapping, shallow_since, strip_prefix, tag,
                   verbose, workspace_file, workspace_file_content)

โคลนที่เก็บ Git ภายนอก

ก่อนอื่น Bazel จะพยายามดึงข้อมูลแบบไม่เจาะลึกเฉพาะการคอมมิตที่ระบุ หากไม่สำเร็จ (มักเกิดจากไม่มีการสนับสนุนเซิร์ฟเวอร์) ระบบจะกลับไปใช้การดึงข้อมูลรีโพซิทอรีทั้งหมด

ให้ใช้ http_archive เป็น git_repository เหตุผลมีดังนี้

กฎที่เก็บ Git ขึ้นอยู่กับ git(1) ของระบบในขณะที่เครื่องมือดาวน์โหลด HTTP สร้างขึ้น ลงใน Bazel และไม่มีทรัพยากร Dependency ของระบบ
http_archive รองรับรายการ urls เป็นมิเรอร์ และ git_repository รองรับเพียง remote รายการเดียว
http_archive ใช้ได้กับแคชที่เก็บ แต่ไม่ใช้ได้กับ git_repository โปรดดู #5116 เพื่อดูข้อมูลเพิ่มเติม

Attributes

`name`	ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับที่เก็บนี้
`branch`	สตริง ไม่บังคับ ในที่เก็บระยะไกลเพื่อตรวจสอบ ต้องระบุสาขา แท็ก หรือคอมมิตอย่างใดอย่างหนึ่งเท่านั้น
`build_file`	ป้ายกำกับ ไม่บังคับ ไฟล์ที่จะใช้เป็นไฟล์ BUILD สำหรับที่เก็บนี้ แอตทริบิวต์นี้เป็นป้ายกำกับแบบสัมบูรณ์ (ใช้ "@//" สำหรับที่เก็บหลัก) ไฟล์ไม่จำเป็นต้องมีชื่อว่า BUILD แต่อาจเป็นชื่ออื่นก็ได้ (เช่น BUILD.new-repo-name อาจเป็นชื่อที่เหมาะในการแยกความแตกต่างจากไฟล์ BUILD จริงของที่เก็บ
`build_file_content`	สตริง ไม่บังคับ เนื้อหาของไฟล์ BUILD สำหรับที่เก็บนี้
`commit`	String; ไม่บังคับ ให้ตรวจสอบ ต้องระบุ Branch, แท็ก หรือคอมมิตอย่างแม่นยำ
`init_submodules`	บูลีน ไม่บังคับ โคลนโมดูลย่อยในที่เก็บหรือไม่
`patch_args`	รายการสตริง ไม่บังคับ อาร์กิวเมนต์ที่กำหนดให้เครื่องมือแพตช์ ค่าเริ่มต้นจะเป็น -p0 แต่โดยปกติแล้วจะต้องใช้ -p1 สำหรับแพตช์ที่สร้างโดย git หากระบุอาร์กิวเมนต์ -p หลายรายการ อาร์กิวเมนต์สุดท้ายจะมีผล หากระบุอาร์กิวเมนต์อื่นที่ไม่ใช่ -p ไว้ Bazel จะกลับไปใช้เครื่องมือบรรทัดคำสั่งแพตช์แทนการใช้งานแพตช์ของ Bazel เมื่อกลับไปใช้เครื่องมือบรรทัดคำสั่งแพตช์และไม่ได้ระบุแอตทริบิวต์ Patch_tool ระบบจะใช้ "patch"
`patch_cmds`	รายการสตริง (ไม่บังคับ) ลำดับคำสั่ง Bash ที่จะใช้ใน Linux/Macos หลังจากติดตั้งแพตช์แล้ว
`patch_cmds_win`	รายการสตริง (ไม่บังคับ) ลำดับของคำสั่ง Powershell ที่จะนำไปใช้ใน Windows หลังจากใช้แพตช์ หากไม่ได้ตั้งค่าแอตทริบิวต์นี้ ระบบจะเรียกใช้ patch_cmds ใน Windows ซึ่งต้องมีไฟล์ Bash อยู่
`patch_tool`	สตริง ไม่บังคับ โปรแกรมแพตช์(1) ที่จะใช้ หากระบุไว้ Bazel จะใช้เครื่องมือแพตช์ที่ระบุแทนการติดตั้งใช้งานแพตช์ของ Bazel เนทีฟ
`patches`	รายการป้ายกำกับ ไม่บังคับ รายการไฟล์ที่จะใช้เป็นแพตช์หลังจากแตกไฟล์เก็บถาวร โดยค่าเริ่มต้น ปลั๊กอินจะใช้การติดตั้งแพตช์ของ Bazel ซึ่งไม่รองรับการจับคู่ Fuzz Match และแพตช์ไบนารี แต่ Bazel จะกลับไปใช้เครื่องมือบรรทัดคำสั่งแพตช์หากมีการระบุแอตทริบิวต์ "patch_tool" หรือมีอาร์กิวเมนต์อื่นที่ไม่ใช่ "-p" ในแอตทริบิวต์ "patch_args"
`recursive_init_submodules`	บูลีน ไม่บังคับ ต้องการโคลนโมดูลย่อยแบบซ้ำที่เก็บหรือไม่
`remote`	String; ต้องระบุ URI ของที่เก็บ Git ระยะไกล
`repo_mapping`	Dictionary: String -> String; ต้องระบุ พจนานุกรมจากชื่อที่เก็บในเครื่องเป็นชื่อที่เก็บส่วนกลาง การดำเนินการนี้ช่วยให้ควบคุมความละเอียดของทรัพยากร Dependency ของที่เก็บนี้ได้ ตัวอย่างเช่น รายการ `"@foo": "@bar"` ประกาศว่าเมื่อใดก็ตามที่ที่เก็บข้อมูลนี้ใช้ @foo (เช่น ใช้ @foo//some:target) ก็ควรแก้ไขการพึ่งพานั้นภายใน @bar ที่ประกาศไว้ทั่วโลก ("@bar//some:target")
`shallow_since`	String; ไม่บังคับ วันที่ที่ไม่บังคับ ไม่ใช่หลังวันที่คอมมิตที่ระบุ ไม่อนุญาตอาร์กิวเมนต์หากมีการระบุแท็กหรือสาขา (ซึ่งสามารถโคลนด้วย --depth=1 ได้เสมอ) การตั้งค่าวันที่ดังกล่าวใกล้กับคอมมิตที่ระบุอาจทําให้โคลนของที่เก็บแบบตื้นได้ แม้ว่าเซิร์ฟเวอร์จะไม่รองรับการดึงข้อมูลการคอมมิตของ arbitary ก็ตาม เราไม่แนะนำให้ใช้แอตทริบิวต์นี้เนื่องจากอาจทำให้การดึงข้อมูลไม่สำเร็จเนื่องจากข้อบกพร่องในการใช้งาน --shallow-since ของ git
`strip_prefix`	สตริง ไม่บังคับ คำนำหน้าไดเรกทอรีที่จะตัดออกจากไฟล์ที่แยก
`tag`	สตริง ไม่บังคับ แท็กในที่เก็บระยะไกลเป็น "ตรวจสอบแล้ว" ต้องระบุสาขา แท็ก หรือคอมมิตอย่างใดอย่างหนึ่งเท่านั้น
`verbose`	บูลีน ไม่บังคับ
`workspace_file`	ป้ายกํากับ (ไม่บังคับ) ไฟล์ที่จะใช้เป็นไฟล์ `WORKSPACE` สําหรับที่เก็บข้อมูลนี้ คุณสามารถระบุ "workspace_file" หรือ "workspace_file_content" อย่างใดอย่างหนึ่ง หรือจะระบุทั้ง 2 อย่างก็ได้
`workspace_file_content`	สตริง ไม่บังคับ เนื้อหาสำหรับไฟล์ WORKSPACE ของที่เก็บข้อมูลนี้ ต้องระบุ "workspace_file" หรือ "workspace_file_content" หรือจะระบุทั้ง 2 รายการไม่ได้