ローカル リポジトリ ルール

次の関数は @bazel_tools//tools/build_defs/repo:local.bzl から読み込むことができます。

ローカル ファイル システム内のディレクトリをリポジトリとして使用できるようにするルール。

セットアップ

これらのルールをモジュール拡張機能で使用するには、.bzl ファイルに読み込み、拡張機能の実装関数から呼び出します。たとえば、local_repository を使用するには、次のようにします。

load("@bazel_tools//tools/build_defs/repo:local.bzl", "local_repository")

def _my_extension_impl(mctx):
  local_repository(name = "foo", path = "foo")

my_extension = module_extension(implementation = _my_extension_impl)

または、MODULE.bazel ファイルでこれらのリポジトリ ルールを直接呼び出すこともできます。 use_repo_rule:

local_repository = use_repo_rule("@bazel_tools//tools/build_defs/repo:local.bzl", "local_repository")
local_repository(name = "foo", path = "foo")

local_repository

load("@bazel//tools/build_defs/repo:local.bzl", "local_repository")

local_repository(name, path, repo_mapping)

Bazel ファイルがすでに含まれているローカル ディレクトリをリポジトリとして利用できるようにします。このディレクトリには、Bazel BUILD ファイルとリポジトリ境界ファイルがすでに含まれているはずです。これらのファイルが含まれていない場合は、代わりに new_local_repository の使用を検討してください。

属性

name 名前(必須)

このリポジトリの一意の名前。

path 文字列(必須)

リポジトリとして使用できるようにするディレクトリのパス。パスは絶対パスにすることも、ワークスペースのルートからの相対パスにすることもできます。

repo_mapping 辞書: String -> String(省略可)

「WORKSPACE」コンテキストのみ: ローカル リポジトリ名からグローバル リポジトリ名への辞書。これにより、このリポジトリの依存関係について、ワークスペースの依存関係の解決を制御できます。 たとえば、エントリ "@foo": "@bar"` は、このリポジトリが `@foo` に依存する場合は常に(`@foo//some:target` への依存関係など、グローバルに宣言された `@bar`(`@bar//some:target`)内でその依存関係を解決する必要があることを宣言します。 この属性は `MODULE.bazel` コンテキストではサポートされません(モジュール拡張機能の実装関数内でリポジトリ ルールを呼び出す場合)。

new_local_repository

load("@bazel//tools/build_defs/repo:local.bzl", "new_local_repository")

new_local_repository(name, build_file, build_file_content, path, repo_mapping)

Bazel ファイルを含まないローカル ディレクトリをリポジトリとして作成します。このディレクトリに Bazel BUILD ファイルやリポジトリ境界ファイルが含まれている必要はありません。このリポジトリ ルールによって作成されます。このディレクトリにすでに Bazel ファイルが含まれている場合は、代わりに local_repository を使用することを検討してください。

属性

name 名前(必須)

このリポジトリの一意の名前。

build_file ラベル:省略可

このリポジトリのビルド ファイルとして使用するファイル。 「build_file」と「build_file_content」のいずれか 1 つのみを指定する必要があります。 このラベルで指定されるファイルの名前は BUILD にする必要はありませんが、BUILD にできます。実際の BUILD ファイルと区別するために、「BUILD.new-repo-name」のような名前を付けるとよいでしょう。

build_file_content String;省略可

このリポジトリ用に作成される BUILD ファイルの内容。 「build_file」と「build_file_content」のいずれか 1 つのみを指定する必要があります。

path String;必須

リポジトリとして使用可能にするディレクトリのパス。 パスは絶対パスにすることも、ワークスペースのルートからの相対パスにすることもできます。

repo_mapping 辞書: String -> String(省略可)

「WORKSPACE」コンテキストのみ: ローカル リポジトリ名からグローバル リポジトリ名への辞書。これにより、このリポジトリの依存関係について、ワークスペースの依存関係の解決を制御できます。 たとえば、エントリ "@foo": "@bar"` は、このリポジトリが `@foo` に依存する場合は常に(`@foo//some:target` への依存関係など、グローバルに宣言された `@bar`(`@bar//some:target`)内でその依存関係を解決する必要があることを宣言します。 この属性は `MODULE.bazel` コンテキストではサポートされません(モジュール拡張機能の実装関数内でリポジトリ ルールを呼び出す場合)。