その他のアクション ルール

問題を報告 ソースを表示

ルール

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

Name; required

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

List of labels; required

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

List of strings; required

この 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

Name; required

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

action_listener ルールの extra_actions 引数で、label によってこのルールを参照できます。
cmd

String; required

実行するコマンド。

genrule cmd 属性と次の点で異なります。

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

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

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

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

List of strings; optional

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

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

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

Boolean; optional; default is False

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

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

List of labels; optional

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

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

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

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