Reglas de acciones adicionales

Reglas

objeto de escucha_acción

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)

ADVERTENCIA: Las acciones adicionales dejaron de estar disponibles. En su lugar, usa aspectos.

Una regla action_listener no produce ningún resultado. En cambio, permite que los desarrolladores de herramientas inserten extra_action en el sistema de compilación, lo que proporciona una asignación de la acción a extra_action .

Este argumento asigna mnemónicos de acción a las reglas de extra_action.

Cuando se especifica la opción --experimental_action_listener=<label>, la compilación usa el action_listener especificado para insertar extra_action en el gráfico de compilación.

Ejemplo

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)",
)

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

extra_actions

List of labels; required

Se debe agregar al gráfico de compilación una lista de objetivos de extra_action que debe agregar action_listener. P.ej., [ "//my/tools:analyzer" ].
mnemonics

List of strings; required

Una lista de acciones mnemotécnicas que action_listener debe escuchar, p. ej., [ "Javac" ]

Los mnemónicos no son una interfaz pública. No se garantiza que los mnemónicos ni sus acciones cambien.

acción_adicional

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)

ADVERTENCIA: Las acciones adicionales dejaron de estar disponibles. En su lugar, usa aspectos.

Una regla extra_action no produce ningún resultado significativo cuando se especifica como un objetivo de compilación normal. En cambio, les permite a los desarrolladores de herramientas insertar acciones adicionales en el gráfico de compilación que cubre las acciones existentes.

Consulta action_listener a fin de obtener información para habilitar extra_action.

Los extra_action se ejecutan como una línea de comandos. La herramienta de línea de comandos obtiene acceso a un archivo que contiene un búfer de protocolo como $(EXTRA_ACTION_FILE) con información detallada sobre la acción original que está reemplazando. También tiene acceso a todos los archivos de entrada a los que tiene acceso la acción original. Consulta extra_actions_base.proto para obtener más información sobre los datos almacenados dentro del búfer de protocolo. Cada archivo proto contiene un mensaje ExtraActionInfo.

Como todas las demás acciones, las acciones adicionales están en una zona de pruebas y deben diseñarse para manejar eso.

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

Puedes hacer referencia a esta regla mediante label en el argumento extra_actions de las reglas action_listener.
cmd

String; required

El comando para ejecutar.

Al igual que el atributo genrule cmd, con las siguientes diferencias:

  1. Sin expansión heurística de etiquetas. Solo están expandidas las etiquetas que usan $(location ...).

  2. Se aplica un pase adicional a la string para reemplazar todos los casos de los resultados creados a partir del atributo out_templates. Todos los casos de $(output out_template) se reemplazan por la ruta de acceso al archivo indicado por label.

    P.ej., out_template $(ACTION_ID).analysis puede coincidir con $(output $(ACTION_ID).analysis).

    En efecto, esta es la misma sustitución que $(location), pero con un alcance diferente.

out_templates

List of strings; optional

Una lista de plantillas para los archivos generados por el comando extra_action.

La plantilla puede usar las siguientes variables:

  • $(ACTION_ID), un ID que identifica de forma única a este extra_action. Se usa para generar un archivo de salida único.

requires_action_output

Boolean; optional; default is False

Indica que extra_action requiere que la salida de la acción original esté presente como entrada para este extra_action.

Cuando es verdadero (falso predeterminado), el elemento extra_action puede asumir que los resultados de la acción original están disponibles como parte de sus entradas.

tools

List of labels; optional

Una lista de dependencias de tool para esta regla.

Consulta la definición de dependencias para obtener más información.

El sistema de compilación garantiza que estos requisitos previos se compilen antes de ejecutar el comando extra_action; se compilan mediante la hostconfiguración, ya que deben ejecutarse como una herramienta durante la compilación. La ruta de acceso de un tools individual de destino //x:y se puede obtener mediante $(location //x:y).

Todas las herramientas y sus dependencias de datos se consolidan en un solo árbol, dentro del cual el comando puede usar rutas de acceso relativas. El directorio de trabajo será la raíz de ese árbol unificado.