Workspace のルール

問題を報告 ソースを表示 Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

ワークスペース ルールは、外部依存関係（通常はメイン リポジトリの外部にあるソースコード）を pull するために使用されます。

注: Bazel には、ネイティブ ワークスペース ルールの他にもさまざまな Starlark のワークスペース ルール、特に対処すべきもの ウェブ上にホストされた git リポジトリやアーカイブです。

ルール

• バインド
• local_repository
• new_local_repository

バインド

ルールソースを表示

bind(name, actual, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

警告: bind() の使用はおすすめしません。バインドの削除を検討するをご覧ください。長期間 議論が交わされます。特に、repo_mapping リポジトリ属性の使用を検討してください。

警告: select() は bind() では使用できません。詳しくは、構成可能な属性に関するよくある質問をご覧ください。 ご覧ください。

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

//external パッケージが「normal」ではないpackage: external/ ディレクトリはありません。 「仮想パッケージ」と考えることができます。すべてのバインドされたターゲットが含まれます。

例

ターゲットにエイリアスを付与するには、WORKSPACE ファイルでそのエイリアスを bind します。たとえば、//third_party/javacc-v2 という java_library ターゲットがあるとします。これは、次の行を WORKSPACE ファイル:

bind(
    name = "javacc-latest",
    actual = "//third_party/javacc-v2",
)

ターゲットが //third_party/javacc-v2 ではなく //external:javacc-latest に依存できるようになりました。javacc-v3 がリリースされると、bind ルールを更新でき、//external:javacc-latest に依存するすべての BUILD ファイルは、編集することなく javacc-v3 に依存するようになります。

Bind は、外部リポジトリ内のターゲットをワークスペースで使用できるようにするためにも使用できます。 たとえば、WORKSPACE ファイルにインポートされた @my-ssl という名前のリモート リポジトリがあり、cc_library ターゲット //src:openssl-lib がある場合、bind を使用してこのターゲットのエイリアスを作成できます。

bind(
    name = "openssl",
    actual = "@my-ssl//src:openssl-lib",
)

次に、ワークスペースの BUILD ファイルで、バインドされたターゲットを次のように使用できます。

cc_library(
    name = "sign-in",
    srcs = ["sign_in.cc"],
    hdrs = ["sign_in.h"],
    deps = ["//external:openssl"],
)

sign_in.cc と sign_in.h 内で、公開されているヘッダー ファイルは //external:openssl は、リポジトリへの相対パスを使用して参照できます。 含まれます。たとえば、@my-ssl//src:openssl-lib のルール定義が次のようなものであるとします。

cc_library(
    name = "openssl-lib",
    srcs = ["openssl.cc"],
    hdrs = ["openssl.h"],
)

sign_in.cc のインクルードは次のようになります。

#include "sign_in.h"
#include "src/openssl.h"

引数

属性
name	名前: 必須 このターゲットの一意の名前。
actual	ラベル:デフォルトは None です エイリアスを設定するターゲット。 このターゲットは存在する必要がありますが、任意のタイプのルール（bind を含む）にできます。 この属性を省略すると、//external でこのターゲットを参照するルール 依存関係のエッジが見当たらないだけですこれは、bind ルールを完全に省略する場合とは異なります。//external 依存関係に関連付けられた bind ルールがない場合はエラーになります。

local_repository

ルールソースを表示

local_repository(name, path, repo_mapping)

ローカル ディレクトリからのターゲットをバインドできるようにします。つまり、現在のリポジトリは、この他のディレクトリで定義されたターゲットを使用できます。詳細については、バインディング セクションをご覧ください。

例

現在のリポジトリが、ディレクトリ ~/chat-app をルートとするチャット クライアントであるとします。このリポジトリでは、別のリポジトリ（~/ssl）で定義されている SSL ライブラリを使用したいとします。SSL ライブラリにターゲット //src:openssl-lib があります。

ユーザーは、~/chat-app/WORKSPACE に次の行を追加することで、このターゲットへの依存関係を追加できます。

local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
)

ターゲットは、これに依存する依存関係として @my-ssl//src:openssl-lib を指定します。 ライブラリです。

引数

属性
name	名前:必須 このターゲットの一意の名前。
path	文字列（必須） ローカル リポジトリのディレクトリのパス。 リポジトリのフォルダを含むディレクトリへのパスを指定する必要があります。 WORKSPACE ファイル。パスは、メイン リポジトリの WORKSPACE ファイルに対する絶対パスまたは相対パスにできます。
repo_mapping	辞書: 文字列 -> 文字列。デフォルトは {} です。 ローカル リポジトリ名からグローバル リポジトリ名への辞書。これにより このリポジトリの依存関係を解決できます。 たとえば、エントリ "@foo": "@bar" は、このインスタンスが リポジトリが "@foo" に依存している（ "@foo//some:target" など）を宣言すると、その依存関係は グローバルに宣言された "@bar"（"@bar//some:target"）。

new_local_repository

ルールのソースを表示

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

ローカル ディレクトリを Bazel リポジトリに変換できるようにします。つまり、現在の ファイル システム上のどこからでもターゲットを定義して使用できます。

このルールは、指定された BUILD ファイルとパスへのシンボリック リンクを含む WORKSPACE ファイルとサブディレクトリを作成して、Bazel リポジトリを作成します。ビルドファイルでは、アプリケーションの相対パス path。WORKSPACE ファイルと BUILD ファイルがすでに含まれているディレクトリの場合は、local_repository ルールを使用できます。

例

現在のリポジトリが、ディレクトリ ~/chat-app をルートとするチャット クライアントであるとします。別のディレクトリ（~/ssl）で定義されている SSL ライブラリを使用したいとします。

ユーザーは、SSL ライブラリの BUILD ファイルを作成することで、依存関係を追加できます。 （~/chat-app/BUILD.my-ssl）に以下を含む:

java_library(
    name = "openssl",
    srcs = glob(['*.java'])
    visibility = ["//visibility:public"],
)

次に、~/chat-app/WORKSPACE に次の行を追加します。

new_local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
    build_file = "BUILD.my-ssl",
)

これにより、/home/user/ssl にシンボリック リンクする @my-ssl リポジトリが作成されます。 ターゲットがこのライブラリに依存するには、@my-ssl//:openssl をターゲットの 確認します。

new_local_repository を使用して、ディレクトリだけでなく単一のファイルを含めることもできます。たとえば、/home/username/Downloads/piano.jar に jar ファイルがあるとします。マイページ WORKSPACE ファイルに次の行を追加することで、そのファイルだけをビルドに追加できます。

new_local_repository(
    name = "piano",
    path = "/home/username/Downloads/piano.jar",
    build_file = "BUILD.piano",
)

次の BUILD.piano ファイルを作成します。

java_import(
    name = "play-music",
    jars = ["piano.jar"],
    visibility = ["//visibility:public"],
)

ターゲットは @piano//:play-music に依存して piano.jar を使用できます。

引数

属性
name	名前:必須 このターゲットの名前。
build_file	名前:デフォルトは None です このディレクトリの BUILD ファイルとして使用するファイル。 build_file または build_file_content のいずれかを指定する必要があります。 この属性は、メイン ワークスペースに対する相対的なラベルです。このファイルは必ずしも BUILD という名前ですが、その名前にすることもできます。（リポジトリの実際の BUILD ファイルと区別するために、BUILD.new-repo-name などの名前を付けるとよいでしょう）。
build_file_content	文字列。デフォルトは "" です。 このリポジトリの BUILD ファイルの内容。 build_file または build_file_content を指定する必要があります。
path	String;必須 ローカル ファイル システム上のパス。 メイン リポジトリの WORKSPACE ファイルの絶対パスまたは相対パスを指定できます。
repo_mapping	辞書: 文字列 -> 文字列。デフォルトは {} です。 ローカル リポジトリ名からグローバル リポジトリ名への辞書。これにより このリポジトリの依存関係を解決できます。 たとえば、エントリ "@foo": "@bar" は、このインスタンスが リポジトリが "@foo" に依存している（ "@foo//some:target" など）を宣言すると、その依存関係は グローバルに宣言された "@bar"（"@bar//some:target"）。
workspace_file	名前。デフォルトは None です。 このリポジトリの WORKSPACE ファイルとして使用するファイル。 workspace_file または workspace_file_content のいずれかを指定できます。両方は指定できません。 この属性は、メイン ワークスペースを基準とするラベルです。ファイルの名前は WORKSPACE にする必要はありませんが、そうすることもできます。（たとえば WORKSPACE.new-repo-name が、 リポジトリの実際の WORKSPACE ファイルと区別する必要があります）。
workspace_file_content	文字列。デフォルトは "" です。 このリポジトリの WORKSPACE ファイルの内容。 workspace_file または workspace_file_content のいずれかを指定できます。両方は指定できません。