Git リポジトリのルール

このページの内容
git_repository
new_git_repository

問題を報告ソースを表示 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6 

次の関数は @bazel_tools//tools/build_defs/repo:git.bzl から読み込むことができます。

外部 Git リポジトリのクローン作成のルール。

git_repository

load("@bazel//tools/build_defs/repo:git.bzl", "git_repository")

git_repository(name, branch, build_file, build_file_content, commit, init_submodules, patch_args,
               patch_cmds, patch_cmds_win, patch_strip, patch_tool, patches,
               recursive_init_submodules, remote, remote_module_file_integrity,
               remote_module_file_urls, shallow_since, sparse_checkout_file, sparse_checkout_patterns,
               strip_prefix, tag, verbose, workspace_file, workspace_file_content)

外部の git リポジトリのクローンを作成します。

Git リポジトリのクローンを作成し、指定されたタグまたは commit をチェックアウトして、そのターゲットをバインディングに使用できるようにします。また、実際にチェックアウトされたコミットの ID とその日付を特定し、このルールの再現可能なバージョンを提供するパラメータを含む辞書を返します（タグは必ずしもそうではありません）。

Bazel は、まず指定されたコミットのみの浅いフェッチを試みます。失敗した場合（通常はサーバーのサポートがないことが原因）、リポジトリの完全なフェッチにフォールバックします。

git_repository よりも http_archive を優先します。その理由は次のとおりです。

Git リポジトリルールはシステム git(1) に依存しますが、HTTP ダウンローダーは Bazel に組み込まれており、システム依存関係はありません。
http_archive はミラーとして urls のリストをサポートしますが、git_repository は単一の remote のみをサポートします。
http_archive はリポジトリキャッシュで動作しますが、git_repository では動作しません。詳しくは、#5116 をご覧ください。

ATTRIBUTES

`name`	名前。必須このリポジトリの一意の名前。
`branch`	文字列。省略可リモートリポジトリのブランチをチェックアウトします。branch、tag、commit のいずれか 1 つを指定する必要があります。
`build_file`	ラベル（省略可）このリポジトリの BUILD ファイルとして使用するファイル。この属性は絶対ラベルです（メインリポジトリには「@//」を使用します）。ファイル名は BUILD にする必要はありませんが、BUILD.new-repo-name のように、リポジトリの実際の BUILD ファイルと区別しやすい名前にするとよいでしょう。
`build_file_content`	文字列。省略可このリポジトリの BUILD ファイルの内容。
`commit`	文字列。省略可チェックアウトする特定の commit。branch、tag、commit のいずれか 1 つを指定する必要があります。
`init_submodules`	ブール値。省略可リポジトリ内のサブモジュールをクローンするかどうか。
`patch_args`	文字列のリスト。省略可パッチツールに指定された引数。デフォルトは -p0 です（`patch_strip` 属性を参照）。ただし、git で生成されたパッチには通常 -p1 が必要です。複数の -p 引数が指定されている場合は、最後の引数が有効になります。-p 以外の引数が指定されている場合、Bazel は Bazel ネイティブのパッチ実装ではなく、パッチコマンドラインツールを使用するようにフォールバックします。パッチコマンドラインツールにフォールバックし、patch_tool 属性が指定されていない場合は、`patch` が使用されます。
`patch_cmds`	文字列のリスト。省略可パッチの適用後に Linux/macOS に適用される Bash コマンドのシーケンス。
`patch_cmds_win`	文字列のリスト。省略可パッチの適用後に Windows に適用される PowerShell コマンドのシーケンス。この属性が設定されていない場合、Windows で patch_cmds が実行されます。これには Bash バイナリが存在する必要があります。
`patch_strip`	整数。省略可 `N` に設定すると、`patch_args` の先頭に `-pN` を挿入するのと同じになります。
`patch_tool`	文字列。省略可使用する patch(1) ユーティリティ。指定すると、Bazel は Bazel ネイティブのパッチ実装ではなく、指定されたパッチツールを使用します。
`patches`	ラベルのリスト。省略可アーカイブの抽出後にパッチとして適用されるファイルのリスト。デフォルトでは、ファジーマッチとバイナリパッチをサポートしていない Bazel ネイティブのパッチ実装を使用しますが、`patch_tool` 属性が指定されている場合や、`patch_args` 属性に `-p` 以外の引数がある場合は、Bazel はパッチコマンドラインツールを使用するようにフォールバックします。
`recursive_init_submodules`	ブール値。省略可リポジトリでサブモジュールを再帰的にクローンするかどうか。
`remote`	文字列。必須。リモートの Git リポジトリの URI
`remote_module_file_integrity`	文字列。省略可内部使用のみ。
`remote_module_file_urls`	文字列のリスト。省略可内部使用のみ。
`shallow_since`	文字列。省略可オプションの日付。指定されたコミットより後にはできません。タグまたはブランチが指定されている場合、この引数は使用できません（タグまたはブランチは常に --depth=1 でクローンできます）。このような日付を指定されたコミットの近くに設定すると、サーバーが任意のコミットの浅いフェッチをサポートしていない場合でも、リポジトリの浅いクローンを作成できる可能性があります。git の --shallow-since 実装のバグにより、この属性を使用するとフェッチが失敗する可能性があるため、使用はおすすめしません。
`sparse_checkout_file`	ラベル（省略可）このリポジトリ内のファイルのスパースチェックアウト用の .gitignore スタイルのパターンを含むファイル。`sparse_checkout_patterns` または `sparse_checkout_file` のいずれか、または両方とも指定しないことはできますが、両方を指定することはできません。
`sparse_checkout_patterns`	文字列のリスト。省略可このリポジトリ内のファイルのスパースチェックアウトのパターンのシーケンス。
`strip_prefix`	文字列。省略可抽出されたファイルから削除するディレクトリ接頭辞。
`tag`	文字列。省略可タグをチェックアウトします。branch、tag、commit のいずれか 1 つを指定する必要があります。
`verbose`	ブール値。省略可
`workspace_file`	ラベル（省略可） No-op 属性。使用しないでください。
`workspace_file_content`	文字列。省略可 No-op 属性。使用しないでください。

new_git_repository

load("@bazel//tools/build_defs/repo:git.bzl", "new_git_repository")

new_git_repository(name, branch, build_file, build_file_content, commit, init_submodules,
                   patch_args, patch_cmds, patch_cmds_win, patch_strip, patch_tool, patches,
                   recursive_init_submodules, remote, remote_module_file_integrity,
                   remote_module_file_urls, shallow_since, sparse_checkout_file,
                   sparse_checkout_patterns, strip_prefix, tag, verbose, workspace_file,
                   workspace_file_content)

外部の git リポジトリのクローンを作成します。

git_repository よりも http_archive を優先します。その理由は次のとおりです。

Git リポジトリルールはシステム git(1) に依存しますが、HTTP ダウンローダーは Bazel に組み込まれており、システム依存関係はありません。
http_archive はミラーとして urls のリストをサポートしますが、git_repository は単一の remote のみをサポートします。
http_archive はリポジトリキャッシュで動作しますが、git_repository では動作しません。詳しくは、#5116 をご覧ください。

ATTRIBUTES

`name`	名前。必須このリポジトリの一意の名前。
`branch`	文字列。省略可リモートリポジトリのブランチをチェックアウトします。branch、tag、commit のいずれか 1 つを指定する必要があります。
`build_file`	ラベル（省略可）このリポジトリの BUILD ファイルとして使用するファイル。この属性は絶対ラベルです（メインリポジトリには「@//」を使用します）。ファイル名は BUILD にする必要はありませんが、BUILD.new-repo-name のように、リポジトリの実際の BUILD ファイルと区別しやすい名前にするとよいでしょう。
`build_file_content`	文字列。省略可このリポジトリの BUILD ファイルの内容。
`commit`	文字列。省略可チェックアウトする特定の commit。branch、tag、commit のいずれか 1 つを指定する必要があります。
`init_submodules`	ブール値。省略可リポジトリ内のサブモジュールをクローンするかどうか。
`patch_args`	文字列のリスト。省略可パッチツールに指定された引数。デフォルトは -p0 です（`patch_strip` 属性を参照）。ただし、git で生成されたパッチには通常 -p1 が必要です。複数の -p 引数が指定されている場合は、最後の引数が有効になります。-p 以外の引数が指定されている場合、Bazel は Bazel ネイティブのパッチ実装ではなく、パッチコマンドラインツールを使用するようにフォールバックします。パッチコマンドラインツールにフォールバックし、patch_tool 属性が指定されていない場合は、`patch` が使用されます。
`patch_cmds`	文字列のリスト。省略可パッチの適用後に Linux/macOS に適用される Bash コマンドのシーケンス。
`patch_cmds_win`	文字列のリスト。省略可パッチの適用後に Windows に適用される PowerShell コマンドのシーケンス。この属性が設定されていない場合、Windows で patch_cmds が実行されます。これには Bash バイナリが存在する必要があります。
`patch_strip`	整数。省略可 `N` に設定すると、`patch_args` の先頭に `-pN` を挿入するのと同じになります。
`patch_tool`	文字列。省略可使用する patch(1) ユーティリティ。指定すると、Bazel は Bazel ネイティブのパッチ実装ではなく、指定されたパッチツールを使用します。
`patches`	ラベルのリスト。省略可アーカイブの抽出後にパッチとして適用されるファイルのリスト。デフォルトでは、ファジーマッチとバイナリパッチをサポートしていない Bazel ネイティブのパッチ実装を使用しますが、`patch_tool` 属性が指定されている場合や、`patch_args` 属性に `-p` 以外の引数がある場合は、Bazel はパッチコマンドラインツールを使用するようにフォールバックします。
`recursive_init_submodules`	ブール値。省略可リポジトリでサブモジュールを再帰的にクローンするかどうか。
`remote`	文字列。必須。リモートの Git リポジトリの URI
`remote_module_file_integrity`	文字列。省略可内部使用のみ。
`remote_module_file_urls`	文字列のリスト。省略可内部使用のみ。
`shallow_since`	文字列。省略可オプションの日付。指定されたコミットより後にはできません。タグまたはブランチが指定されている場合、この引数は使用できません（タグまたはブランチは常に --depth=1 でクローンできます）。このような日付を指定されたコミットの近くに設定すると、サーバーが任意のコミットの浅いフェッチをサポートしていない場合でも、リポジトリの浅いクローンを作成できる可能性があります。git の --shallow-since 実装のバグにより、この属性を使用するとフェッチが失敗する可能性があるため、使用はおすすめしません。
`sparse_checkout_file`	ラベル（省略可）このリポジトリ内のファイルのスパースチェックアウト用の .gitignore スタイルのパターンを含むファイル。`sparse_checkout_patterns` または `sparse_checkout_file` のいずれか、または両方とも指定しないことはできますが、両方を指定することはできません。
`sparse_checkout_patterns`	文字列のリスト。省略可このリポジトリ内のファイルのスパースチェックアウトのパターンのシーケンス。
`strip_prefix`	文字列。省略可抽出されたファイルから削除するディレクトリ接頭辞。
`tag`	文字列。省略可タグをチェックアウトします。branch、tag、commit のいずれか 1 つを指定する必要があります。
`verbose`	ブール値。省略可
`workspace_file`	ラベル（省略可） No-op 属性。使用しないでください。
`workspace_file_content`	文字列。省略可 No-op 属性。使用しないでください。