Regras de ações extras

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Regras

action_listener

Acessar a 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. Em vez disso, ele permite que os desenvolvedores de ferramentas insiram extra_actions no sistema de build, fornecendo um mapeamento de ação para extra_action .

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

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 essa segmentação.
extra_actions

Lista de rótulos, obrigatório

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

Lista de strings; obrigatório

Uma lista de mnemônicas de ação que este 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

Acessar a 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, ele permite que os desenvolvedores de ferramentas insiram outras ações no gráfico de build que ocultam as ações atuais.

Consulte action_listener para saber como ativar extra_actions.

Os extra_actions são executados como uma linha de comando. A ferramenta de linha de comando tem 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 sombreada. Ela também tem acesso a todos os arquivos de entrada a que a ação original tem acesso. Consulte extra_actions_base.proto para ver detalhes sobre os dados armazenados dentro do 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 isso.

Argumentos

Atributos
name

Nome: obrigatório

Um nome exclusivo para essa segmentação.

É possível consultar essa regra com label no argumento extra_actions das regras action_listener.
cmd

String; obrigatório

O comando a ser executado.

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

  1. Nenhuma expansão de marcador heurístico. Somente os rótulos que usam $(location ...) são expandidos.

  2. Um passe adicional é aplicado à string para substituir todas as ocorrências das saídas criadas pelo atributo out_templates. Todas as ocorrências de $(output out_template) são substituídas pelo caminho do arquivo indicado por label.

    Por exemplo, $(ACTION_ID).analysis out_template pode ser combinado com $(output $(ACTION_ID).analysis).

    Na prática, 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 comando extra_action.

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 esse extra_action exige que a saída da ação original esteja presente como entrada para esse extra_action.

Quando verdadeiro (padrão falso), o extra_action pode assumir 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 esta regra.

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

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

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