Regras de ações extras

Regras

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)

AVISO:as ações extras foram descontinuadas. Usar aspectos como alternativa.

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

Os argumentos desta regra mapeiam as ações mnemônicas para 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

Name; required

Um nome exclusivo para o destino.

extra_actions

List of labels; required

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

List of strings; required

Uma lista de mnemônicas de ação que este action_listener precisa ouvir por exemplo, [ "Javac" ].

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

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)

AVISO:as ações extras foram descontinuadas. Usar aspectos como alternativa.

Uma regra extra_action não produz saídas significativas quando especificado como um destino de build normal. Em vez disso, ele permite que os desenvolvedores de ferramentas para inserir outras ações no gráfico de build que sombreiam as ações existentes.

Consulte action_listener para ver mais detalhes sobre como ativar extra_actions.

As extra_actions são executadas 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 ele está acompanhando. Ele também tem acesso a todos os arquivos de entrada que a ação original pode acessar. Consulte extra_actions_base.proto para 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 colocadas no sandbox e devem ser projetadas para lidar com isso.

Argumentos

Atributos
name

Name; required

Um nome exclusivo para o destino.

Você pode se referir a essa regra usando label no argumento extra_actions de regras de action_listener.
cmd

String; required

Comando a ser executado.

Como o atributo genrule cmd com o seguinte diferenças:

  1. Não há expansão de rótulo heurística. Somente os marcadores que usam $(location ...) são expandidos.

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

    Por exemplo: out_template $(ACTION_ID).analysis pode corresponder a $(output $(ACTION_ID).analysis).

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

out_templates

List of strings; optional

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 este extra_action. Usado para gerar um arquivo de saída exclusivo.

requires_action_output

Boolean; optional; default is False

Indica que extra_action requer a saída do ação original seja presente como entrada para este extra_action.

Quando verdadeiro (o padrão é falso), a extra_action pode assumir que o as saídas da ação original estão disponíveis como parte das entradas.

tools

List of labels; optional

Uma lista de tool dependências para esta regra.

Veja a definição de dependências para mais informações imprecisas ou inadequadas.

O sistema de build garante que esses pré-requisitos sejam criados antes de executar o Comando extra_action; eles são criados usando hostconfiguração, já que precisam ser executados como uma ferramenta durante o build. O caminho de uma pessoa tools o objetivo de //x:y pode ser encontrado usando $(location //x:y)

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