Workspace のルール

Workspace ルールは、外部依存関係を pull するために使用されます。 ソースコードの外に出ることもできません。

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

ルール

バインド 

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

警告: bind() の使用はおすすめしません。問題と代替方法について詳しくは、bind の削除を検討するをご覧ください。特に、kubectl の 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",
)

ターゲットが次のものではなく //external:javacc-latest に依存するようになりました。 //third_party/javacc-v2。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

Name; required

このターゲットの一意の名前。
actual

Label; optional

エイリアスを設定するターゲット。

このターゲットは存在する必要がありますが、どのようなタイプのルール（バインドを含む）でも使用できます。

この属性を省略すると、//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

Name; required

このターゲットの一意の名前。
path

String; required

ローカル リポジトリのディレクトリのパス。

これは、リポジトリの WORKSPACE ファイルを含むディレクトリへのパスにする必要があります。パスは、メイン リポジトリの絶対パスまたは相対パスで指定できます。 WORKSPACE ファイル。
repo_mapping

Dictionary: String -> String; optional

ローカル リポジトリ名からグローバル リポジトリ名への辞書。これにより このリポジトリの依存関係を解決できます。

たとえば、エントリ "@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 リポジトリに変換できるようにします。つまり、現在の ファイル システム上のどこからでもターゲットを定義して使用できます。

このルールでは、以下を含む 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

Name; required

このターゲットの一意の名前。
build_file

String; optional

このディレクトリのビルドファイルとして使用するファイル。

build_file または build_file_content のいずれかを指定する必要があります。

この属性は、メイン ワークスペースに対する相対的なラベルです。ファイルの名前は BUILD にする必要はありませんが、そうすることもできます。（BUILD.new-repo-name のような名前が リポジトリの実際の BUILD ファイルと区別する必要があります）。
build_file_content

String; optional

このリポジトリの BUILD ファイルの内容。

build_file または build_file_content のいずれかを指定する必要があります。
path

String; required

ローカル ファイル システム上のパス。

メイン リポジトリの WORKSPACE ファイルの絶対パスまたは相対パスを指定できます。
repo_mapping

Dictionary: String -> String; optional

ローカル リポジトリ名からグローバル リポジトリ名への辞書。これにより、このリポジトリの依存関係のワークスペース依存関係解決を制御できます。

たとえば、エントリ "@foo": "@bar" は、このリポジトリが "@foo" に依存するたびに（"@foo//some:target" への依存関係など）、グローバルに宣言された "@bar"（"@bar//some:target"）内でその依存関係を実際に解決することを宣言します。
workspace_file

String; optional

このリポジトリの WORKSPACE ファイルとして使用するファイル。

workspace_file または workspace_file_content のいずれかを指定できます。両方は指定できません。

この属性は、メイン ワークスペースを基準とするラベルです。このファイルは必ずしも WORKSPACE としていますが、そのようにすることもできます。（たとえば WORKSPACE.new-repo-name が、 リポジトリの実際の WORKSPACE ファイルと区別する必要があります）。
workspace_file_content

String; optional

このリポジトリの WORKSPACE ファイルの内容。

workspace_file または workspace_file_content のいずれかを指定できます。両方は指定できません。