Правила рабочей области

Правила рабочей области используются для подключения внешних зависимостей, как правило, исходного кода, расположенного вне основного хранилища.

Примечание: помимо собственных правил рабочей области, Bazel также включает различные правила рабочей области Starlark, в частности, те, что обрабатывают git-хранилища или архивы, размещенные в сети.

Правила

• bind
• local_repository
• new_local_repository

bind

bind(name, actual, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

Предупреждение: использование bind() не рекомендуется. См. "Рассмотрите возможность удаления bind" для подробного обсуждения проблем и альтернатив. В частности, рассмотрите использование repo_mapping атрибутов репозитория.

Предупреждение: select() не может использоваться в bind(). См. Разъяснения по атрибутам конфигурации для получения подробной информации.

Присваивает целевому объекту псевдоним в //external пакете.

//external пакет не является "обычным" пакетом: в нём нет каталога external/, поэтому его можно рассматривать как "виртуальный пакет", содержащий все связанные целевые объекты.

Примеры

Для присвоения целевому объекту псевдонима, bind его в файле WORKSPACE. Например, предположим, что есть целевой объект java_library под названием //third_party/javacc-v2. Это можно создать с псевдонимом, добавив следующее в файл WORKSPACE:

bind(
    name = "javacc-latest",
    actual = "//third_party/javacc-v2",
)

Теперь целевые объекты могут зависеть от //external:javacc-latest вместо //third_party/javacc-v2. Если javacc-v3 будет выпущен, правило bind можно обновить, и все файлы BUILD, зависящие от //external:javacc-latest, теперь будут зависеть от javacc-v3 без необходимости редактирования.

Bind также можно использовать для предоставления доступа к целевым объектам во внешних репозиториях в вашей рабочей области. Например, если в файле WORKSPACE импортирован удаленный репозиторий под названием @my-ssl и в нём есть целевой объект cc_library //src:openssl-lib, вы можете создать псевдоним для этого объекта, используя bind.

bind(
    name = "openssl",
    actual = "@my-ssl//src:openssl-lib",
)

Затем в файле BUILD в вашей рабочей области связанный целевой объект можно использовать следующим образом:

cc_library(
    name = "sign-in",
    srcs = ["sign_in.cc"],
    hdrs = ["sign_in.h"],
    deps = ["//external:openssl"],
)

Внутри sign_in.cc и sign_in.h, к заголовочным файлам, экспортированным //external:openssl, можно обращаться, используя их путь относительно корня репозитория. Например, если определение правила для @my-ssl//src:openssl-lib выглядит следующим образом:

cc_library(
    name = "openssl-lib",
    srcs = ["openssl.cc"],
    hdrs = ["openssl.h"],
)

Тогда включения sign_in.cc могут выглядеть так:

#include "sign_in.h"
#include "src/openssl.h"

Аргументы

local_repository

local_repository(name, path, repo_mapping)

Позволяет связывать целевые объекты из локального каталога. Это означает, что текущий репозиторий может использовать целевые объекты, определенные в этом другом каталоге. См. раздел bind для получения более подробной информации.

Примеры

Предположим, что текущий репозиторий — это клиент чата, расположенный в каталоге ~/chat-app. Он хочет использовать библиотеку SSL, которая определена в другом репозитории: ~/ssl. Библиотека SSL имеет целевой объект //src:openssl-lib.

Пользователь может добавить зависимость от этого целевого объекта, добавив следующие строки в ~/chat-app/WORKSPACE:

local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
)

Целевые объекты укажут на @my-ssl//src:openssl-lib в качестве зависимости, чтобы использовать эту библиотеку.

Аргументы

new_local_repository

new_local_repository(name, build_file, build_file_content, path, repo_mapping, workspace_file, workspace_file_content)

Позволяет преобразовать локальный каталог в репозиторий Bazel. Это означает, что текущий репозиторий может определять и использовать целевые объекты из любого места в файловой системе.

Это правило создаёт репозиторий Bazel путём создания файла WORKSPACE и подкаталога, содержащего символические ссылки на файл BUILD и указанный путь. Файл сборки должен создавать целевые объекты относительно path. Для каталогов, которые уже содержат файл WORKSPACE и файл BUILD, можно использовать правило local_repository.

Примеры

Предположим, что текущий репозиторий — это клиент чата, расположенный в каталоге ~/chat-app. Он хочет использовать библиотеку SSL, которая определена в другом каталоге: ~/ssl.

Пользователь может добавить зависимость, создав файл BUILD для библиотеки SSL (~/chat-app/BUILD.my-ssl) с содержимым:

java_library(
    name = "openssl",
    srcs = glob(['*.java'])
    visibility = ["//visibility:public"],
)

Затем они могут добавить следующие строки в ~/chat-app/WORKSPACE:

new_local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
    build_file = "BUILD.my-ssl",
)

Это создаст репозиторий @my-ssl со символической ссылкой на /home/user/ssl. Целевые объекты могут зависеть от этой библиотеки, добавив @my-ssl//:openssl в зависимости целевого объекта.

Также можно использовать new_local_repository для включения отдельных файлов, а не только каталогов. Например, предположим, что у вас есть файл jar по адресу /home/username/Downloads/piano.jar. Вы можете добавить этот файл в свою сборку, добавив следующее в файл WORKSPACE:

new_local_repository(
    name = "piano",
    path = "/home/username/Downloads/piano.jar",
    build_file = "BUILD.piano",
)

И создав файл BUILD.piano со следующим содержимым:

java_import(
    name = "play-music",
    jars = ["piano.jar"],
    visibility = ["//visibility:public"],
)

Аргументы