ワークスペース ルールは、外部依存関係(通常はメイン リポジトリの外部にあるソースコード)を pull するために使用されます。
注: Bazel には、ネイティブのワークスペース ルール以外にも、Starlark ワークスペース ルール(特にウェブ上でホストされている Git リポジトリやアーカイブを処理するルール)も埋め込まれています。
ルール
bind
bind(name, actual, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)
警告: bind()
の使用はおすすめしません。この問題とその代替方法については、バインドの削除を検討するをご覧ください。特に、repo_mapping
リポジトリ属性の使用を検討してください。
警告: bind()
では select()
を使用できません。詳しくは、構成可能な属性に関するよくある質問をご覧ください。
//external
パッケージ内のターゲットにエイリアスを指定します。
//external
パッケージは「標準」パッケージではありません。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 は、外部リポジトリ内のターゲットをワークスペースで使用できるようにするためにも使用できます。たとえば、@my-ssl
という名前のリモート リポジトリが WORKSPACE ファイルにインポートされ、そのリポジトリに 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
|
このターゲットは存在する必要がありますが、任意のタイプのルール(バインドを含む)を指定できます。 この属性を省略すると、 |
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
|
たとえば、エントリ |
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 ライブラリ(~/chat-app/BUILD.my-ssl)の BUILD ファイルを作成して、依存関係を追加できます。
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.jar を使用するために
@piano//:play-music
に依存できます。引数
属性 | |
---|---|
name |
このターゲットの一意の名前。 |
build_file
|
build_file または build_file_content を指定する必要があります。 この属性は、メイン ワークスペースからの相対ラベルです。ファイル名を BUILD にする必要はありませんが、任意の名前を付けることができます。(リポジトリの実際の BUILD ファイルと区別するには、BUILD.new-repo-name などが適切です)。 |
build_file_content
|
build_file または build_file_content を指定する必要があります。 |
path
|
これは、メイン リポジトリの WORKSPACE ファイルへの絶対または相対のいずれかになります。 |
repo_mapping
|
たとえば、エントリ |
workspace_file
|
workspace_file または workspace_file_content はいずれか 1 つのみ指定できます。 この属性は、メイン ワークスペースからの相対ラベルです。ファイル名を WORKSPACE にする必要はありませんが、違っていてもかまいません。(WORKSPACE.new-repo-name などを使用すると、リポジトリの実際の WORKSPACE ファイルと区別できます)。 |
workspace_file_content
|
workspace_file または workspace_file_content はいずれか 1 つのみ指定できます。 |