追加のアクション ルール

問題を報告 ソースを表示

ルール

action_listener

ルールのソースを表示 
action_listener(name, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, extra_actions, features, licenses, mnemonics, restricted_to, tags, target_compatible_with, testonly, visibility)

警告: 追加のアクションは非推奨となりました。代わりにアスペクトを使用してください。

action_listener ルール自体は出力を生成しません。代わりに、ツールのデベロッパーは、アクションから extra_action へのマッピングを提供することで、extra_action をビルドシステムに挿入できます。

このルールの引数は、アクション ニーモニックを extra_action ルールにマッピングします。

オプション --experimental_action_listener=<label> を指定すると、ビルドは指定された action_listener を使用して extra_action をビルドグラフに挿入します。

例

action_listener(
    name = "index_all_languages",
    mnemonics = [
        "Javac",
        "CppCompile",
        "Python",
    ],
    extra_actions = [":indexer"],
)

action_listener(
    name = "index_java",
    mnemonics = ["Javac"],
    extra_actions = [":indexer"],
)

extra_action(
    name = "indexer",
    tools = ["//my/tools:indexer"],
    cmd = "$(location //my/tools:indexer)" +
          "--extra_action_file=$(EXTRA_ACTION_FILE)",
)

引数

属性
name

名前（必須）

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

ラベルのリスト。必須

この action_listener でビルドグラフに追加する extra_action ターゲットのリスト。 例: [ "//my/tools:analyzer" ]。
mnemonics

文字列のリスト（必須）

この action_listener がリッスンするアクション ニーモニックのリスト（例: [ "Javac" ]）。

ニーモニックは公開インターフェースではありません。ニーモニックとそのアクションが変わらない保証はありません。

extra_action

ルールのソースを表示 
extra_action(name, data, cmd, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, out_templates, requires_action_output, restricted_to, tags, target_compatible_with, testonly, toolchains, tools, visibility)

警告: 追加のアクションは非推奨となりました。代わりにアスペクトを使用してください。

extra_action ルールは、通常のビルド ターゲットとして指定されている場合、意味のある出力を生成しません。代わりに、既存のアクションをシャドウする追加のアクションをビルドグラフに挿入できます。

extra_action を有効にする方法の詳細については、action_listener をご覧ください。

extra_action はコマンドラインとして実行されます。コマンドライン ツールは、$(EXTRA_ACTION_FILE) としてプロトコル バッファを含むファイルにアクセスし、シャドーイングしている元のアクションに関する詳細情報を取得します。また、元のアクションがアクセスできるすべての入力ファイルにもアクセスできます。プロトコル バッファ内に格納されるデータの詳細については、extra_actions_base.proto をご覧ください。各 proto ファイルには ExtraActionInfo メッセージが含まれています。

他のすべてのアクションと同様に、追加のアクションはサンドボックス化されているため、処理できるように設計する必要があります。

引数

属性
name

名前（必須）

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

このルールは、 action_listener ルールの extra_actions 引数の label で参照できます。
cmd

文字列、必須

実行するコマンド。

genrule cmd 属性に似ていますが、次の点が異なります。

  1. ヒューリスティックなラベルの拡張なし。$(location ...) を使用するラベルのみが展開されます。

  2. 文字列に追加のパスが適用され、out_templates 属性から作成された出力がすべて置き換えられます。$(output out_template) はすべて、label で指定されるファイルのパスに置き換えられます。

    たとえば、out_template $(ACTION_ID).analysis は $(output $(ACTION_ID).analysis) と一致できます。

    実際には、これは $(location) と同じ置換ですが、スコープが異なります。
out_templates

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

extra_action コマンドで生成されたファイルのテンプレートのリスト。

テンプレートでは、次の変数を使用できます。

  • $(ACTION_ID)。この extra_action を一意に識別する ID。一意の出力ファイルを生成するために使用されます。
requires_action_output

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

この extra_action では、元のアクションの出力がこの extra_action への入力として存在する必要があることを示します。

true（デフォルトは false）の場合、extra_action は元のアクションの出力を入力の一部として使用できると想定できます。
tools

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

このルールの tool 依存関係のリスト。

詳細については、依存関係の定義をご覧ください。

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

すべてのツールとそのデータ依存関係は、コマンドが相対パスを使用できる 1 つのツリーに統合されます。作業ディレクトリは、統合されたツリーのルートになります。