一般規則

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

ルール

エイリアス

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

alias ルールは、ルールを参照できる別の名前を作成します。

エイリアシングは「通常」のターゲットでのみ機能します。特に、package_grouptest_suite はエイリアス化できません。

エイリアスは、ターゲットの名前を変更すると多くのファイルに変更が必要になる大規模なリポジトリで役立ちます。複数のターゲットでロジックを再利用する場合は、エイリアス ルールを使用して select 関数呼び出しを保存することもできます。

エイリアス ルールには独自の可視性宣言があります。その他の点では、参照先のルールと同様に動作します(たとえば、エイリアスの testonly は無視され、参照先のルールの testonly が代わりに使用されます)。ただし、いくつかの例外があります。

  • エイリアスがコマンドラインで指定されている場合、テストは実行されません。参照されるテストを実行するエイリアスを定義するには、tests 属性に単一のターゲットを含む test_suite ルールを使用します。
  • 環境グループを定義する場合、environment ルールのエイリアスはサポートされていません。--target_environment コマンドライン オプションでもサポートされていません。

filegroup(
    name = "data",
    srcs = ["data.txt"],
)

alias(
    name = "other",
    actual = ":data",
)

引数

属性
name

名前(必須)

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

actual

ラベル(必須)

このエイリアスが参照するターゲット。ルールである必要はなく、入力ファイルでもかまいません。

config_setting

ルールソースを表示
config_setting(name, constraint_values, define_values, deprecation, distribs, features, flag_values, licenses, tags, testonly, values, visibility)

構成可能な属性をトリガーする目的で、想定される構成状態(ビルドフラグまたはプラットフォーム制約として表現)と一致します。このルールの使用方法については、select をご覧ください。一般的な機能の概要については、 構成可能な属性をご覧ください。

次のパターンは、--compilation_mode=opt または -c opt を設定するビルド(コマンドラインで明示的に設定するか、.bazelrc ファイルから暗黙的に設定する)に一致します。

  config_setting(
      name = "simple",
      values = {"compilation_mode": "opt"}
  )
  

次の例では、ARM をターゲットとするビルドに一致し、カスタム定義 FOO=barbazel build --cpu=arm --define FOO=bar ... など)を適用します。

  config_setting(
      name = "two_conditions",
      values = {
          "cpu": "arm",
          "define": "FOO=bar"
      }
  )
  

次のパターンは、ユーザー定義フラグ --//custom_flags:foo=1 を設定するビルド(コマンドラインで明示的に設定するか、.bazelrc ファイルから暗黙的に設定する)に一致します。

  config_setting(
      name = "my_custom_flag_is_set",
      flag_values = { "//custom_flags:foo": "1" },
  )
  

次の例は、ラベル //example:glibc_2_25constraint_value が存在することを前提として、x86_64 アーキテクチャと glibc バージョン 2.25 のプラットフォームをターゲットとするビルドに一致します。この 2 つ以外に制約値を定義している場合でも、プラットフォームは一致します。

  config_setting(
      name = "64bit_glibc_2_25",
      constraint_values = [
          "@platforms//cpu:x86_64",
          "//example:glibc_2_25",
      ]
  )
  
これらのケースでは、ビルド内で構成が変更される可能性があります。たとえば、ターゲットの依存関係とは異なるプラットフォーム用にターゲットをビルドする必要がある場合などです。つまり、config_setting が最上位のコマンドライン フラグと一致しない場合でも、一部のビルド ターゲットと一致する可能性があります。

メモ

  • 複数の config_setting が現在の構成状態と一致した場合の動作については、select をご覧ください。
  • 短縮形をサポートするフラグ(--compilation_mode-c など)の場合、values 定義では完全な形式を使用する必要があります。これらの呼び出しは、どちらの形式でも自動的に照合されます。
  • フラグが複数の値(--copt=-Da --copt=-Db やリスト型の Starlark フラグなど)を受け取る場合、"a" が実際のリストのどこかに存在すれば、values = { "flag": "a" } は一致します。

    values = { "myflag": "a,b" } も同様に動作します。これは --myflag=a --myflag=b--myflag=a --myflag=b --myflag=c--myflag=a,b--myflag=c,b,a と一致します。正確なセマンティクスはフラグによって異なります。たとえば、--copt同じインスタンス内の複数の値をサポートしていません。--copt=a,b["a,b"] を生成し、--copt=a --copt=b["a", "b"] を生成します(そのため、values = { "copt": "a,b" } は前者と一致しますが、後者とは一致しません)。ただし、--ios_multi_cpus(Apple ルールの場合)は実行します-ios_multi_cpus=a,bios_multi_cpus=a --ios_multi_cpus=b の両方で ["a", "b"] が生成されます。フラグの定義を確認し、条件を慎重にテストして、正確な期待値を確認します。

  • 組み込みのビルドフラグでモデル化されていない条件を定義する必要がある場合は、 Starlark で定義されたフラグを使用します。--define を使用することもできますが、サポートが弱く、推奨されません。詳細については、こちらをご覧ください。
  • 異なるパッケージで同じ config_setting 定義を繰り返さないようにします。代わりに、正規パッケージで定義された共通の config_setting を参照してください。
  • valuesdefine_valuesconstraint_values は、同じ config_setting で任意の組み合わせで使用できますが、任意の config_setting に対して少なくとも 1 つを設定する必要があります。

引数

属性
name

名前(必須)

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

constraint_values

ラベルのリスト。構成不可。デフォルトは []

この config_setting に一致するために、ターゲット プラットフォームが指定する必要がある constraint_values の最小セット。(ここでは実行プラットフォームは考慮されません)。プラットフォームが持つ追加の制約値は無視されます。詳細については、 構成可能なビルド属性をご覧ください。

2 つの config_setting が同じ select で一致する場合、この属性は、一方の config_setting が他方の config_setting の特殊化であるかどうかを判断する目的では考慮されません。つまり、ある config_setting が別の config_setting よりも特定のプラットフォームに強く一致することはありません。

define_values

ディクショナリ: 文字列 -> 文字列。構成不可。デフォルトは {}

values と同じですが、--define フラグ専用です。

--define は、その構文(--define KEY=VAL)が Bazel フラグの観点から KEY=VALであることを意味するため、特別です。

つまり、次のようになります。

            config_setting(
                name = "a_and_b",
                values = {
                    "define": "a=1",
                    "define": "b=2",
                })
          

同じキー(define)が辞書に 2 回出現するため、機能しません。この属性でその問題を解決できます。

            config_setting(
                name = "a_and_b",
                define_values = {
                    "a": "1",
                    "b": "2",
                })
          

bazel build //foo --define a=1 --define b=2 と正しく一致します。

--define は、通常のフラグ構文で values に引き続き表示できます。また、辞書キーが区別される限り、この属性と自由に混在させることができます。

flag_values

ディクショナリ: label -> String; nonconfigurable; デフォルトは {}

values と同じですが、 ユーザー定義のビルドフラグ用です。

ユーザー定義のフラグはラベルとして参照され、組み込みフラグは任意の文字列として参照されるため、これは個別の属性です。

values

ディクショナリ: 文字列 -> 文字列。構成不可。デフォルトは {}

このルールに一致する構成値のセット(ビルドフラグとして表現)

このルールは、select ステートメントで参照する構成済みターゲットの構成を継承します。辞書のすべてのエントリについて、その構成がエントリの想定値と一致する場合、Bazel 呼び出しは「一致」と見なされます。たとえば、values = {"compilation_mode": "opt"} は、ターゲット構成ルールの呼び出し bazel build --compilation_mode=opt ...bazel build -c opt ... に一致します。

便宜上、構成値はビルドフラグとして指定されます(先頭の "--" は付きません)。ただし、この 2 つは同じではないことに注意してください。これは、同じビルド内で複数の構成でターゲットをビルドできるためです。たとえば、exec 構成の「cpu」は --cpu ではなく --host_cpu の値と一致します。そのため、同じ config_setting の異なるインスタンスは、それらを使用するルールの構成に応じて、同じ呼び出しを異なる方法で照合する可能性があります。

コマンドラインでフラグが明示的に設定されていない場合は、デフォルト値が使用されます。辞書にキーが複数回出現する場合、最後のインスタンスのみが使用されます。キーがコマンドラインで複数回設定できるフラグ(bazel build --copt=foo --copt=bar --copt=baz ... など)を参照している場合、それらの設定のいずれかが一致すると、一致が発生します。

filegroup

ルールソースを表示
filegroup(name, srcs, data, compatible_with, deprecation, distribs, features, licenses, output_group, restricted_to, tags, target_compatible_with, testonly, visibility)

filegroup を使用して、ターゲットのコレクションにわかりやすい名前を付けます。これらの値は、他のルールから参照できます。

ディレクトリを直接参照するのではなく、filegroup を使用することをおすすめします。後者は、ビルドシステムがディレクトリ以下のすべてのファイルを完全に把握していないため、これらのファイルが変更されても再ビルドされない可能性があるため、適切ではありません。glob と組み合わせると、filegroup はすべてのファイルがビルドシステムに明示的に認識されるようにします。

2 つのソースファイルで構成される filegroup を作成するには、

filegroup(
    name = "mygroup",
    srcs = [
        "a_file.txt",
        "some/subdirectory/another_file.txt",
    ],
)

または、glob を使用して testdata ディレクトリを検索します。

filegroup(
    name = "exported_testdata",
    srcs = glob([
        "testdata/*.dat",
        "testdata/logs/**/*.log",
    ]),
)

これらの定義を使用するには、任意のルールからラベル付きの filegroup を参照します。

cc_library(
    name = "my_library",
    srcs = ["foo.cc"],
    data = [
        "//my_package:exported_testdata",
        "//my_package:mygroup",
    ],
)

引数

属性
name

名前(必須)

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

srcs

ラベルのリスト。デフォルトは []

ファイル グループのメンバーであるターゲットのリスト。

srcs 属性の値に glob 式の結果を使用するのが一般的です。

data

ラベルのリスト。デフォルトは []

このルールが実行時に必要とするファイルのリスト。

data 属性で指定されたターゲットは、この filegroup ルールの runfiles に追加されます。filegroup が別のルールの data 属性で参照されている場合、その runfiles は依存ルールの runfiles に追加されます。データファイルに依存して使用する方法について詳しくは、データ依存関係のセクションと data の一般的なドキュメントをご覧ください。

output_group

文字列。デフォルトは "" です。

ソースからアーティファクトを収集する出力グループ。この属性が指定されている場合、デフォルトの出力グループではなく、依存関係の指定された出力グループのアーティファクトがエクスポートされます。

「出力グループ」は、ターゲットの出力アーティファクトのカテゴリであり、そのルールの実装で指定されます。

genquery

ルールソースを表示
genquery(name, deps, data, compatible_with, compressed_output, deprecation, distribs, exec_compatible_with, exec_properties, expression, features, licenses, opts, restricted_to, scope, strict, tags, target_compatible_with, testonly, visibility)

genquery() は、Blaze クエリ言語で指定されたクエリを実行し、結果をファイルにダンプします。

ビルドの一貫性を保つため、クエリは scope 属性で指定されたターゲットの推移閉包のみを対象とします。このルールに違反するクエリは、strict が指定されていないか true の場合、実行時に失敗します(strict が false の場合、範囲外のターゲットは警告とともにスキップされます)。これを回避する最も簡単な方法は、クエリ式と同じラベルをスコープで指定することです。

ここで許可されるクエリとコマンドラインで許可されるクエリの唯一の違いは、ワイルドカード ターゲット仕様(//pkg:*//pkg:all など)を含むクエリがここでは許可されないことです。これには 2 つの理由があります。1 つ目は、genquery でスコープを指定して、クエリの推移的閉包外のターゲットがその出力に影響を与えないようにする必要があるためです。2 つ目は、BUILD ファイルがワイルドカード依存関係をサポートしていないためです(deps=["//a/..."] などは許可されていません)。

genquery の出力は、確定的な出力を強制するために辞書順に並べ替えられます。ただし、--output=graph|minrank|maxrank の場合、または somepath がトップレベル関数として使用されている場合は除きます。

出力ファイルの名前はルールの名前です。

この例では、指定されたターゲットの推移閉包内のラベルのリストをファイルに書き込みます。

genquery(
    name = "kiwi-deps",
    expression = "deps(//kiwi:kiwi_lib)",
    scope = ["//kiwi:kiwi_lib"],
)

引数

属性
name

名前(必須)

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

compressed_output

ブール値。デフォルトは False です。

True の場合、クエリ出力は GZIP ファイル形式で書き込まれます。この設定は、クエリ出力が大きくなることが予想される場合に、Bazel のメモリ使用量の急増を回避するために使用できます。Bazel は、この設定の値に関係なく、220 バイトを超えるクエリ出力を内部的に圧縮するため、この設定を True に設定しても、保持されるヒープが削減されない可能性があります。ただし、出力ファイルの書き込み時に Bazel が解凍をスキップできるようになります。これはメモリを大量に消費する可能性があります。
expression

文字列。必須

実行するクエリ。コマンドラインや BUILD ファイルの他の場所とは異なり、ここでのラベルはワークスペースのルート ディレクトリを基準として解決されます。たとえば、ファイル a/BUILD のこの属性のラベル :b は、ターゲット //:b を参照します。
opts

文字列のリスト。デフォルトは [] です。

クエリエンジンに渡されるオプション。これらは、bazel query に渡すことができるコマンドライン オプションに対応しています。--keep_going--query_file--universe_scope--order_results--order_output などのクエリ オプションは使用できません。ここで指定されていないオプションは、bazel query のコマンドラインと同様にデフォルト値になります。
scope

ラベルのリスト。必須

クエリのスコープ。クエリは、これらのターゲットの推移閉包外のターゲットにアクセスできません。
strict

ブール値。デフォルトは True です。

true の場合、クエリがスコープの推移閉包からエスケープするターゲットはビルドに失敗します。false の場合、Bazel は警告を出力し、スコープ外に導いたクエリパスをスキップして、残りのクエリを完了します。

genrule

ルールソースを表示
genrule(name, srcs, outs, cmd, cmd_bash, cmd_bat, cmd_ps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, executable, features, licenses, local, message, output_licenses, output_to_bindir, restricted_to, tags, target_compatible_with, testonly, toolchains, tools, visibility)

genrule は、ユーザー定義の Bash コマンドを使用して 1 つ以上のファイルを生成します。

Genrule は、タスクに固有のルールがない場合に使用できる汎用ビルドルールです。たとえば、Bash のワンライナーを実行できます。ただし、C++ ファイルをコンパイルする必要がある場合は、既存の cc_* ルールを使用してください。すべての重い処理はすでに完了しています。

genrule では、コマンド引数を解釈するためにシェルが必要になります。PATH で使用可能な任意のプログラムを参照することも簡単ですが、コマンドが非ハーメチックになり、再現できない可能性があります。単一のツールのみを実行する必要がある場合は、代わりに run_binary の使用を検討してください。

テストの実行に genrule を使用しないでください。テストとテスト結果には、キャッシュ保存ポリシーや環境変数など、特別な免除があります。テストは通常、ビルドの完了後、ターゲット アーキテクチャで実行する必要がありますが、genrule はビルド中、実行アーキテクチャで実行されます(この 2 つは異なる場合があります)。汎用テストルールが必要な場合は、sh_test を使用します。

クロスコンパイルに関する考慮事項

クロス コンパイルについて詳しくは、ユーザー マニュアルをご覧ください。

genrule はビルド中に実行されますが、その出力はビルド後(デプロイやテストなど)に使用されることがよくあります。マイクロコントローラ用の C コードのコンパイルの例を考えてみましょう。コンパイラは C ソースファイルを受け取り、マイクロコントローラで実行されるコードを生成します。生成されたコードは、ビルドに使用された CPU で実行できませんが、C コンパイラ(ソースからコンパイルされた場合)自体は実行する必要があります。

ビルドシステムは、実行構成を使用してビルドが実行されるマシンを記述し、ターゲット構成を使用してビルドの出力が実行されるマシンを記述します。これらの各項目を構成するオプションが用意されており、競合を避けるために対応するファイルが個別のディレクトリに分離されます。

genrules の場合、ビルドシステムは依存関係が適切にビルドされるようにします。ターゲット構成に対して srcs が(必要に応じて)ビルドされ、実行構成に対して tools がビルドされ、出力はターゲット構成のものとみなされます。また、genrule コマンドが対応するツールに渡すことができる 「Make」変数も提供します。

genrule が deps 属性を定義しないのは意図的なものです。他の組み込みルールは、ルール間で渡される言語依存のメタ情報を使用して、依存ルールを処理する方法を自動的に決定しますが、genrule ではこのレベルの自動化はできません。Genrule は、ファイルと runfile のレベルでのみ機能します。

特別なケース

Exec-exec コンパイル: ビルド システムで、ビルド中に出力も実行できるように genrule を実行する必要がある場合があります。たとえば、genrule がカスタム コンパイラをビルドし、そのコンパイラが別の genrule で使用される場合、最初の genrule は exec 構成の出力を生成する必要があります。これは、コンパイラが別の genrule で実行される場所であるためです。この場合、ビルドシステムは自動的に適切な処理を行います。ターゲット構成ではなく、実行構成の最初の genrule の srcsouts をビルドします。詳しくは、ユーザー マニュアルをご覧ください。

JDK と C++ ツール: JDK または C++ コンパイラ スイートのツールを使用するには、ビルドシステムが使用する変数のセットを提供します。詳しくは、「Make」変数をご覧ください。

Genrule 環境

genrule コマンドは、コマンドまたはパイプラインが失敗した場合に set -e -o pipefail を使用して失敗するように構成された Bash シェルによって実行されます。

ビルドツールは、PATHPWDTMPDIR などのコア変数のみを定義するサニタイズされたプロセス環境で Bash コマンドを実行します。ビルドの再現性を確保するため、ユーザーのシェル環境で定義されたほとんどの変数は genrule のコマンドに渡されません。ただし、Bazel(Blaze ではない)はユーザーの PATH 環境変数の値を渡します。PATH の値が変更されると、Bazel は次のビルドでコマンドを再実行します。

genrule コマンドは、コマンド自体の子であるプロセスを接続する場合を除き、ネットワークにアクセスしてはなりません。ただし、このルールは現在強制されていません。

ビルドシステムは、既存の出力ファイルを自動的に削除しますが、genrule を実行する前に必要な親ディレクトリを作成します。また、失敗した場合は出力ファイルも削除します。

一般的なアドバイス

  • genrule によって実行されるツールが決定論的で密閉型であることを確認してください。タイムスタンプを出力に書き込まず、セットとマップには安定した順序を使用し、出力には相対ファイルパスのみを書き込み、絶対パスは書き込まないようにする必要があります。このルールに従わないと、予期しないビルド動作(Bazel が再ビルドしない genrule がある)が発生し、キャッシュのパフォーマンスが低下します。
  • 出力、ツール、ソースに $(location) を多用します。構成ごとに異なる出力ファイルが分離されているため、genrule はハードコードされたパスや絶対パスに依存できません。
  • 同じまたは非常に類似した genrule が複数の場所で使用される場合は、共通の Starlark マクロを作成してください。genrule が複雑な場合は、スクリプトまたは Starlark ルールとして実装することを検討してください。これにより、読みやすさとテストのしやすさが向上します。
  • 終了コードが genrule の成功または失敗を正しく示していることを確認してください。
  • 情報メッセージを stdout または stderr に書き込まないでください。デバッグには役立ちますが、ノイズになりやすいので、genrule が成功した場合は何も出力しないようにします。一方、失敗した genrule は適切なエラー メッセージを生成する必要があります。
  • $$ evaluates to a $, a literal dollar-sign, so in order to invoke a shell command containing dollar-signs such as ls $(dirname $x), one must escape it thus: ls $$(dirname $$x)
  • シンボリック リンクとディレクトリの作成は避けてください。Bazel は genrule によって作成されたディレクトリ/シンボリック リンク構造をコピーせず、ディレクトリの依存関係チェックが不適切です。
  • 他のルールで genrule を参照する場合は、genrule のラベルまたは個々の出力ファイルのラベルを使用できます。一方のアプローチが読みやすい場合もあれば、他方のアプローチが読みやすい場合もあります。使用側のルールの srcs で名前で出力を参照すると、genrule の他の出力を誤って取得することを回避できますが、genrule が多くの出力を生成する場合は面倒になる可能性があります。

この例では、foo.h が生成されます。コマンドは入力を受け取らないため、ソースはありません。コマンドによって実行される「バイナリ」は、genrule と同じパッケージ内の perl スクリプトです。

genrule(
    name = "foo",
    srcs = [],
    outs = ["foo.h"],
    cmd = "./$(location create_foo.pl) > \"$@\"",
    tools = ["create_foo.pl"],
)

次の例は、filegroup と別の genrule の出力を使用する方法を示しています。明示的な $(location) ディレクティブの代わりに $(SRCS) を使用しても機能します。この例では、説明のために後者を使用しています。

genrule(
    name = "concat_all_files",
    srcs = [
        "//some:files",  # a filegroup with multiple files in it ==> $(locations)
        "//other:gen",   # a genrule with a single output ==> $(location)
    ],
    outs = ["concatenated.txt"],
    cmd = "cat $(locations //some:files) $(location //other:gen) > $@",
)

引数

属性
name

名前(必須)

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


他の BUILD ルールの srcs セクションまたは deps セクションで、このルールを名前で参照できます。ルールがソースファイルを生成する場合は、srcs 属性を使用する必要があります。
srcs

ラベルのリスト。デフォルトは []

処理するソースファイルなど、このルールの入力のリスト。

この属性は cmd によって実行されるツールをリストするのには適していません。代わりに tools 属性を使用してください。

ビルドシステムは、genrule コマンドを実行する前にこれらの前提条件がビルドされるようにします。これらは、元のビルド リクエストと同じ構成を使用してビルドされます。これらの前提条件のファイル名は、$(SRCS) のスペース区切りのリストとしてコマンドで使用できます。または、個々の srcs ターゲット //x:y のパスは、$(location //x:y) を使用して取得できます。また、srcs のエントリが 1 つだけの場合は、$< を使用して取得することもできます。

outs

ファイル名のリスト。設定不可。必須

このルールによって生成されたファイルのリスト。

出力ファイルはパッケージ境界を越えてはなりません。出力ファイル名は、パッケージからの相対名として解釈されます。

executable フラグが設定されている場合、outs にはラベルが 1 つだけ含まれている必要があります。

genrule コマンドは、各出力ファイルを所定の場所に作成することが想定されています。ロケーションは、cmdgenrule 固有の「Make」変数$@$(OUTS)$(@D) $(RULEDIR))または $(location) 置換を使用して利用できます。

cmd

文字列。デフォルトは "" です。

実行するコマンド。$(location) 「Make」変数の置換の対象となります。
  1. 最初に $(location) の置換が適用され、$(location label)$(locations label)(および関連する変数 execpathexecpathsrootpathrootpaths を使用した同様の構造)のすべての出現箇所が置き換えられます。
  2. 次に、「Make」変数が展開されます。事前定義された変数 $(JAVA)$(JAVAC)$(JAVABASE)exec 構成で展開されるため、ビルドステップの一部として実行される Java 呼び出しは、共有ライブラリやその他の依存関係を正しく読み込むことができます。
  3. 最後に、Bash シェルを使用して結果のコマンドが実行されます。終了コードがゼロ以外の場合、コマンドは失敗したとみなされます。
これは、cmd_bashcmd_pscmd_bat のいずれにも該当しない場合のフォールバックです。

コマンドラインの長さがプラットフォームの上限(Linux/macOS では 64K、Windows では 8K)を超えると、genrule はコマンドをスクリプトに書き込み、そのスクリプトを実行して回避します。これは、すべての cmd 属性(cmdcmd_bashcmd_pscmd_bat)に適用されます。

cmd_bash

文字列。デフォルトは "" です。

実行する Bash コマンド。

この属性は cmd よりも優先されます。コマンドが展開され、cmd 属性とまったく同じように実行されます。

cmd_bat

文字列。デフォルトは "" です。

Windows で実行するバッチ コマンド。

この属性は、cmdcmd_bash よりも優先順位が高くなります。このコマンドは cmd 属性と同様に実行されますが、次の点が異なります。

  • この属性は Windows でのみ適用されます。
  • このコマンドは、次のデフォルト引数を指定して cmd.exe /c を実行します。
    • /S - 最初と最後の引用符を削除し、残りのすべてをそのまま実行します。
    • /E:ON - 拡張コマンドセットを有効にします。
    • /V:ON - 遅延変数展開を有効にする
    • /D - 自動実行レジストリ エントリを無視します。
  • $(location)「Make」変数の置換後、パスは Windows スタイルのパス(バックスラッシュ付き)に展開されます。
cmd_ps

文字列。デフォルトは "" です。

Windows で実行する Powershell コマンド。

この属性は、cmdcmd_bashcmd_bat よりも優先順位が高くなります。このコマンドは、cmd 属性と同様の方法で実行されますが、次の点が異なります。

  • この属性は Windows でのみ適用されます。
  • このコマンドは powershell.exe /c で実行されます。

Powershell を使いやすく、エラーが発生しにくくするために、genrule で Powershell コマンドを実行する前に、次のコマンドを実行して環境を設定します。

  • Set-ExecutionPolicy -Scope CurrentUser RemoteSigned - 署名なしスクリプトの実行を許可します。
  • $errorActionPreference='Stop' - ; で区切られた複数のコマンドがある場合、Powershell CmdLet が失敗するとアクションはすぐに終了しますが、外部コマンドでは機能しません。
  • $PSDefaultParameterValues['*:Encoding'] = 'utf8' - デフォルトのエンコードを utf-16 から utf-8 に変更します。
executable

ブール値。構成不可。デフォルトは False

出力を実行可能として宣言します。

このフラグを True に設定すると、出力は実行可能ファイルになり、run コマンドを使用して実行できます。この場合、genrule は 1 つの出力を生成する必要があります。この属性が設定されている場合、run はコンテンツに関係なくファイルの実行を試みます。

生成された実行可能ファイルのデータ依存関係の宣言はサポートされていません。

local

ブール値。デフォルトは False です。

True に設定すると、このオプションは genrule が「ローカル」戦略を使用して実行されるように強制します。つまり、リモート実行、サンドボックス化、永続的なワーカーは行われません。

これは、タグ(tags=["local"])として「local」を指定するのと同じです。

message

文字列。デフォルトは "" です。

進行状況メッセージ。

このビルドステップの実行時に出力される進行状況メッセージ。デフォルトでは、メッセージは「出力を生成しています」(または同様の無味乾燥なメッセージ)ですが、より具体的なメッセージを指定することもできます。この属性は、cmd コマンドで echo や他の print 文の代わりに使用します。これにより、ビルドツールでこのような進行状況メッセージを出力するかどうかを制御できます。

output_licenses

ライセンス タイプ。デフォルトは ["none"]

common attributes を参照してください。
output_to_bindir

ブール値。構成不可。デフォルトは False

True に設定すると、このオプションにより、出力ファイルが genfiles ディレクトリではなく bin ディレクトリに書き込まれます。

tools

ラベルのリスト。デフォルトは []

このルールのツールの依存関係のリスト。詳しくは、依存関係の定義をご覧ください。

ビルドシステムは、genrule コマンドを実行する前にこれらの前提条件がビルドされるようにします。これらのツールはビルドの一部として実行されるため、exec 構成を使用してビルドされます。個々の tools ターゲット //x:y のパスは、$(location //x:y) を使用して取得できます。

cmd によって実行される *_binary またはツールは、正しい構成でビルドされるように、srcs ではなくこのリストに表示される必要があります。

starlark_doc_extract

ルールソースを表示
starlark_doc_extract(name, deps, src, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, render_main_repo_name, restricted_to, symbol_names, tags, target_compatible_with, testonly, visibility)

starlark_doc_extract() は、特定の .bzl ファイルまたは .scl ファイルで定義または再エクスポートされたルール、関数(マクロを含む)、アスペクト、プロバイダのドキュメントを抽出します。このルールの出力は、Bazel ソースツリーの stardoc_output.proto で定義されている ModuleInfo バイナリ proto です。

暗黙的な出力ターゲット

  • name.binaryproto(デフォルトの出力): ModuleInfo バイナリ プロト。
  • name.textproto(明示的にリクエストされた場合にのみビルド): name.binaryproto のテキスト プロトコル バージョン。

警告: このルールの出力形式は安定しているとは限りません。これは主に Stardoc の内部使用を目的としています。

引数

属性
name

名前(必須)

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

deps

ラベルのリスト。デフォルトは []

src によって load() される Starlark ファイルをラップするターゲットのリスト。これらのターゲットは、通常の使用では bzl_library ターゲットである必要がありますが、starlark_doc_extract ルールではこれが強制されず、DefaultInfo で Starlark ファイルを提供する任意のターゲットが受け入れられます。

ラップされた Starlark ファイルはソースツリー内のファイルである必要があります。Bazel は生成されたファイルを load() できません。

src

ラベル(必須)

ドキュメントを抽出する Starlark ファイル。

これはソースツリー内のファイルである必要があります。Bazel は生成されたファイルを load() できません。

render_main_repo_name

ブール値。デフォルトは False です。

true の場合、メイン リポジトリのラベルは、リポジトリ コンポーネントを含む出力ドキュメントでレンダリングされます(つまり、//foo:bar.bzl@main_repo_name//foo:bar.bzl として出力されます)。

メイン リポジトリに使用する名前は、メイン リポジトリの MODULE.bazel ファイルの module(name = ...)(Bzlmod が有効になっている場合)またはメイン リポジトリの WORKSPACE ファイルの workspace(name = ...) から取得されます。

この属性は、同じリポジトリ内でのみ使用される Starlark ファイルのドキュメントを生成する場合は False に、他のリポジトリから使用される Starlark ファイルのドキュメントを生成する場合は True に設定する必要があります。

symbol_names

文字列のリスト。デフォルトは [] です。

ドキュメントを抽出するエクスポートされた関数、ルール、プロバイダ、アスペクト(またはそれらがネストされている構造体)の完全修飾名の省略可能なリスト。ここで、修飾名とは、エンティティがモジュールのユーザーに提供される名前を意味します。これには、エンティティがネームスペース用にネストされている構造体も含まれます。

starlark_doc_extract は、次の条件を満たす場合にのみエンティティのドキュメントを出力します。

  1. エンティティの完全修飾名の各コンポーネントが公開されている(つまり、完全修飾名の各コンポーネントの最初の文字がアルファベットで、"_" ではない)。
    1. symbol_names リストが空(デフォルト)の場合、
    2. エンティティの完全修飾名、またはエンティティがネストされている構造体の完全修飾名が symbol_names リストに含まれている。

test_suite

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

test_suite は、人間にとって「有用」と見なされる一連のテストを定義します。これにより、プロジェクトで「チェックイン前に実行する必要があるテスト」、「プロジェクトのストレステスト」、「すべての小規模テスト」などのテストセットを定義できます。blaze test コマンドはこの種の編成を尊重します。blaze test //some/test:suite のような呼び出しの場合、Blaze はまず //some/test:suite ターゲットによって推移的に含まれるすべてのテスト ターゲットを列挙し(これを「test_suite 拡張」と呼びます)、次に Blaze はこれらのターゲットをビルドしてテストします。

現在のパッケージ内のすべての小規模テストを実行するテストスイート。

test_suite(
    name = "small_tests",
    tags = ["small"],
)

指定されたテストセットを実行するテストスイート:

test_suite(
    name = "smoke_tests",
    tests = [
        "system_unittest",
        "public_api_unittest",
    ],
)

不安定でない現在のパッケージ内のすべてのテストを実行するテストスイート。

test_suite(
    name = "non_flaky_test",
    tags = ["-flaky"],
)

引数

属性
name

名前(必須)

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

tags

文字列のリスト。設定不可。デフォルトは []

「small」、「database」、「-flaky」などのテキストタグのリスト。タグには任意の有効な文字列を指定できます。

「-」で始まるタグは除外タグと見なされます。先行する「-」文字はタグの一部とは見なされないため、「-small」のスイートタグはテストの「small」サイズと一致します。それ以外のタグはすべてポジティブ タグとみなされます。

必要に応じて、正のタグをより明確にするために、タグの先頭に「+」文字を使用することもできます。この文字はタグのテキストの一部として評価されません。正と負の区別を読みやすくするだけです。

陽性タグのすべてに一致し、陰性タグのいずれにも一致しないテストルールのみがテストスイートに含まれます。これは、除外されたテストの依存関係のエラーチェックがスキップされるという意味ではありません。スキップされたテストの依存関係は、引き続き有効である必要があります(可視性制約によってブロックされていないなど)。

manual タグのキーワードは、ワイルドカードのターゲット パターンを含む呼び出しで blaze test コマンドによって実行される「テストスイートの拡張」によって、上記とは異なる扱いを受けます。ここで、「手動」のタグが付いた test_suite ターゲットは除外されます(したがって、拡張されません)。この動作は、blaze buildblaze test がワイルドカード ターゲット パターンを一般的に処理する方法と一致しています。スイートは manual タグに関係なく、常に tests クエリ関数によって展開されるため、これは blaze query 'tests(E)' の動作とは明確に異なります。

テストの size は、フィルタリングの目的でタグと見なされます。

相互に排他的なタグ(すべての小規模テストと中規模テストなど)を含む test_suite が必要な場合は、3 つの test_suite ルールを作成する必要があります。1 つはすべての小規模テスト用、1 つはすべての中規模テスト用、もう 1 つは前の 2 つを含むルールです。

tests

ラベルのリスト。構成不可。デフォルトは []

任意の言語のテストスイートとテスト ターゲットのリスト。

ここでは、言語に関係なく任意の *_test が受け入れられます。ただし、テストを実行したとしても、*_binary ターゲットは受け入れられません。指定された tags によるフィルタリングは、この属性に直接リストされているテストに対してのみ行われます。この属性に test_suite が含まれている場合、それらの内部のテストはこの test_suite によってフィルタされません(すでにフィルタされていると見なされます)。

tests 属性が指定されていないか空の場合、ルールはデフォルトで、manual としてタグ付けされていない現在の BUILD ファイル内のすべてのテストルールを含むようになります。これらのルールは、引き続き tag フィルタリングの対象となります。