Estes são alguns problemas comuns e dúvidas sobre a criação de extensões.
Por que meu arquivo não foi produzido / minha ação nunca foi executada?
O Bazel só executa as ações necessárias para produzir os arquivos de saída solicitados.
Se o arquivo que você quer tiver um marcador, faça a solicitação diretamente:
bazel build //pkg:myfile.txt
Se o arquivo estiver em um grupo de saída do destino, talvez seja necessário especificar esse grupo de saída na linha de comando:
bazel build //pkg:mytarget --output_groups=foo
Se você quiser que o arquivo seja criado automaticamente sempre que o destino for mencionado na linha de comando, adicione-o às saídas padrão da regra retornando um provedor
DefaultInfo
.
Consulte a página Regras para mais informações.
Por que minha função de implementação não é executada?
O Bazel analisa apenas os destinos solicitados para o build. É necessário nomear o destino na linha de comando ou algo que dependa dele.
Um arquivo está ausente quando minha ação ou meu binário é executado
Verifique se 1) o arquivo foi registrado como uma entrada para a ação ou binário e se 2) o script ou a ferramenta que está sendo executada está acessando o arquivo usando o caminho correto.
Para ações, declare entradas transmitindo-as para a função ctx.actions.*
que cria a ação. O caminho adequado para o arquivo pode ser encontrado usando
File.path
.
Para binários (as saídas executáveis executadas por um comando bazel run
ou bazel test
), você declara entradas incluindo-as nos
runfiles. Em vez de usar o campo path
, use
File.short_path
, que é o caminho do arquivo relativo ao
diretório runfiles em que o binário é executado.
Como posso controlar quais arquivos são criados pelo bazel build //pkg:mytarget
?
Use o provedor DefaultInfo
para
definir as saídas padrão.
Como posso executar um programa ou fazer E/S de arquivos como parte do meu build?
Uma ferramenta pode ser declarada como um destino, assim como qualquer outra parte do build, e
ser executada durante a fase de execução para ajudar a criar outros destinos. Para criar uma ação
que execute uma ferramenta, use ctx.actions.run
e transmita a
ferramenta como o parâmetro executable
.
Durante as fases de carregamento e análise, uma ferramenta não pode ser executada, nem você pode executar E/S de arquivos. Isso significa que as ferramentas e o conteúdo do arquivo (exceto o conteúdo dos arquivos BUILD e .bzl) não podem afetar a forma como os gráficos de destino e de ação são criados.
E se eu precisar acessar os mesmos dados estruturados antes e durante a fase de execução?
É possível formatar os dados estruturados como um arquivo .bzl. É possível load()
o arquivo para
acessá-lo durante as fases de carregamento e análise. É possível transmiti-lo como uma entrada ou
runfile para ações e executáveis que precisam dele durante a fase de execução.
Como documentar o código Starlark?
Para regras e atributos de regras, é possível transmitir um literal de docstring (possivelmente entre aspas triplas) para o parâmetro doc
de rule
ou attr.*()
. Para funções
auxiliares e macros, use um literal de docstring entre aspas triplas seguindo o formato
especificado aqui.
As funções de implementação de regras geralmente não precisam da própria docstring.
O uso de literais de string nos locais esperados facilita a extração da documentação pelas ferramentas automatizadas. Fique à vontade para usar comentários padrão que não sejam strings sempre que possam ajudar o leitor do código.