Workspace のルール

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

注: Bazel には、ネイティブ ワークスペース ルールの他に、さまざまな Starlark ワークスペース ルール（特に、ウェブでホストされている git リポジトリやアーカイブを扱うためのルール）も埋め込まれています。

ルール

• bind
• 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 パッケージは「通常の」パッケージではありません。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 に依存するようになります。

バインドは、外部リポジトリのターゲットをワークスペースで使用できるようにするためにも使用できます。たとえば、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"

引数

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 を指定します。

引数

new_local_repository

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

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

このルールは、WORKSPACE ファイルと、指定された BUILD ファイルとパスへのシンボリック リンクを含むサブディレクトリを作成して、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"],
)

引数