Workspace ルール

問題を報告 ソースを表示

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

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

ルール

バインド

ルールのソースを表示 
bind(name, actual, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

警告: bind() の使用はおすすめしません。問題と代替手段の詳しい説明については、バインドの削除を検討するをご覧ください。特に、repo_mapping リポジトリ属性の使用を検討してください。

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

ターゲットに //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

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 リポジトリに変換できるようにします。つまり、現在のリポジトリは、ファイル システム上の任意の場所からターゲットを定義して使用できます。

このルールは、指定された 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"],
)
その場合、target は @piano//:play-music に依存して piano.jar を使用できます。

引数

属性
name

Name; required

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

String; optional

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

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 のいずれかを指定できます。