Tổ chức quản lý tên miền

Nightly · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 7.7

Bzlmod phát hiện các phần phụ thuộc bằng cách yêu cầu thông tin của các phần phụ thuộc đó từ sổ đăng ký Bazel: cơ sở dữ liệu của các mô-đun Bazel. Hiện tại, Bzlmod chỉ hỗ trợ sổ đăng ký chỉ mục – thư mục cục bộ hoặc máy chủ HTTP tĩnh tuân theo một định dạng cụ thể.

Sổ đăng ký chỉ mục

Sổ đăng ký chỉ mục là một thư mục cục bộ hoặc máy chủ HTTP tĩnh chứa thông tin về danh sách các mô-đun, bao gồm trang chủ, người duy trì, tệp MODULE.bazel của mỗi phiên bản và cách tìm nạp nguồn của mỗi phiên bản. Đáng chú ý là sổ đăng ký này không cần phân phát chính kho lưu trữ nguồn.

Sổ đăng ký chỉ mục phải tuân theo định dạng bên dưới:

  • /bazel_registry.json: Tệp JSON chứa siêu dữ liệu cho sổ đăng ký như:
    • mirrors: chỉ định danh sách các bản sao để sử dụng cho kho lưu trữ nguồn
    • module_base_path: chỉ định đường dẫn cơ sở cho các mô-đun có local_repository loại trong tệp source.json
  • /modules: Thư mục chứa một thư mục con cho mỗi mô-đun trong sổ đăng ký này
  • /modules/$MODULE: Thư mục chứa một thư mục con cho mỗi phiên bản của mô-đun này, cũng như:
    • metadata.json: Tệp JSON chứa thông tin về mô-đun, với các trường sau:
      • homepage: URL của trang chủ dự án
      • maintainers: Danh sách các đối tượng JSON, mỗi đối tượng tương ứng với thông tin của người duy trì mô-đun trong sổ đăng ký. Xin lưu ý rằng danh sách này không nhất thiết phải giống với tác giả của dự án
      • versions: Danh sách tất cả các phiên bản của mô-đun này có trong sổ đăng ký này
      • yanked_versions: Bản đồ các phiên bản bị rút lại của mô-đun này. Khoá phải là các phiên bản cần rút lại và giá trị phải là nội dung mô tả lý do rút lại phiên bản đó, tốt nhất là chứa đường liên kết đến thông tin khác
  • /modules/$MODULE/$VERSION: Thư mục chứa các tệp sau:
    • MODULE.bazel: Tệp MODULE.bazel của phiên bản mô-đun này
    • source.json: Tệp JSON chứa thông tin về cách tìm nạp nguồn của phiên bản mô-đun này
      • Loại mặc định là "archive", đại diện cho kho lưu trữ http_archive repo, với các trường sau:
        • url: URL của kho lưu trữ nguồn
        • integrity: Tổng kiểm tra tính toàn vẹn của tài nguyên phụ của kho lưu trữ
        • strip_prefix: Tiền tố thư mục cần loại bỏ khi trích xuất kho lưu trữ nguồn
        • patches: Bản đồ chứa các tệp bản vá để áp dụng cho kho lưu trữ đã trích xuất. Các tệp bản vá nằm trong thư mục /modules/$MODULE/$VERSION/patches. Khoá là tên tệp bản vá và giá trị là tổng kiểm tra tính toàn vẹn của các tệp bản vá
        • patch_strip: Giống như đối số --strip của patch Unix.
        • archive_type: Loại kho lưu trữ của tệp đã tải xuống (Giống như type trên http_archive). Theo mặc định, loại kho lưu trữ được xác định từ phần mở rộng của tệp trong URL. Nếu tệp không có phần mở rộng, bạn có thể chỉ định rõ ràng một trong những phần mở rộng sau: "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", "tar.zst", "tzst", tar.bz2, "ar" hoặc "deb".
      • Bạn có thể thay đổi loại để sử dụng kho lưu trữ git, với các trường sau:
        • type: git_repository
        • Các trường sau đây như mô tả tại https://bazel.build/rules/lib/repo/git:
          • remote
          • commit
          • shallow_since
          • tag
          • init_submodules
          • verbose
          • strip_prefix
      • Bạn có thể thay đổi loại để sử dụng đường dẫn cục bộ, đại diện cho kho lưu trữ local_repository với các trường sau:
        • type: local_path
        • path: Đường dẫn cục bộ đến kho lưu trữ, được tính như sau:
          • Nếu path là đường dẫn tuyệt đối, thì đường dẫn đó vẫn giữ nguyên
          • Nếu path là đường dẫn tương đối và module_base_path là đường dẫn tuyệt đối, thì đường dẫn đó sẽ phân giải thành <module_base_path>/<path>
          • Nếu path và module_base_path đều là đường dẫn tương đối, thì đường dẫn đó sẽ phân giải thành <registry_path>/<module_base_path>/<path>. Sổ đăng ký phải được lưu trữ cục bộ và được sử dụng bằng --registry=file://<registry_path>. Nếu không, Bazel sẽ đưa ra lỗi
    • patches/: Thư mục không bắt buộc chứa các tệp bản vá, chỉ được sử dụng khi source.json có loại "archive"

Sổ đăng ký trung tâm Bazel

Sổ đăng ký trung tâm Bazel (BCR) tại https://bcr.bazel.build/ là một sổ đăng ký chỉ mục có nội dung được sao lưu bằng kho lưu trữ GitHub bazelbuild/bazel-central-registry. Bạn có thể duyệt xem nội dung của sổ đăng ký này bằng giao diện người dùng web tại https://registry.bazel.build/.

Cộng đồng Bazel duy trì BCR và người đóng góp có thể gửi yêu cầu kéo. Xem hướng dẫn đóng góp cho BCR guidelines.

Ngoài việc tuân theo định dạng của sổ đăng ký chỉ mục thông thường, BCR yêu cầu tệp presubmit.yml cho mỗi phiên bản mô-đun (/modules/$MODULE/$VERSION/presubmit.yml). Tệp này chỉ định một vài mục tiêu kiểm thử và bản dựng thiết yếu mà bạn có thể dùng để kiểm tra tính hợp lệ của phiên bản mô-đun này. Các quy trình CI của BCR cũng sử dụng tệp này để đảm bảo khả năng tương tác giữa các mô-đun.

Chọn sổ đăng ký

Bạn có thể sử dụng cờ Bazel có thể lặp lại --registry để chỉ định danh sách sổ đăng ký cần yêu cầu mô-đun, nhờ đó, bạn có thể thiết lập dự án để tìm nạp các phần phụ thuộc từ sổ đăng ký nội bộ hoặc của bên thứ ba. Các sổ đăng ký trước đó sẽ được ưu tiên. Để thuận tiện, bạn có thể đặt danh sách các cờ --registry trong tệp .bazelrc của dự án.

Nếu sổ đăng ký của bạn được lưu trữ trên GitHub (ví dụ: dưới dạng bản sao của bazelbuild/bazel-central-registry) thì giá trị --registry cần có địa chỉ GitHub thô trong raw.githubusercontent.com. Ví dụ: trên nhánh main của bản sao my-org bạn sẽ đặt --registry=https://raw.githubusercontent.com/my-org/bazel-central-registry/main/.

Việc sử dụng cờ --registry sẽ ngăn không cho Sổ đăng ký trung tâm Bazel được sử dụng theo mặc định, nhưng bạn có thể thêm lại bằng cách thêm --registry=https://bcr.bazel.build.