Bazel レジストリ

問題を報告 ソースを表示

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

インデックス レジストリ

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

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

  • /bazel_registry.json: レジストリのメタデータを含む JSON ファイル。例:
    • mirrors: ソース アーカイブに使用するミラーのリストを指定します。
    • 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" のいずれかを明示的に指定できます。
      • この型は、次のフィールドを持つ 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 コミュニティで管理されており、コントリビューターが pull リクエストを送信できます。BCR コントリビューション ガイドラインをご覧ください。

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

レジストリの選択

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

レジストリが 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 を追加することで再度追加できます。