กฎ Sh

7.3 · 7.2 · 7.1 · 7.0 · 6.5

กฎ

sh_binary

ดูแหล่งที่มาของกฎ
sh_binary(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, output_licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

กฎ sh_binary ใช้เพื่อประกาศสคริปต์เชลล์ที่เรียกใช้ได้ (sh_binary เป็นชื่อที่ไม่ถูกต้อง เนื่องจากเอาต์พุตของ sh_binary ไม่จำเป็นต้องเป็นไบนารี) กฎนี้ช่วยให้มั่นใจว่าระบบจะสร้างทรัพยากร Dependency ทั้งหมดและปรากฏในพื้นที่ runfiles ณ เวลาเรียกใช้ เราขอแนะนำให้ตั้งชื่อกฎ sh_binary() ตามชื่อสคริปต์โดยตัดนามสกุลออก (เช่น .sh) โดยชื่อกฎและชื่อไฟล์ต้องไม่เหมือนกัน sh_binary จะใช้ shebangs ดังนั้นจึงใช้โปรแกรมล่ามที่พร้อมใช้งานได้ (เช่น #!/bin/zsh)

ตัวอย่าง

สําหรับสคริปต์ Shell ง่ายๆ ที่ไม่มีข้อกําหนดพึ่งพาและไฟล์ข้อมูลบางไฟล์ ให้ทำดังนี้

sh_binary(
    name = "foo",
    srcs = ["foo.sh"],
    data = glob(["datafiles/*.txt"]),
)

อาร์กิวเมนต์

Attributes
name

ชื่อ ต้องระบุ

ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้

deps

รายการป้ายกํากับ ค่าเริ่มต้นคือ []

รายการเป้าหมาย "คลัง" ที่จะรวมเข้ากับเป้าหมายนี้ ดูความคิดเห็นทั่วไปเกี่ยวกับ deps ที่แอตทริบิวต์ทั่วไปที่กฎการสร้างส่วนใหญ่กำหนด

คุณควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการกฎ sh_library อื่นๆ ที่ให้ซอร์สโค้ดโปรแกรมที่แปลแล้วซึ่งโค้ดใน srcs ต้องใช้ ไฟล์ที่ระบุโดยกฎเหล่านี้จะแสดงอยู่ใน runfiles ของเป้าหมายนี้

srcs

รายการป้ายกํากับ ค่าเริ่มต้นคือ []

รายการไฟล์อินพุต

คุณควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการไฟล์ต้นฉบับสคริปต์เชลล์ที่เป็นของไลบรารีนี้ สคริปต์จะโหลดสคริปต์อื่นๆ ได้โดยใช้คำสั่ง source หรือ . ของเชลล์

env_inherit

รายการสตริง ค่าเริ่มต้นคือ []

sh_library

ดูแหล่งที่มาของกฎ
sh_library(name, deps, srcs, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

การใช้หลักของกฎนี้คือเพื่อรวบรวม "ไลบรารี" เชิงตรรกะซึ่งประกอบด้วยสคริปต์ที่เกี่ยวข้อง ซึ่งเป็นโปรแกรมในภาษาที่แปลความหมายได้ซึ่งไม่จำเป็นต้องคอมไพล์หรือลิงก์ เช่น Bourne Shell และข้อมูลทั้งหมดที่โปรแกรมเหล่านั้นต้องการในรันไทม์ จากนั้นจะใช้ "คลัง" ดังกล่าวได้จากแอตทริบิวต์ data ของกฎ sh_binary อย่างน้อย 1 กฎ

คุณสามารถใช้กฎ filegroup เพื่อรวมไฟล์ข้อมูลได้

ในภาษาโปรแกรมที่แปลความหมาย จะไม่มีความแตกต่างที่ชัดเจนระหว่าง "โค้ด" กับ "ข้อมูล" เสมอไป เพราะท้ายที่สุดแล้ว โปรแกรมเป็นเพียง "ข้อมูล" จากมุมมองของล่าม ด้วยเหตุนี้ กฎนี้จึงมีแอตทริบิวต์ 3 รายการที่เทียบเท่ากันทั้งหมด ได้แก่ srcs, deps และ data การใช้งานในปัจจุบันไม่ได้แยกความแตกต่างระหว่างองค์ประกอบของรายการเหล่านี้ แอตทริบิวต์ทั้ง 3 รายการยอมรับกฎ ไฟล์ต้นทาง และไฟล์ที่สร้างขึ้น อย่างไรก็ตาม แนวทางปฏิบัติแนะนำคือใช้แอตทริบิวต์ตามวัตถุประสงค์ปกติ (เช่นเดียวกับกฎอื่นๆ)

ตัวอย่าง

sh_library(
    name = "foo",
    data = [
        ":foo_service_script",  # an sh_binary with srcs
        ":deploy_foo",  # another sh_binary with srcs
    ],
)

อาร์กิวเมนต์

Attributes
name

ชื่อ ต้องระบุ

ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้

deps

รายการป้ายกำกับ ค่าเริ่มต้นคือ []

รายการเป้าหมาย "คลัง" ที่จะรวมเข้ากับเป้าหมายนี้ ดูความคิดเห็นทั่วไปเกี่ยวกับ deps ที่แอตทริบิวต์ทั่วไปที่กฎการสร้างส่วนใหญ่กำหนด

คุณควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการกฎ sh_library อื่นๆ ที่ให้ซอร์สโค้ดโปรแกรมที่แปลแล้วซึ่งโค้ดใน srcs ต้องใช้ ไฟล์ที่ระบุโดยกฎเหล่านี้จะแสดงอยู่ใน runfiles ของเป้าหมายนี้

srcs

รายการป้ายกํากับ ค่าเริ่มต้นคือ []

รายการไฟล์อินพุต

คุณควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการไฟล์ต้นฉบับสคริปต์เชลล์ที่เป็นของไลบรารีนี้ สคริปต์โหลดสคริปต์อื่นๆ ได้โดยใช้คำสั่ง source หรือ . ของ Shell

sh_test

ดูแหล่งที่มาของกฎ
sh_test(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, local, restricted_to, shard_count, size, tags, target_compatible_with, testonly, timeout, toolchains, visibility)

กฎ sh_binary ใช้เพื่อประกาศสคริปต์เชลล์ที่เรียกใช้ได้ (sh_binary เป็นชื่อที่ไม่ถูกต้อง เนื่องจากเอาต์พุตของ sh_binary ไม่จำเป็นต้องเป็นไบนารี) กฎนี้ช่วยให้มั่นใจว่าระบบจะสร้างทรัพยากร Dependency ทั้งหมดและปรากฏในพื้นที่ runfiles ณ เวลาเรียกใช้ เราขอแนะนำให้ตั้งชื่อกฎ sh_binary() ตามชื่อสคริปต์โดยตัดนามสกุลออก (เช่น .sh) โดยชื่อกฎและชื่อไฟล์ต้องไม่เหมือนกัน sh_binary จะใช้ shebangs ดังนั้นจึงใช้โปรแกรมล่ามที่พร้อมใช้งานได้ (เช่น #!/bin/zsh)

ตัวอย่าง

สําหรับสคริปต์ Shell ง่ายๆ ที่ไม่มีข้อกําหนดพึ่งพาและไฟล์ข้อมูลบางไฟล์ ให้ทำดังนี้

sh_binary(
    name = "foo",
    srcs = ["foo.sh"],
    data = glob(["datafiles/*.txt"]),
)

อาร์กิวเมนต์

Attributes
name

ชื่อ ต้องระบุ

ชื่อที่ไม่ซ้ำกันสําหรับเป้าหมายนี้

deps

รายการป้ายกํากับ ค่าเริ่มต้นคือ []

รายการเป้าหมาย "คลัง" ที่จะรวมเข้ากับเป้าหมายนี้ ดูความคิดเห็นทั่วไปเกี่ยวกับ deps ได้ที่แอตทริบิวต์ทั่วไปที่กำหนดโดยกฎบิลด์ส่วนใหญ่

คุณควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการกฎ sh_library อื่นๆ ที่ให้ซอร์สโค้ดโปรแกรมที่แปลแล้วซึ่งโค้ดใน srcs ต้องใช้ ไฟล์ที่ระบุโดยกฎเหล่านี้จะแสดงอยู่ใน runfiles ของเป้าหมายนี้

srcs

รายการป้ายกํากับ ค่าเริ่มต้นคือ []

รายการไฟล์อินพุต

แอตทริบิวต์นี้ควรใช้เพื่อแสดงรายการไฟล์ต้นทางของสคริปต์ Shell ที่อยู่ในไลบรารีนี้ สคริปต์จะโหลดสคริปต์อื่นๆ ได้โดยใช้คำสั่ง source หรือ . ของเชลล์