Repositórios, espaços de trabalho, pacotes e destinos

O Bazel cria softwares a partir de códigos-fonte organizados em árvores de diretórios chamadas de repositórios. Um conjunto definido de repositórios compreende o espaço de trabalho. Os arquivos de origem nos repositórios são organizados em uma hierarquia aninhada de pacotes, em que cada pacote é um diretório que contém um conjunto de arquivos de origem relacionados e um arquivo BUILD. O arquivo BUILD especifica quais saídas de software podem ser criadas a partir da origem.

Repositórios

Os arquivos de origem usados em um build do Bazel são organizados em repositórios (geralmente abreviados como repos). Um repositório é uma árvore de diretórios com um arquivo marcador de limite na raiz. Esse arquivo marcador de limite pode ser MODULE.bazel, REPO.bazel, ou em contextos legados, WORKSPACE ou WORKSPACE.bazel.

O repositório em que o comando atual do Bazel está sendo executado é chamado de repositório principal. Outros repositórios (externos) são definidos por regras de repositório. Consulte a visão geral das dependências externas para mais informações.

Espaço de trabalho

Um espaço de trabalho é o ambiente compartilhado por todos os comandos do Bazel executados no mesmo repositório principal. Ele abrange o repositório principal e o conjunto de todos os repositórios externos definidos.

Historicamente, os conceitos de "repositório" e "espaço de trabalho" foram confundidos. O termo "espaço de trabalho" costuma ser usado para se referir ao repositório principal e, às vezes, até como sinônimo de "repositório".

Pacotes

A unidade principal de organização de código em um repositório é o pacote. Um pacote é uma coleção de arquivos relacionados e uma especificação de como eles podem ser usados para produzir artefatos de saída.

Um pacote é definido como um diretório que contém um BUILD arquivo chamado BUILD ou BUILD.bazel. Um pacote inclui todos os arquivos no diretório, além de todos os subdiretórios abaixo dele, exceto aqueles que contêm um arquivo BUILD. Com essa definição, nenhum arquivo ou diretório pode fazer parte de dois pacotes diferentes.

Por exemplo, na árvore de diretórios a seguir, há dois pacotes, my/app, e o subpacote my/app/tests. Observe que my/app/data não é um pacote, mas um diretório pertencente ao pacote my/app.

src/my/app/BUILD
src/my/app/app.cc
src/my/app/data/input.txt
src/my/app/tests/BUILD
src/my/app/tests/test.cc

Destinos

Um pacote é um contêiner de destinos, que são definidos no arquivo BUILD do pacote. A maioria dos destinos é de um dos dois tipos principais: arquivos e regras.

Os arquivos são divididos em dois tipos. Os arquivos de origem geralmente são escritos por pessoas e são verificados no repositório. Arquivos gerados, às vezes chamados de arquivos derivados ou de saída, não são verificados, mas são gerados a partir de arquivos de origem.

O segundo tipo de destino é declarado com uma regra. Cada instância de regra especifica a relação entre um conjunto de arquivos de entrada e um conjunto de arquivos de saída. As entradas de uma regra podem ser arquivos de origem, mas também podem ser as saídas de outras regras.

Se a entrada de uma regra é um arquivo de origem ou um arquivo gerado, na maioria dos casos, é irrelevante. O que importa é apenas o conteúdo desse arquivo. Esse fato facilita a substituição de um arquivo de origem complexo por um arquivo gerado produzido por uma regra, como acontece quando o trabalho de manter manualmente um arquivo altamente estruturado se torna muito cansativo e alguém escreve um programa para derivá-lo. Nenhuma mudança é necessária para os consumidores desse arquivo. Por outro lado, um arquivo gerado pode ser facilmente substituído por um arquivo de origem com apenas mudanças locais.

As entradas de uma regra também podem incluir outras regras. O significado preciso dessas relações costuma ser bastante complexo e dependente da linguagem ou da regra, mas intuitivamente é simples: uma regra de biblioteca C++ A pode ter outra regra de biblioteca C++ B como entrada. O efeito dessa dependência é que os arquivos de cabeçalho de B ficam disponíveis para A durante a compilação, os símbolos de B ficam disponíveis para A durante a vinculação e os dados de tempo de execução de B ficam disponíveis para A durante a execução.

Uma invariante de todas as regras é que os arquivos gerados por uma regra sempre pertencem ao mesmo pacote da regra. Não é possível gerar arquivos em outro pacote. No entanto, não é incomum que as entradas de uma regra venham de outro pacote.

Os grupos de pacotes são conjuntos de pacotes cujo objetivo é limitar a acessibilidade de determinadas regras. Os grupos de pacotes são definidos pela função package_group. Eles têm três propriedades: a lista de pacotes que contêm, o nome e outros grupos de pacotes que incluem. As únicas maneiras permitidas de se referir a eles são do visibility atributo de regras ou do default_visibility atributo de a função package. Eles não geram nem consomem arquivos. Para mais informações, consulte a package_group documentação.

Marcadores