การติดตั้งใช้งานกฎ

หน้านี้มีไว้สำหรับผู้เขียนกฎที่วางแผนจะเผยแพร่กฎของตนให้ผู้อื่นใช้

กฎการโฮสต์และการตั้งชื่อ

กฎใหม่ควรอยู่ในที่เก็บ GitHub ของตัวเองภายใต้องค์กรของคุณ โปรดติดต่อรายชื่ออีเมล bazel-dev หากคุณคิดว่ากฎของคุณควรอยู่ในองค์กรbazelbuild

ชื่อที่เก็บสำหรับกฎ Bazel เป็นไปตามรูปแบบต่อไปนี้ $ORGANIZATION/rules_$NAME ดูตัวอย่างได้ที่ GitHub คุณต้องใช้รูปแบบเดียวกันนี้เมื่อเผยแพร่กฎ Bazel เพื่อให้สอดคล้องกัน

อย่าลืมใช้คำอธิบายที่เก็บ GitHub และชื่อ README.md ที่สื่อความหมาย เช่น

• ชื่อที่เก็บ: bazelbuild/rules_go
• คำอธิบายที่เก็บ: กฎ Go สำหรับ Bazel
• แท็กที่เก็บ: golang, bazel
• README.md ส่วนหัว: กฎ Go สำหรับ Bazel (โปรดสังเกตลิงก์ไปยัง https://bazel.build ซึ่งจะนำผู้ใช้ที่ไม่คุ้นเคย กับ Bazel ไปยังที่ที่เหมาะสม)

คุณจัดกลุ่มกฎตามภาษา (เช่น Scala) หรือแพลตฟอร์ม (เช่น Android) ก็ได้

เนื้อหาที่เก็บ

ที่เก็บกฎทุกรายการควรมีเลย์เอาต์ที่แน่นอนเพื่อให้ผู้ใช้เข้าใจกฎใหม่ได้อย่างรวดเร็ว

ตัวอย่างเช่น เมื่อเขียนกฎใหม่สำหรับภาษา mockascript (สมมติขึ้น) ที่เก็บกฎจะมีโครงสร้างดังนี้

/
  LICENSE
  README
  WORKSPACE
  mockascript/
    constraints/
      BUILD
    runfiles/
      BUILD
      runfiles.mocs
    BUILD
    defs.bzl
  tests/
    BUILD
    some_test.sh
    another_test.py
  examples/
    BUILD
    bin.mocs
    lib.mocs
    test.mocs

WORKSPACE

ใน WORKSPACE ของโปรเจ็กต์ คุณควรกำหนดชื่อที่ผู้ใช้จะใช้เพื่ออ้างอิงกฎของคุณ หากกฎของคุณอยู่ในองค์กร bazelbuild คุณต้องใช้ rules_<lang> (เช่น rules_mockascript) ไม่เช่นนั้น คุณควรตั้งชื่อ ที่เก็บเป็น <org>_rules_<lang> (เช่น build_stack_rules_proto) โปรดติดต่อ รายชื่ออีเมล bazel-dev หากคุณคิดว่ากฎของคุณควรเป็นไปตามรูปแบบสำหรับกฎในองค์กร bazelbuild

ในส่วนต่อไปนี้ ให้ถือว่าที่เก็บเป็นของ องค์กร bazelbuild

workspace(name = "rules_mockascript")

README

ที่ระดับบนสุดควรมี README ที่มี (อย่างน้อย) สิ่งที่ผู้ใช้จะต้องคัดลอกและวางลงในไฟล์ WORKSPACE เพื่อใช้กฎของคุณ โดยทั่วไปแล้วจะเป็น http_archive ที่ชี้ไปยังรุ่น GitHub ของคุณและการเรียกใช้มาโครที่จะดาวน์โหลด/กำหนดค่าเครื่องมือที่กฎของคุณต้องใช้ ตัวอย่างเช่น สำหรับ กฎ Go จะมีลักษณะดังนี้

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "rules_go",
    urls = ["https://github.com/bazelbuild/rules_go/releases/download/0.18.5/rules_go-0.18.5.tar.gz"],
    sha256 = "a82a352bffae6bee4e95f68a8d80a70e87f42c4741e6a448bec11998fcc82329",
)
load("@rules_go//go:deps.bzl", "go_rules_dependencies", "go_register_toolchains")
go_rules_dependencies()
go_register_toolchains()

หากกฎของคุณขึ้นอยู่กับกฎของที่เก็บอื่น ให้ระบุไว้ใน เอกสารประกอบของกฎ (เช่น ดูกฎ Skydoc ซึ่งขึ้นอยู่กับกฎ Sass) และระบุ WORKSPACE มาโครที่จะดาวน์โหลดทรัพยากร Dependency ทั้งหมด (ดู rules_go ด้านบน)

กฎ

ที่เก็บของคุณอาจมีกฎหลายข้อ สร้างไดเรกทอรีที่ตั้งชื่อตามภาษาและระบุจุดแรกเข้า ซึ่งก็คือไฟล์ defs.bzl ที่ส่งออกกฎทั้งหมด (รวมถึงไฟล์ BUILD เพื่อให้ไดเรกทอรีเป็นแพ็กเกจ) สำหรับ rules_mockascript หมายความว่าจะมีไดเรกทอรีชื่อ mockascript รวมถึงไฟล์ BUILD และไฟล์ defs.bzl อยู่ภายใน

/
  mockascript/
    BUILD
    defs.bzl

ข้อจำกัด

หากกฎของคุณกำหนด Toolchain กฎ คุณอาจต้องกำหนด constraint_setting ที่กำหนดเอง และ/หรือ constraint_value ใส่กฎเหล่านี้ลงในแพ็กเกจ //<LANG>/constraints โครงสร้างไดเรกทอรีจะมีลักษณะดังนี้

/
  mockascript/
    constraints/
      BUILD
    BUILD
    defs.bzl

โปรดอ่าน github.com/bazelbuild/platforms เพื่อดูแนวทางปฏิบัติแนะนำและดูข้อจำกัดที่มีอยู่แล้ว รวมถึง พิจารณาส่งข้อจำกัดของคุณที่นั่นหากข้อจำกัดนั้นไม่ขึ้นอยู่กับภาษา โปรดระมัดระวังในการนำข้อจำกัดที่กำหนดเองมาใช้ เนื่องจากผู้ใช้กฎของคุณทุกคนจะ ใช้ข้อจำกัดเหล่านั้นเพื่อดำเนินการตรรกะเฉพาะแพลตฟอร์มในไฟล์ BUILD (เช่น การใช้ Select) เมื่อใช้ข้อจำกัดที่กำหนดเอง คุณจะกำหนดภาษาที่ระบบนิเวศ Bazel ทั้งหมดจะใช้

ไลบรารี Runfiles

หากกฎของคุณมีไลบรารีมาตรฐานสำหรับการเข้าถึง Runfiles ไลบรารีนั้นควรอยู่ในรูปแบบเป้าหมายของไลบรารีที่ //<LANG>/runfiles (ตัวย่อ ของ //<LANG>/runfiles:runfiles) โดยทั่วไปแล้วเป้าหมายของผู้ใช้ที่ต้องเข้าถึงทรัพยากร Dependency ของข้อมูลจะเพิ่มเป้าหมายนี้ลงในแอตทริบิวต์ deps

กฎที่เก็บ

ทรัพยากร Dependency

กฎของคุณอาจมีทรัพยากร Dependency ภายนอก โปรดระบุมาโคร WORKSPACE ที่จะประกาศทรัพยากร Dependency ภายนอกเหล่านั้นเพื่อให้การใช้กฎของคุณง่ายขึ้น อย่าประกาศทรัพยากร Dependency ของการทดสอบที่นั่น ให้ประกาศเฉพาะทรัพยากร Dependency ที่กฎต้องใช้ในการทำงาน ใส่ทรัพยากร Dependency ในการพัฒนาลงในไฟล์ WORKSPACE

สร้างไฟล์ชื่อ <LANG>/repositories.bzl และระบุมาโครจุดแรกเข้าเดียวชื่อ rules_<LANG>_dependencies. ไดเรกทอรีของเราจะมีลักษณะดังนี้

/
  mockascript/
    constraints/
      BUILD
    BUILD
    defs.bzl
    repositories.bzl

การลงทะเบียน Toolchain

กฎของคุณอาจลงทะเบียน Toolchain ด้วย โปรดระบุมาโคร WORKSPACE แยกต่างหากที่จะลงทะเบียน Toolchain เหล่านี้ วิธีนี้จะช่วยให้ผู้ใช้เลือกละเว้นมาโครก่อนหน้าและควบคุมทรัพยากร Dependency ด้วยตนเองได้ ขณะเดียวกันก็ยังได้รับอนุญาตให้ลงทะเบียน Toolchain

ดังนั้น ให้เพิ่มมาโคร WORKSPACE ชื่อ rules_<LANG>_toolchains ลงใน <LANG>/repositories.bzl ไฟล์

โปรดทราบว่า Bazel ต้องวิเคราะห์เป้าหมาย toolchain ทั้งหมดที่ลงทะเบียนไว้เพื่อแก้ไข Toolchain ในระยะการวิเคราะห์ Bazel ไม่จำเป็นต้องวิเคราะห์เป้าหมายทั้งหมดที่แอตทริบิวต์ toolchain.toolchain อ้างอิง หากคุณต้องทำการคำนวณที่ซับซ้อนใน ที่เก็บเพื่อลงทะเบียน Toolchain ให้พิจารณาแยกที่เก็บที่มีเป้าหมาย toolchain ออกจาก ที่เก็บที่มีเป้าหมาย <LANG>_toolchain ระบบจะดึงข้อมูลที่เก็บแรกเสมอ และ จะดึงข้อมูลที่เก็บหลังก็ต่อเมื่อผู้ใช้ต้องการสร้างโค้ด <LANG> จริงๆ

ข้อมูลโค้ดการเผยแพร่

ในการประกาศการเผยแพร่ ให้ระบุข้อมูลโค้ดที่ผู้ใช้สามารถคัดลอกและวางลงในไฟล์ WORKSPACE โดยทั่วไปแล้วข้อมูลโค้ดนี้จะมีลักษณะดังนี้

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "rules_<LANG>",
    urls = ["<url_to_the_release.zip"],
    sha256 = "4242424242",
)
load("@rules_<LANG>//<LANG>:repositories.bzl", "rules_<LANG>_dependencies", "rules_<LANG>_toolchains")
rules_<LANG>_dependencies()
rules_<LANG>_toolchains()

การทดสอบ

ควรมีการทดสอบเพื่อยืนยันว่ากฎทำงานตามที่คาดไว้ การทดสอบอาจอยู่ในตำแหน่งมาตรฐานสำหรับภาษาที่กฎมีไว้ให้ หรืออยู่ในไดเรกทอรี tests/ ที่ระดับบนสุด

ตัวอย่าง (ไม่บังคับ)

การมีไดเรกทอรี examples/ ที่แสดงวิธีพื้นฐาน 2-3 วิธีในการใช้กฎจะเป็นประโยชน์ต่อผู้ใช้

การทดสอบ

ตั้งค่า Travis ตามที่อธิบายไว้ในเอกสารประกอบเริ่มต้นใช้งาน ของพวกเขา จากนั้นเพิ่มไฟล์ .travis.yml ลงในที่เก็บที่มีเนื้อหาต่อไปนี้

dist: xenial  # Ubuntu 16.04

# On trusty (or later) images, the Bazel apt repository can be used.
addons:
  apt:
    sources:
    - sourceline: 'deb [arch=amd64] http://storage.googleapis.com/bazel-apt stable jdk1.8'
      key_url: 'https://bazel.build/bazel-release.pub.gpg'
    packages:
    - bazel

script:
  - bazel build //...
  - bazel test //...

หากที่เก็บของคุณอยู่ในองค์กร bazelbuild คุณสามารถขอเพิ่ม ที่เก็บลงในci.bazel.buildได้

เอกสารประกอบ

ดูวิธีการในเอกสารประกอบ Stardoc เกี่ยวกับ วิธีแสดงความคิดเห็นในกฎเพื่อให้ระบบสร้างเอกสารประกอบได้ โดยอัตโนมัติ

คำถามที่พบบ่อย

เหตุใดเราจึงเพิ่มกฎลงในที่เก็บ GitHub หลักของ Bazel ไม่ได้

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

ข้อเสียคือผู้ใช้ต้องผ่านกระบวนการติดตั้งครั้งเดียวที่ซับซ้อนมากขึ้น โดยต้องคัดลอกและวางกฎลงในไฟล์ WORKSPACE ตามที่แสดงในส่วน README.md ด้านบน

เราเคยมีกฎทั้งหมดอยู่ในที่เก็บ Bazel (ภายใต้ //tools/build_rules หรือ //tools/build_defs) ปัจจุบันเรายังมีกฎ 2-3 ข้ออยู่ที่นั่น แต่กำลังดำเนินการย้ายกฎที่เหลือออก