Bazel レジストリ

Bzlmod は、Bazel レジストリ（Bazel モジュールのデータベース）から依存関係の情報をリクエストすることで、依存関係を検出します。現在、Bzlmod はインデックス レジストリ（特定の形式のローカル ディレクトリまたは静的 HTTP サーバー）のみをサポートしています。

インデックス レジストリ

インデックス レジストリは、モジュールのリストに関する情報を含むローカル ディレクトリまたは静的 HTTP サーバーです。これには、ホームページ、メンテナンス担当者、各バージョンの MODULE.bazel ファイル、各バージョンのソースの取得方法などが含まれます。特に、ソース アーカイブ自体を提供する必要はありません。

インデックス レジストリは、次の形式に従う必要があります。

  • /bazel_registry.json: レジストリのメタデータを含む JSON ファイル（次に例を示します）。
    • mirrors: ソース アーカイブに使用するミラーのリストを指定します。ミラーリングされた URL は、ミラー自体と、source.json ファイルで指定されたモジュールのソース URL（プロトコルを除く）を連結したものです。たとえば、モジュールのソース URL が https://foo.com/bar/baz で、mirrors に ["https://mirror1.com/", "https://example.com/mirror2/"] が含まれている場合、Bazel が順番に試行する URL は https://mirror1.com/foo.com/bar/baz、https://example.com/mirror2/foo.com/bar/baz、最後に元のソース URL である https://foo.com/bar/baz です。
    • module_base_path: source.json ファイルで local_repository タイプのモジュールのベースパスを指定
  • /modules: このレジストリ内の各モジュールのサブディレクトリを含むディレクトリ
  • /modules/$MODULE: このモジュールの各バージョンのサブディレクトリを含むディレクトリと、
    • metadata.json: モジュールに関する情報を含む JSON ファイル。次のフィールドがあります。
      • homepage: プロジェクトのホームページの URL
      • maintainers: JSON オブジェクトのリスト。それぞれが、レジストリ内のモジュールのメンテナーの情報に対応しています。これは、プロジェクトの作成者と同じである必要はありません。
      • versions: このレジストリにあるこのモジュールのすべてのバージョンのリスト
      • yanked_versions: このモジュールのヤンクされたバージョンのマップ。キーは削除するバージョン、値はバージョンが削除される理由の説明です。詳細情報へのリンクを含めることをおすすめします。
  • /modules/$MODULE/$VERSION: 次のファイルを含むディレクトリ。
    • MODULE.bazel: このモジュール バージョンの MODULE.bazel ファイル
    • source.json: このモジュール バージョンのソースを取得する方法に関する情報を含む JSON ファイル
      • デフォルトのタイプは「archive」で、http_archive リポジトリを表します。次のフィールドがあります。
        • url: ソース アーカイブの URL
        • integrity: アーカイブの サブリソースの完全性チェックサム
        • strip_prefix: ソース アーカイブの抽出時に削除するディレクトリ プレフィックス
        • patches: 展開したアーカイブに適用するパッチ ファイルを含むマップ。パッチファイルは /modules/$MODULE/$VERSION/patches ディレクトリにあります。キーはパッチファイル名で、値はパッチファイルの完全性チェックサムです。
        • patch_strip: Unix patch の --strip 引数と同じ。
        • archive_type: ダウンロードされたファイルのアーカイブ タイプ（http_archive の type と同じ）。デフォルトでは、アーカイブ タイプは URL のファイル拡張子から決定されます。ファイルに拡張子がない場合、"zip"、"jar"、"war"、"aar"、"tar"、"tar.gz"、"tgz"、"tar.xz"、"txz"、"tar.zst"、"tzst"、tar.bz2、"ar"、"deb" のいずれかを明示的に指定できます。
      • 次のフィールドを使用して、Git リポジトリを使用するようにタイプを変更できます。
        • type: git_repository
        • https://bazel.build/rules/lib/repo/git で説明されている次のフィールド:
          • remote
          • commit
          • shallow_since
          • tag
          • init_submodules
          • verbose
          • strip_prefix
      • 次のフィールドを使用して、local_repository リポジトリを表すローカルパスを使用するようにタイプを変更できます。
        • type: local_path
        • path: リポジトリのローカルパス。次のように計算されます。
          • path が絶対パスの場合、そのままになります
          • path が相対パスで、module_base_path が絶対パスの場合は、<module_base_path>/<path> に解決されます。
          • path と module_base_path の両方が相対パスの場合、<registry_path>/<module_base_path>/<path> に解決されます。レジストリはローカルにホストし、--registry=file://<registry_path> で使用する必要があります。そうしないと Bazel はエラーをスローし
    • patches/: パッチ ファイルを含むオプションのディレクトリ。source.json のタイプが「archive」の場合にのみ使用されます。

Bazel Central Registry

https://bcr.bazel.build/ の Bazel Central Registry（BCR）は、GitHub リポジトリ bazelbuild/bazel-central-registry に基づくコンテンツを含むインデックス レジストリです。コンテンツは、ウェブ フロントエンド（https://registry.bazel.build/）を使用してブラウジングできます。

BCR は Bazel コミュニティが管理しており、コントリビューターはプル リクエストを送信できます。BCR の投稿に関するガイドラインをご覧ください。

BCR では、通常のインデックス レジストリの形式に従うだけでなく、モジュール バージョン（/modules/$MODULE/$VERSION/presubmit.yml）ごとに presubmit.yml ファイルが必要です。このファイルには、このモジュール バージョンの有効性を確認するために使用できる、重要なビルド ターゲットとテスト ターゲットがいくつか指定されています。また、BCR の CI パイプラインもこれを使用して、モジュール間の相互運用性を確保します。

レジストリの選択

繰り返し可能な Bazel フラグ --registry を使用して、モジュールのリクエスト元となるレジストリのリストを指定できます。これにより、サードパーティまたは内部レジストリから依存関係を取得するようにプロジェクトを設定できます。前のレジストリが優先されます。便利なように、プロジェクトの .bazelrc ファイルに --registry フラグのリストを配置できます。

レジストリが GitHub でホストされている場合（bazelbuild/bazel-central-registry のフォークなど）、--registry 値には raw.githubusercontent.com の下にある未加工の GitHub アドレスが必要です。たとえば、my-org フォークの main ブランチでは、--registry=https://raw.githubusercontent.com/my-org/bazel-central-registry/main/ を設定します。

--registry フラグを使用すると、デフォルトで Bazel Central Registry の使用が停止されますが、--registry=https://bcr.bazel.build を追加することで再び使用できます。