次の関数は @bazel_tools//tools/build_defs/repo:http.bzl から読み込めます。
http_archive
http_archive(name, add_prefix, auth_patterns, build_file, build_file_content, canonical_id, integrity, netrc, patch_args, patch_cmds, patch_cmds_win, patch_tool, patches, remote_patch_strip, remote_patches, sha256, strip_prefix, type, url, urls, workspace_file, workspace_file_content)
Bazel リポジトリを圧縮アーカイブ ファイルとしてダウンロードし、解凍して、ターゲットをバインディングできるようにします。
次のファイル拡張子がサポートされています: "zip"、"jar"、"war"、"aar"、"tar"、"tar.gz"、"tgz"、"tar.xz"、"txz"、"tar.zst"、"tzst"、tar.bz2、"ar"、"deb"。
例: 現在のリポジトリに、ディレクトリ ~/chat-app をルートとするチャット プログラムのソースコードが含まれているとします。http://example.com/openssl.zip から入手できる SSL ライブラリに依存する必要があります。この .zip ファイルには、次のディレクトリ構造が含まれています。
WORKSPACE
src/
openssl.cc
openssl.h
ローカル リポジトリで、ユーザーが次のターゲット定義を含む openssl.BUILD ファイルを作成します。
cc_library(
name = "openssl-lib",
srcs = ["src/openssl.cc"],
hdrs = ["src/openssl.h"],
)
次の行が ~/chat-app/WORKSPACE に追加された場合、~/chat-app リポジトリ内のターゲットはこのターゲットに依存できます。
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "my_ssl",
url = "http://example.com/openssl.zip",
sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
build_file = "@//:openssl.BUILD",
)
この場合、ターゲットは依存関係として @my_ssl//:openssl-lib を指定します。
属性
name |
Name（必須） このリポジトリの一意の名前。 |
add_prefix |
文字列。省略可 リポジトリ ディレクトリを基準とした相対パスの宛先ディレクトリ。アーカイブ内のファイルパスに strip_prefix（存在する場合）を適用した後、このディレクトリに展開されます。たとえば、`add_prefix = "bar"` かつ `strip_prefix = "foo-1.2.3"` の場合、ファイル `foo-1.2.3/src/foo.h` は `bar/src/foo.h` にアンパックされます。 |
auth_patterns |
辞書: 文字列 -> 文字列（省略可）
ホスト名をカスタム認証パターンにマッピングする辞書（省略可）。このディクショナリに URL のホスト名が含まれている場合、http リクエストの Authorization ヘッダーを生成するときに値がパターンとして使用されます。これにより、多くの一般的なクラウド ストレージ プロバイダで使用されているカスタム認証スキームを使用できるようになります。現在、このパターンでは
auth_patterns = {
"storage.cloudprovider.com": "Bearer <password>"
}
netrc:
machine storage.cloudprovider.com
password RANDOM-TOKEN
最終的な HTTP リクエストのヘッダーは次のようになります。
Authorization: Bearer RANDOM-TOKEN |
build_file |
ラベル（省略可） このリポジトリのビルド ファイルとして使用するファイル。この属性は絶対ラベルです（メイン リポジトリの場合は「@//」を使用します）。ファイル名は BUILD にする必要はありませんが、BUILD.new-repo-name などにすると、リポジトリの実際の BUILD ファイルと区別しやすくなります。build_file または build_file_content のいずれかを指定できます。両方は指定できません。 |
build_file_content |
文字列。省略可 このリポジトリの BUILD ファイルの内容。build_file または build_file_content のいずれかを指定できます。両方は指定できません。 |
canonical_id |
文字列。省略可 ダウンロードしたアーカイブの正規 ID。 指定されていて空でない場合、bazel はキャッシュからアーカイブを取得しません（ただし、同じ正規 ID を持つリクエストによってキャッシュに追加された場合を除く）。 |
integrity |
文字列。省略可 ダウンロードしたファイルの想定されたチェックサムは、サブリソースの整合性形式です。 ダウンロードしたファイルのチェックサムと一致する必要があります。リモート ファイルは変更される可能性があるため、チェックサムを省略することはセキュリティ上のリスクになります。このフィールドを省略すると、ビルドが非密閉型のものになります。開発を容易にするためのオプションですが、この属性または「sha256」は出荷前に設定する必要があります。 |
netrc |
文字列。省略可 認証に使用する .netrc ファイルの場所 |
patch_args |
文字列のリスト。省略可。 パッチツールに渡される引数。デフォルトは -p0 ですが、通常、git によって生成されたパッチには -p1 が必要です。複数の -p 引数が指定されている場合は、最後の引数が有効になります。-p 以外の引数が指定されている場合、Bazel はフォールバックして、Bazel ネイティブのパッチ実装ではなく、パッチ コマンドライン ツールを使用します。パッチ コマンドライン ツールにフォールバックし、patch_tool 属性が指定されていない場合は、`patch` が使用されます。これは、「patches」属性内のパッチファイルにのみ影響します。 |
patch_cmds |
文字列のリスト。省略可。 パッチ適用後に Linux/macOS で適用される Bash コマンドの順序。 |
patch_cmds_win |
文字列のリスト。省略可。 パッチ適用後に Windows に適用される Powershell コマンドの順序。この属性が設定されていない場合、patch_cmds が Windows で実行されます。この場合、Bash バイナリが存在する必要があります。 |
patch_tool |
文字列。省略可 使用する patch(1) ユーティリティ。これを指定すると、Bazel ネイティブのパッチ実装ではなく、指定されたパッチツールが使用されます。 |
patches |
ラベルのリスト。省略可 アーカイブの抽出後にパッチとして適用されるファイルのリスト。デフォルトでは、ファズマッチとバイナリパッチをサポートしていない Bazel ネイティブのパッチ実装が使用されますが、「patch_tool」属性が指定されているか、「patch_args」属性に「-p」以外の引数がある場合、Bazel はパッチ コマンドライン ツールを使用するようにフォールバックします。 |
remote_patch_strip |
整数、省略可 リモートパッチのファイル名から削除される先頭のスラッシュの数。 |
remote_patches |
辞書: 文字列 -> 文字列（省略可） パッチファイルの URL とその完全性値のマップ。これらは、アーカイブの抽出後、`patches` 属性からパッチファイルを適用する前に適用されます。Bazel ネイティブのパッチ実装を使用します。「remote_patch_strip」でパッチストリップ番号を指定できます。 |
sha256 |
文字列。省略可 ダウンロードされるファイルの想定 SHA-256 です。 ダウンロードしたファイルの SHA-256 と一致している必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ上のリスクが発生します。このフィールドを省略すると、ビルドが密閉型でなくなります。開発を容易にするために省略することもできますが、この属性または「integrity」は出荷前に設定する必要があります。 |
strip_prefix |
文字列。省略可 抽出されたファイルから削除するディレクトリ接頭辞。多くのアーカイブには、アーカイブ内の有用なファイルをすべて含む最上位ディレクトリがあります。このフィールドを使用すると、この接頭辞を「build_file」内で何度も指定しなくても、抽出されたすべてのファイルから接頭辞を除去できます。 たとえば、foo-lib-latest.zip を使用しているとします。この foo-lib-1.2.3/ディレクトリには WORKSPACE ファイルがあり、さらに、src/ディレクトリ、lib/ディレクトリ、test/ディレクトリにはビルドする実際のコードが格納されています。「foo-lib-1.2.3」ディレクトリを最上位ディレクトリとして使用するには、「strip_prefix = "foo-lib-1.2.3"」を指定します。 このディレクトリの外にファイルがある場合、それらは破棄され、アクセスできなくなります（最上位のライセンス ファイルなど）。これには、先頭が接頭辞で、ディレクトリ内にないファイル/ディレクトリ（例:「foo-lib-1.2.3.release-notes」など）。指定した接頭辞がアーカイブ内のディレクトリと一致しない場合、Bazel はエラーを返します。 |
type |
文字列。省略可 ダウンロードされたファイルのアーカイブ タイプ。 デフォルトでは、アーカイブ タイプは URL のファイル拡張子から決定されます。ファイルに拡張子がない場合は、"zip"`、"jar"`、"war"`、"aar"`、"tar"`、"tar.gz"`、"tgz"`、"tar.xz"`、"txz"`、"tar.zst"`、``z"`、"tar.zst"`、"tzst" のいずれかを明示的に指定できます。 |
url |
文字列。省略可 Bazel で使用できるようにするファイルの URL。 ファイル、http または https の URL を指定してください。リダイレクトが行われます。認証はサポートされていません。取得元の代替 URL を指定できる urls パラメータを使用すると、柔軟性を高めることができます。 |
urls |
文字列のリスト。省略可。 Bazel で使用できるようにするファイルの URL のリストです。 各エントリはファイル、HTTP または https の URL にする必要があります。リダイレクトが行われます。認証はサポートされていません。URL は、成功するまで順番に試行されるため、ローカルミラーを最初にリストする必要があります。すべてのダウンロードが失敗した場合、ルールは失敗します。 |
workspace_file |
ラベル（省略可） このリポジトリの「WORKSPACE」ファイルとして使用するファイル。「workspace_file」または「workspace_file_content」のどちらか一方を指定するか、どちらも指定できません。両方を指定することはできません。 |
workspace_file_content |
文字列。省略可 このリポジトリの WORKSPACE ファイルの内容。「workspace_file」または「workspace_file_content」のどちらか一方を指定するか、どちらも指定できません。両方を指定することはできません。 |
http_file
http_file(name, auth_patterns, canonical_id, downloaded_file_path, executable, integrity, netrc, sha256, url, urls)
URL からファイルをダウンロードし、ファイル グループとして使用できるようにします。
例: カスタムルール用の debian パッケージが必要であるとします。このパッケージは http://example.com/package.deb から入手できます。次に、WORKSPACE ファイルに以下を追加します。
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_file")
http_file(
name = "my_deb",
url = "http://example.com/package.deb",
sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
)
ターゲットは、このファイルに依存する依存関係として @my_deb//file を指定します。
属性
name |
Name（必須） このリポジトリの一意の名前。 |
auth_patterns |
辞書: 文字列 -> 文字列（省略可）
ホスト名をカスタム認証パターンにマッピングする辞書（省略可）。このディクショナリに URL のホスト名が含まれている場合、http リクエストの Authorization ヘッダーを生成するときに値がパターンとして使用されます。これにより、多くの一般的なクラウド ストレージ プロバイダで使用されているカスタム認証スキームを使用できるようになります。現在、このパターンでは
auth_patterns = {
"storage.cloudprovider.com": "Bearer <password>"
}
netrc:
machine storage.cloudprovider.com
password RANDOM-TOKEN
最終的な HTTP リクエストのヘッダーは次のようになります。
Authorization: Bearer RANDOM-TOKEN |
canonical_id |
文字列。省略可 ダウンロードしたアーカイブの正規 ID。 指定されていて空でない場合、bazel はキャッシュからアーカイブを取得しません（ただし、同じ正規 ID を持つリクエストによってキャッシュに追加された場合を除く）。 |
downloaded_file_path |
文字列。省略可 ダウンロードされたファイルに割り当てられたパス |
executable |
ブール値。省略可 ダウンロードしたファイルを実行可能にするかどうか。 |
integrity |
文字列。省略可 ダウンロードしたファイルの想定されたチェックサムは、サブリソースの整合性形式です。 ダウンロードしたファイルのチェックサムと一致する必要があります。リモート ファイルは変更される可能性があるため、チェックサムを省略することはセキュリティ上のリスクになります。このフィールドを省略すると、ビルドが非密閉型のものになります。開発を容易にするためのオプションですが、この属性または「sha256」は出荷前に設定する必要があります。 |
netrc |
文字列。省略可 認証に使用する .netrc ファイルの場所 |
sha256 |
文字列。省略可 ダウンロードされるファイルの想定 SHA-256 です。 ダウンロードしたファイルの SHA-256 と一致している必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ上のリスクが発生します。このフィールドを省略すると、ビルドが密閉型でなくなります。開発を容易にするためのオプションですが、リリース前に設定する必要があります。 |
url |
文字列。省略可 Bazel で使用できるようにするファイルの URL。 ファイル、http または https の URL を指定してください。リダイレクトが行われます。認証はサポートされていません。取得元の代替 URL を指定できる urls パラメータを使用すると、柔軟性を高めることができます。 |
urls |
文字列のリスト。省略可。 Bazel で使用できるようにするファイルの URL のリストです。 各エントリはファイル、HTTP または https の URL にする必要があります。リダイレクトが行われます。認証はサポートされていません。URL は、成功するまで順番に試行されるため、ローカルミラーを最初にリストする必要があります。すべてのダウンロードが失敗した場合、ルールは失敗します。 |
http_jar
http_jar(name, auth_patterns, canonical_id, downloaded_file_name, integrity, netrc, sha256, url, urls)
URL から jar をダウンロードし、java_import として利用できるようにします。
ダウンロードされるファイルの拡張子は .jar でなければなりません。
例: 現在のリポジトリに、ディレクトリ ~/chat-app をルートとするチャット プログラムのソースコードが含まれているとします。http://example.com/openssl-0.2.jar から利用可能な SSL ライブラリに依存する必要があります。
次の行が ~/chat-app/WORKSPACE に追加された場合、~/chat-app リポジトリ内のターゲットはこのターゲットに依存できます。
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_jar")
http_jar(
name = "my_ssl",
url = "http://example.com/openssl-0.2.jar",
sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
)
ターゲットでは、この jar に依存する依存関係として <code>@my_ssl//jar</code> を指定します。
Unix ベースのシステムを使用している場合は、「file:///path/to/file」を使用して現在のシステム（localhost）上のファイルを参照することもできます。Windows の場合は「file:///c:/path/to/file」を使用します。どちらの例でも、3 つのスラッシュ（/）に注意してください。最初の 2 つのスラッシュは file:// に属し、3 番目のスラッシュはファイルの絶対パスに属します。
属性
name |
Name（必須） このリポジトリの一意の名前。 |
auth_patterns |
辞書: 文字列 -> 文字列（省略可）
ホスト名をカスタム認証パターンにマッピングする辞書（省略可）。このディクショナリに URL のホスト名が含まれている場合、http リクエストの Authorization ヘッダーを生成するときに値がパターンとして使用されます。これにより、多くの一般的なクラウド ストレージ プロバイダで使用されているカスタム認証スキームを使用できるようになります。現在、このパターンでは
auth_patterns = {
"storage.cloudprovider.com": "Bearer <password>"
}
netrc:
machine storage.cloudprovider.com
password RANDOM-TOKEN
最終的な HTTP リクエストのヘッダーは次のようになります。
Authorization: Bearer RANDOM-TOKEN |
canonical_id |
文字列。省略可 ダウンロードしたアーカイブの正規 ID。 指定されていて空でない場合、bazel はキャッシュからアーカイブを取得しません（ただし、同じ正規 ID を持つリクエストによってキャッシュに追加された場合を除く）。 |
downloaded_file_name |
文字列。省略可 ダウンロードした jar に割り当てられたファイル名 |
integrity |
文字列。省略可 ダウンロードしたファイルの想定されたチェックサムは、サブリソースの整合性形式です。 ダウンロードしたファイルのチェックサムと一致する必要があります。リモート ファイルは変更される可能性があるため、チェックサムを省略することはセキュリティ上のリスクになります。このフィールドを省略すると、ビルドが非密閉型のものになります。開発を容易にするためのオプションですが、この属性または「sha256」は出荷前に設定する必要があります。 |
netrc |
文字列。省略可 認証に使用する .netrc ファイルの場所 |
sha256 |
文字列。省略可 ダウンロードされるファイルの想定 SHA-256 です。 ダウンロードしたファイルの SHA-256 と一致している必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ上のリスクが発生します。このフィールドを省略すると、ビルドが密閉型でなくなります。開発を容易にするために省略することもできますが、この属性または「integrity」は出荷前に設定する必要があります。 |
url |
文字列。省略可 Bazel で使用できるようにするファイルの URL。 ファイル、http または https の URL を指定してください。リダイレクトが行われます。認証はサポートされていません。取得元の代替 URL を指定できる urls パラメータを使用すると、柔軟性を高めることができます。 URL の末尾は「.jar」でなければなりません。 |
urls |
文字列のリスト。省略可。 Bazel で使用できるようにするファイルの URL のリストです。 各エントリはファイル、HTTP または https の URL にする必要があります。リダイレクトが行われます。認証はサポートされていません。URL は、成功するまで順番に試行されるため、ローカルミラーを最初にリストする必要があります。すべてのダウンロードが失敗した場合、ルールは失敗します。 すべての URL の末尾は「.jar」でなければなりません。 |