ワークスペース ルールは、外部依存関係(通常はメイン リポジトリの外部にあるソースコード)を 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
リポジトリ属性の使用を検討してください。
警告: select()
は bind()
では使用できません。詳しくは、構成可能な属性に関するよくある質問をご覧ください。
//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 に依存するようになります。
バインドを使用して、外部リポジトリ内のターゲットをワークスペースで使用できるようにすることもできます。たとえば、@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 リポジトリに変換できるようにします。つまり、現在のリポジトリではファイル システム上のどこからでもターゲットを定義して使用できます。
このルールは、指定されたビルド ファイルとパスへのシンボリック リンクを含む 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//:play-music
に依存して piano.jar を使用できます。
引数
属性 | |
---|---|
name |
名前(必須) このターゲットの一意の名前。 |
build_file
|
名前: デフォルトは build_file または build_file_content を指定する必要があります。 この属性は、メイン ワークスペースに対する相対的なラベルです。ファイル名は BUILD にする必要はありませんが、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 のいずれかを指定できます。両方は指定できません。 この属性は、メイン ワークスペースに対する相対的なラベルです。ファイル名は WORKSPACE にしなくてもかまいませんが、(リポジトリの実際の WORKSPACE ファイルと区別するには、WORKSPACE.new-repo-name などが適しています)。 |
workspace_file_content
|
文字列。デフォルトは workspace_file または workspace_file_content のいずれかを指定できます。両方は指定できません。 |