WORKSPACE ファイル

WORKSPACE ファイルで使用できるメソッド。

メンバー

バインド

None bind(name, actual=None)

非推奨: 問題点と代替案については、バインドの削除を検討するをご覧ください。bind() は Bzlmod では使用できません。

ターゲットに //external パッケージのエイリアスを付与します。

パラメータ

パラメータ 説明
name string; 必須
エイリアス名として機能する '//external' のラベル
actual string; または None; デフォルトは None
エイリアス化する実際のラベル

register_execution_platforms

None register_execution_platforms(*platform_labels)

登録する実行プラットフォームを定義します。絶対ターゲット パターン(`@` または `//` で始まる)にする必要があります。詳しくは、ツールチェーンの解決をご覧ください。:all など、複数のターゲットに展開されるパターンは、名前の辞書順で登録されます。

パラメータ

パラメータ 説明
platform_labels 文字列シーケンス; 必須
登録するターゲット パターン。

register_toolchains

None register_toolchains(*toolchain_labels)

登録するツールチェーンを定義します。絶対ターゲット パターン(`@` または `//` で始まる)にする必要があります。詳しくは、ツールチェーンの解決をご覧ください。:all など、複数のターゲットに展開されるパターンは、ターゲット名(ツールチェーン実装の名前ではない)の辞書順で登録されます。

パラメータ

パラメータ 説明
toolchain_labels 文字列シーケンス; 必須
登録するターゲット パターン。

ワークスペース

None workspace(name)

この関数は WORKSPACE ファイルでのみ使用でき、WORKSPACE ファイル内の他のすべての関数の前に宣言する必要があります。各 WORKSPACE ファイルには workspace 関数が必要です。

このワークスペースの名前を設定します。ワークスペース名は、プロジェクトの Java パッケージ スタイルの説明にする必要があります。区切り文字にはアンダースコアを使用します。たとえば、github.com/bazelbuild/bazel の場合は com_github_bazelbuild_bazel にします。

この名前は、リポジトリの実行ファイルが保存されるディレクトリに使用されます。たとえば、ローカル リポジトリに実行ファイル foo/bar があり、WORKSPACE ファイルに workspace(name = 'baz') が含まれている場合、実行ファイルは mytarget.runfiles/baz/foo/bar に配置されます。ワークスペース名が指定されていない場合、実行ファイルは bar.runfiles/foo/bar にシンボリック リンクされます。

リモート リポジトリ ルールの名前は、有効なワークスペース名にする必要があります。たとえば、maven_jar(name = 'foo') は使用できますが、maven_jar(name = 'foo%bar') は使用できません。Bazel は maven_jar の WORKSPACE ファイルを書き込もうとするためです。workspace(name = 'foo%bar')

パラメータ

パラメータ 説明
name string; 必須
ワークスペースの名前。名前の先頭は英字にする必要があります。名前に含められるのは文字、数字、アンダースコア、ハイフン、ピリオドのみです。