Regras de ações extras

Nightly · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 7.7

Regras

action_listener

Ver origem da regra 
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)

AVISO: as ações extras foram descontinuadas. Use aspectos em vez disso.

Uma regra action_listener não produz saída por si só. Em vez disso, ela permite que os desenvolvedores de ferramentas insiram extra_actions no sistema de build, fornecendo um mapeamento da ação para extra_action .

Os argumentos dessa regra mapeiam mnemônicos de ação para extra_action regras.

Ao especificar a opção --experimental_action_listener=<label>, o build vai usar o action_listener especificado para inserir extra_actions no gráfico de build.

Exemplo

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

Nome; obrigatório

Um nome exclusivo para esse destino.
extra_actions

Lista de rótulos; obrigatório

Uma lista de destinos extra_action que este action_listener precisa adicionar ao gráfico de build. Por exemplo, [ "//my/tools:analyzer" ].
mnemonics

Lista de strings; obrigatório

Uma lista de mnemônicos de ação que esse action_listener precisa detectar por exemplo, [ "Javac" ].

Os mnemônicos não são uma interface pública. Não há garantia de que os mnemônicos e as ações deles não vão mudar.

extra_action

Ver origem da regra 
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)

AVISO: as ações extras foram descontinuadas. Use aspectos em vez disso.

Uma regra extra_action não produz nenhuma saída significativa quando especificada como um destino de build regular. Em vez disso, ela permite que os desenvolvedores de ferramentas insiram ações adicionais no gráfico de build que substituem as ações atuais.

Consulte action_listener para mais detalhes sobre como ativar extra_actions.

Os extra_actions são executados como uma linha de comando. A ferramenta de linha de comando recebe acesso a um arquivo que contém um buffer de protocolo como $(EXTRA_ACTION_FILE) com informações detalhadas sobre a ação original que está sendo substituída. Ela também tem acesso a todos os arquivos de entrada que a ação original tem. Consulte extra_actions_base.proto para mais detalhes sobre os dados armazenados no buffer de protocolo. Cada arquivo proto contém uma mensagem ExtraActionInfo.

Assim como todas as outras ações, as ações extras são isoladas e precisam ser projetadas para lidar com isso.

Argumentos

Atributos
name

Nome; obrigatório

Um nome exclusivo para esse destino.

Esta regra é chamada de label no argumento extra_actions das regras action_listener.
cmd

String; obrigatório

O comando a ser executado.

Como o atributo cmd da genrule, com as seguintes diferenças:

  1. Sem expansão heurística de rótulo. Somente os rótulos que usam $(location ...) são expandidos.

  2. Uma passagem extra é aplicada à string para substituir todas as ocorrências das saídas criadas pelo out_templates atributo. Todas as ocorrências de $(output out_template) são substituídas pelo caminho para o arquivo indicado por label.

    Por exemplo, o out_template $(ACTION_ID).analysis pode ser correspondido a $(output $(ACTION_ID).analysis).

    Na verdade, essa é a mesma substituição de $(location) mas com um escopo diferente.

out_templates

Lista de strings; o padrão é []

Uma lista de modelos para arquivos gerados pelo extra_action comando.

O modelo pode usar as seguintes variáveis:

  • $(ACTION_ID), um ID que identifica exclusivamente esse extra_action. Usado para gerar um arquivo de saída exclusivo.

requires_action_output

Booleano; o padrão é False

Indica que esta extra_action requer que a saída da ação original esteja presente como entrada para esta extra_action.

Quando for "true" (o padrão é "false"), a extra_action poderá presumir que as saídas da ação original estão disponíveis como parte das entradas.

tools

Lista de rótulos; o padrão é []

Uma lista de tool dependências para essa regra.

Consulte a definição de dependências para mais informações.

O sistema de build garante que esses pré-requisitos sejam criados antes da execução do extra_action comando. Eles são criados usando a execconfiguração, já que precisam ser executados como uma ferramenta durante o build. O caminho de um destino tools //x:y individual pode ser obtido usando $(location //x:y).

Todas as ferramentas e dependências de dados são consolidadas em uma única árvore em que o comando pode usar caminhos relativos. O diretório de trabalho será a raiz dessa árvore unificada.