Trang này dành cho những người viết quy tắc đang có ý định cung cấp quy tắc của mình cho người khác.
Bạn nên bắt đầu một bộ quy tắc mới từ kho lưu trữ mẫu: https://github.com/bazel-contrib/rules-template Mẫu đó tuân theo các đề xuất bên dưới, đồng thời bao gồm cả việc tạo tài liệu API và thiết lập quy trình CI/CD để giúp bạn dễ dàng phân phối bộ quy tắc.
Quy tắc lưu trữ và đặt tên
Các quy tắc mới phải nằm trong kho lưu trữ GitHub riêng của tổ chức bạn. Hãy bắt đầu một chuỗi thảo luận trên GitHub nếu bạn cảm thấy quy tắc của mình thuộc về tổ chức bazelbuild.
Tên kho lưu trữ cho các quy tắc Bazel được chuẩn hoá theo định dạng sau: $ORGANIZATION/rules_$NAME.
Xem ví dụ trên GitHub.
Để đảm bảo tính nhất quán, bạn nên tuân theo cùng định dạng này khi phát hành các quy tắc Bazel.
Hãy nhớ sử dụng nội dung mô tả kho lưu trữ GitHub và tiêu đề README.md mang tính mô tả, ví dụ:
- Tên kho lưu trữ:
bazelbuild/rules_go - Nội dung mô tả kho lưu trữ: Quy tắc Go cho Bazel
- Thẻ kho lưu trữ:
golang,bazel README.mdtiêu đề: Quy tắc Go cho Bazel (lưu ý đường liên kết đến https://bazel.build sẽ hướng dẫn những người dùng chưa quen với Bazel đến đúng nơi)
Bạn có thể nhóm các quy tắc theo ngôn ngữ (chẳng hạn như Scala), nền tảng thời gian chạy (chẳng hạn như Android) hoặc khung (chẳng hạn như Spring).
Nội dung kho lưu trữ
Mỗi kho lưu trữ quy tắc phải có một bố cục nhất định để người dùng có thể nhanh chóng hiểu các quy tắc mới.
Ví dụ: khi viết các quy tắc mới cho ngôn ngữ mockascript (giả định), kho lưu trữ quy tắc sẽ có cấu trúc sau:
/
LICENSE
README
MODULE.bazel
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
MODULE.bazel
Trong MODULE.bazel của dự án, bạn nên xác định tên mà người dùng sẽ sử dụng để tham chiếu đến các quy tắc của bạn. Nếu các quy tắc của bạn thuộc về tổ chức
bazelbuild, bạn phải sử dụng
rules_<lang> (chẳng hạn như rules_mockascript). Nếu không, bạn nên đặt tên
kho lưu trữ của mình là <org>_rules_<lang> (chẳng hạn như build_stack_rules_proto). Vui lòng
bắt đầu một chuỗi thảo luận trên GitHub
nếu bạn cảm thấy quy tắc của mình nên tuân theo quy ước cho các quy tắc trong tổ chức
bazelbuild.
Trong các phần sau, hãy giả định rằng kho lưu trữ thuộc về tổ chức bazelbuild.
module(name = "rules_mockascript")
README
Ở cấp cao nhất, phải có một README chứa nội dung mô tả ngắn gọn về bộ quy tắc của bạn và API mà người dùng nên mong đợi.
Quy tắc
Thông thường, kho lưu trữ của bạn sẽ cung cấp nhiều quy tắc. Tạo một thư mục có tên theo ngôn ngữ và cung cấp một điểm truy cập – tệp defs.bzl xuất tất cả các quy tắc (cũng bao gồm cả tệp BUILD để thư mục là một gói).
Đối với rules_mockascript, điều đó có nghĩa là sẽ có một thư mục có tên là
mockascript, một tệp BUILD và một tệp defs.bzl bên trong:
/
mockascript/
BUILD
defs.bzl
Giới hạn
Nếu quy tắc của bạn xác định
chuỗi công cụ quy tắc,
thì có thể bạn sẽ cần xác định constraint_setting tuỳ chỉnh và/hoặc
constraint_value. Đặt các quy tắc này vào gói //<LANG>/constraints. Cấu trúc thư mục của bạn sẽ có dạng như sau:
/
mockascript/
constraints/
BUILD
BUILD
defs.bzl
Vui lòng đọc
github.com/bazelbuild/platforms
để biết các phương pháp hay nhất, đồng thời xem những giới hạn đã có và
cân nhắc đóng góp các giới hạn của bạn tại đó nếu các giới hạn đó không phụ thuộc vào ngôn ngữ.
Hãy lưu ý đến việc giới thiệu các giới hạn tuỳ chỉnh, tất cả người dùng quy tắc của bạn sẽ
sử dụng các giới hạn đó để thực hiện logic dành riêng cho nền tảng trong tệp BUILD (ví dụ:
sử dụng lựa chọn).
Với các giới hạn tuỳ chỉnh, bạn sẽ xác định một ngôn ngữ mà toàn bộ hệ sinh thái Bazel sẽ sử dụng.
Thư viện runfiles
Nếu quy tắc của bạn cung cấp một thư viện tiêu chuẩn để truy cập vào runfiles, thì thư viện đó phải ở dạng mục tiêu thư viện nằm tại //<LANG>/runfiles (viết tắt
của //<LANG>/runfiles:runfiles). Các mục tiêu của người dùng cần truy cập vào các phần phụ thuộc dữ liệu của họ thường sẽ thêm mục tiêu này vào thuộc tính deps.
Quy tắc kho lưu trữ
Phần phụ thuộc
Các quy tắc của bạn có thể có các phần phụ thuộc bên ngoài mà bạn sẽ cần chỉ định trong tệp MODULE.bazel.
Đăng ký chuỗi công cụ
Các quy tắc của bạn cũng có thể đăng ký chuỗi công cụ mà bạn cũng có thể chỉ định trong tệp MODULE.bazel.
Xin lưu ý rằng để giải quyết các chuỗi công cụ trong giai đoạn phân tích, Bazel cần phân tích tất cả các mục tiêu toolchain đã đăng ký. Bazel sẽ không cần phân tích tất cả các mục tiêu được tham chiếu bởi thuộc tính toolchain.toolchain. Nếu để đăng ký chuỗi công cụ, bạn cần thực hiện quá trình tính toán phức tạp trong kho lưu trữ, hãy cân nhắc việc chia kho lưu trữ bằng các mục tiêu toolchain từ kho lưu trữ bằng các mục tiêu <LANG>_toolchain. Kho lưu trữ trước sẽ luôn được tìm nạp và
kho lưu trữ sau sẽ chỉ được tìm nạp khi người dùng thực sự cần tạo mã <LANG> code.
Đoạn mã phát hành
Trong thông báo phát hành, hãy cung cấp một đoạn mã mà người dùng có thể sao chép-dán vào tệp MODULE.bazel. Đoạn mã này nói chung sẽ có dạng như sau:
bazel_dep(name = "rules_<LANG>", version = "<VERSION>")
Thử nghiệm
Phải có các bài kiểm thử để xác minh rằng các quy tắc đang hoạt động như mong đợi. Các bài kiểm thử này có thể nằm ở vị trí tiêu chuẩn cho ngôn ngữ mà các quy tắc dành cho hoặc thư mục tests/ ở cấp cao nhất.
Ví dụ (không bắt buộc)
Người dùng sẽ thấy hữu ích khi có một thư mục examples/ cho thấy một vài cách cơ bản mà các quy tắc có thể được sử dụng.
CI/CD
Nhiều bộ quy tắc sử dụng GitHub Actions. Xem cấu hình được sử dụng trong kho lưu trữ rules-template, được đơn giản hoá bằng "quy trình công việc có thể dùng lại" được lưu trữ trong tổ chức bazel-contrib. ci.yaml chạy các bài kiểm thử trên mỗi PR và main comit, còn release.yaml chạy bất cứ khi nào bạn đẩy một thẻ vào kho lưu trữ.
Xem nhận xét trong kho lưu trữ rules-template để biết thêm thông tin.
Nếu kho lưu trữ của bạn thuộc tổ chức bazelbuild, bạn có thể yêu cầu thêm kho lưu trữ đó vào ci.bazel.build.
Tài liệu
Xem tài liệu Stardoc để biết hướng dẫn về cách nhận xét các quy tắc để tài liệu có thể được tạo tự động.
Thư mục docs/ của rules-template
cho thấy một cách đơn giản để đảm bảo nội dung Markdown trong thư mục docs/ luôn được cập nhật
khi các tệp Starlark được cập nhật.
Câu hỏi thường gặp
Tại sao chúng tôi không thể thêm quy tắc của mình vào kho lưu trữ GitHub chính của Bazel?
Chúng tôi muốn tách các quy tắc khỏi các bản phát hành Bazel càng nhiều càng tốt. Việc này giúp xác định rõ hơn ai là chủ sở hữu của từng quy tắc, giảm tải cho các nhà phát triển Bazel. Đối với người dùng của chúng tôi, việc tách rời giúp họ dễ dàng sửa đổi, nâng cấp, hạ cấp và thay thế các quy tắc. Việc đóng góp cho các quy tắc có thể nhẹ hơn so với việc đóng góp cho Bazel – tuỳ thuộc vào các quy tắc – bao gồm cả quyền gửi đầy đủ vào kho lưu trữ GitHub tương ứng. Việc có quyền gửi vào Bazel là một quy trình phức tạp hơn nhiều.
Nhược điểm là quy trình cài đặt một lần phức tạp hơn đối với người dùng của chúng tôi: họ phải thêm phần phụ thuộc vào bộ quy tắc của bạn trong tệp MODULE.bazel.
Trước đây, chúng tôi có tất cả các quy tắc trong kho lưu trữ Bazel (trong //tools/build_rules hoặc //tools/build_defs). Chúng tôi vẫn có một vài quy tắc ở đó, nhưng chúng tôi đang nỗ lực chuyển các quy tắc còn lại ra ngoài.