Nesta página, explicamos como criar regras de repositório e fornecemos exemplos para mais detalhes.
Um repositório externo é uma regra que pode ser usada apenas
no arquivo WORKSPACE
e permite operações não herméticas na fase de carregamento
do Bazel. Cada regra de repositório externo cria o próprio espaço de trabalho, com os
próprios arquivos BUILD
e artefatos. Eles podem ser usados para depender de bibliotecas
de terceiros, como bibliotecas empacotadas Maven, mas também para gerar arquivos BUILD
específicos do host em que o Bazel está sendo executado.
Criação de regra de repositório
Em um arquivo .bzl
, use a função repository_rule para criar uma nova regra de repositório e armazene-a em uma variável global.
Uma regra de repositório personalizada pode ser usada da mesma forma que uma regra de repositório nativa. Ele
tem um atributo name
obrigatório, e todos os destinos presentes nos arquivos de build
podem ser chamados de @<name>//package:target
, em que <name>
é o valor do
atributo name
.
A regra é carregada quando você a cria explicitamente ou se é uma dependência do
build. Nesse caso, o Bazel executa a função implementation
. Essa
função descreve como criar o repositório, o conteúdo dele e os arquivos BUILD
.
Atributos
Os atributos são argumentos de regra transmitidos como um dict para o argumento de regra attrs
.
Os atributos e os respectivos tipos são listados quando você define uma regra de repositório. Um exemplo que define os atributos url
e sha256
como
strings:
local_repository = repository_rule(
implementation=_impl,
local=True,
attrs={
"url": attr.string(mandatory=True)
"sha256": attr.string(mandatory=True)
}
)
Para acessar um atributo na função de implementação, use
repository_ctx.attr.<attribute_name>
:
def _impl(repository_ctx):
url = repository_ctx.attr.url
checksum = repository_ctx.attr.sha256
Todas as repository_rule
s têm atributos definidos implicitamente, assim como as regras de
build. Os dois atributos implícitos são name
(assim como para regras de build) e
repo_mapping
. O nome de uma regra de repositório pode ser acessado com
repository_ctx.name
. O significado de repo_mapping
é o mesmo das
regras de repositório nativo
local_repository
e
new_local_repository
.
Se um nome de atributo começar com _
, ele será particular e não poderá ser definido pelos usuários.
Função de implementação
Toda regra de repositório requer uma função implementation
. Ela contém a lógica real da regra e é executada estritamente na fase de carregamento.
A função tem exatamente um parâmetro de entrada, repository_ctx
. A função retorna None
para indicar que a regra pode ser reproduzida com base nos parâmetros especificados, ou um dict com um conjunto de parâmetros para essa regra que a transformaria em uma regra reproduzível que gera o mesmo repositório. Por
exemplo, uma regra que rastreia um repositório Git significa retornar um
identificador de confirmação específico em vez de uma ramificação flutuante que foi especificada
originalmente.
O parâmetro de entrada repository_ctx
pode ser usado para
acessar valores de atributos e funções não herméticas (encontrar um binário,
executar um binário, criar um arquivo no repositório ou fazer o download de um arquivo
da Internet). Consulte a biblioteca para mais
contexto. Exemplo:
def _impl(repository_ctx):
repository_ctx.symlink(repository_ctx.attr.path, "")
local_repository = repository_rule(
implementation=_impl,
...)
Quando a função de implementação é executada?
A função de implementação de um repositório é executada quando o Bazel precisa de um destino desse repositório. Por exemplo, quando outro destino (em outro repositório) depende dele ou se ele é mencionado na linha de comando. Espera-se que a função de implementação crie o repositório no sistema de arquivos. Isso é chamado de "buscar" o repositório.
Diferente dos destinos comuns, os repositórios não são buscados novamente quando algo muda e causa uma diferença no repositório. Isso ocorre porque o Bazel não consegue detectar mudanças em algumas coisas ou pode causar sobrecarga demais em cada build (por exemplo, itens buscados na rede). Portanto, os repositórios serão buscados novamente somente se uma das seguintes coisas mudar:
- Os parâmetros transmitidos para a declaração do repositório no
arquivo
WORKSPACE
. - O código Starlark que compreende a implementação do repositório.
- Valor de qualquer variável de ambiente declarada com o atributo
environ
dorepository_rule
. Os valores dessas variáveis de ambiente podem ser conectados na linha de comando com a sinalização--action_env
, mas ela invalidará todas as ações do build. - O conteúdo de qualquer arquivo transmitido para
read()
,execute()
e métodos semelhantes derepository_ctx
que é referenciado por um rótulo (por exemplo,//mypkg:label.txt
, mas nãomypkg/label.txt
) - Quando
bazel sync
é executado.
Há dois parâmetros de repository_rule
que controlam quando os repositórios
são buscados novamente:
- Se a flag
configure
for definida, o repositório só vai ser buscado novamente embazel sync
quando o parâmetro--configure
for transmitido para ele. Se o atributo não for definido, esse comando não vai causar uma nova busca. Se a sinalização
local
estiver definida, além dos casos acima, o repositório também será buscado novamente quando o servidor do Bazel for reiniciado ou quando qualquer arquivo que afete a declaração do repositório mudar (por exemplo, o arquivoWORKSPACE
ou um arquivo carregado), independentemente de terem causado mudanças na declaração ou no código do repositório.Os repositórios não locais não são buscados novamente nesses casos. Isso ocorre porque supõe-se que esses repositórios se comuniquem com a rede ou sejam caros.
Como reiniciar a função de implementação
A função de implementação poderá ser reiniciada enquanto um repositório estiver sendo buscado se uma dependência solicitada estiver ausente. Nesse caso, a execução da função de implementação será interrompida, a dependência ausente será resolvida e a função será executada novamente após a resolução. Para evitar reinicializações desnecessárias (que são caras porque o acesso à rede pode precisar ser repetido), os argumentos de rótulo são pré-buscados, desde que todos eles possam ser resolvidos em um arquivo atual. Observe que resolver um caminho de uma string ou um rótulo criado apenas durante a execução da função ainda pode causar uma reinicialização.
Como forçar uma nova busca de repositórios externos
Às vezes, um repositório externo pode ficar desatualizado sem qualquer mudança na definição ou nas dependências dele. Por exemplo, um repositório que busca origens pode
seguir uma ramificação específica de um repositório de terceiros, e novas confirmações estão
disponíveis nessa ramificação. Nesse caso, você pode solicitar que o Bazel refaça a busca de todos
os repositórios externos incondicionalmente chamando bazel sync
.
Além disso, algumas regras inspecionam a máquina local e podem ficar desatualizadas se a máquina local tiver sido atualizada. Aqui, você pode pedir que o Bazel
refaça apenas os repositórios externos em que a definição
repository_rule
tem o conjunto de atributos configure
. Use bazel sync --configure
.
Exemplos
Conjunto de ferramentas configurado automaticamente para C++: ele usa uma regra de repositório para criar automaticamente os arquivos de configuração C++ para o Bazel. Para isso, ele procura o compilador C++ local, o ambiente e as sinalizações compatíveis com o compilador C++.
Os repositórios do Go usam vários
repository_rule
para definir a lista de dependências necessárias para usar as regras do Go.rules_jvm_external cria um repositório externo chamado
@maven
por padrão, que gera destinos de build para cada artefato Maven na árvore de dependências transitiva.