이 페이지에서는 저장소 규칙을 만드는 방법을 설명하고 자세한 내용을 위한 예시를 제공합니다.
외부 저장소는 WORKSPACE 파일에서만 사용할 수 있는 규칙으로, Bazel의 로드 단계에서 기본 제공되지 않는 작업을 사용 설정합니다. 각 외부 저장소 규칙은 자체 BUILD 파일과 아티팩트가 있는 자체 작업공간을 만듭니다. 타사 라이브러리 (예: Maven 패키지 라이브러리)에 종속되는 데 사용할 수 있을 뿐만 아니라 Bazel이 실행되는 호스트에 특정한 BUILD 파일을 생성하는 데도 사용할 수 있습니다.
저장소 규칙 생성
.bzl 파일에서 repository_rule 함수를 사용하여 새 저장소 규칙을 만들고 전역 변수에 저장합니다.
맞춤 저장소 규칙은 기본 저장소 규칙과 마찬가지로 사용할 수 있습니다. 필수 name 속성이 있으며 빌드 파일에 있는 모든 타겟은 <name>이 name 속성 값인 @<name>//package:target로 참조할 수 있습니다.
규칙은 명시적으로 빌드하거나 빌드의 종속 항목인 경우 로드됩니다. 이 경우 Bazel은 implementation 함수를 실행합니다. 이 함수는 저장소, 콘텐츠, BUILD 파일을 만드는 방법을 설명합니다.
속성
속성은 attrs 규칙 인수에 dict로 전달되는 규칙 인수입니다.
속성과 그 유형은 저장소 규칙을 정의할 때 나열됩니다. url 및 sha256 속성을 문자열로 정의하는 예:
local_repository = repository_rule(
implementation=_impl,
local=True,
attrs={
"url": attr.string(mandatory=True)
"sha256": attr.string(mandatory=True)
}
)
구현 함수 내의 속성에 액세스하려면 repository_ctx.attr.<attribute_name>를 사용합니다.
def _impl(repository_ctx):
url = repository_ctx.attr.url
checksum = repository_ctx.attr.sha256
모든 repository_rule에는 빌드 규칙과 마찬가지로 암시적으로 정의된 속성이 있습니다. 두 가지 암시적 속성은 name (빌드 규칙과 동일) 및 repo_mapping입니다. 저장소 규칙의 이름은 repository_ctx.name로 액세스할 수 있습니다. repo_mapping의 의미는 기본 저장소 규칙 local_repository 및 new_local_repository과 동일합니다.
속성 이름이 _로 시작하면 비공개이므로 사용자가 설정할 수 없습니다.
구현 함수
모든 저장소 규칙에는 implementation 함수가 필요합니다. 여기에는 규칙의 실제 로직이 포함되며 로드 단계에서 엄격하게 실행됩니다.
이 함수에는 입력 매개변수 repository_ctx가 정확히 하나 있습니다. 이 함수는 지정된 매개변수가 제공된 규칙이 재현 가능함을 나타내는 None를 반환하거나, 해당 규칙을 동일한 저장소를 생성하는 재현 가능한 규칙으로 변환하는 해당 규칙의 매개변수 집합이 포함된 dict를 반환합니다. 예를 들어 git 저장소를 추적하는 규칙의 경우 원래 지정된 부동 분기 대신 특정 커밋 식별자를 반환하는 것을 의미합니다.
입력 매개변수 repository_ctx는 속성 값과 비밀폐 함수 (바이너리 찾기, 바이너리 실행, 저장소에 파일 생성 또는 인터넷에서 파일 다운로드)에 액세스하는 데 사용할 수 있습니다. 자세한 내용은 라이브러리를 참고하세요. 예:
def _impl(repository_ctx):
repository_ctx.symlink(repository_ctx.attr.path, "")
local_repository = repository_rule(
implementation=_impl,
...)
구현 함수는 언제 실행되나요?
저장소의 구현 함수는 Bazel이 해당 저장소의 타겟을 필요로 할 때 실행됩니다. 예를 들어 다른 타겟 (다른 저장소에 있음)이 해당 타겟에 종속되거나 명령줄에 언급된 경우입니다. 그러면 구현 함수가 파일 시스템에 저장소를 생성해야 합니다. 이를 저장소 '가져오기'라고 합니다.
일반 타겟과 달리 저장소는 저장소를 다르게 만드는 변경사항이 발생해도 다시 가져오지 않아도 됩니다. 이는 Bazel이 변경사항을 감지할 수 없거나 모든 빌드에서 너무 많은 오버헤드를 유발하는 항목 (예: 네트워크에서 가져온 항목)이 있기 때문입니다. 따라서 다음 중 하나가 변경된 경우에만 저장소가 다시 가져옵니다.
WORKSPACE파일의 저장소 선언에 전달된 매개변수입니다.- 저장소 구현을 구성하는 Starlark 코드입니다.
repository_rule의environ속성으로 선언된 환경 변수의 값입니다. 이러한 환경 변수의 값은--action_env플래그를 사용하여 명령줄에서 하드와이어링할 수 있지만 이 플래그는 빌드의 모든 작업을 무효화합니다.- 라벨 (예:
//mypkg:label.txt,mypkg/label.txt아님)로 참조되는repository_ctx의read(),execute()및 유사한 메서드에 전달된 파일의 콘텐츠 bazel sync이 실행될 때
저장소가 다시 가져오는 시점을 제어하는 repository_rule의 두 가지 매개변수는 다음과 같습니다.
configure플래그가 설정된 경우--configure매개변수가 전달될 때만 저장소가bazel sync에서 다시 가져옵니다 (속성이 설정되지 않은 경우 이 명령어는 다시 가져오기를 유발하지 않음).local플래그가 설정된 경우 위의 사례 외에도 변경사항으로 인해 저장소 선언 또는 코드가 변경되었는지와 관계없이 Bazel 서버가 다시 시작되거나 저장소 선언에 영향을 미치는 파일 (예:WORKSPACE파일 또는 로드하는 파일)이 변경될 때도 저장소가 다시 가져옵니다.이 경우 비로컬 저장소는 다시 가져오지 않습니다. 이러한 저장소는 네트워크와 통신하거나 비용이 많이 드는 것으로 간주되기 때문입니다.
구현 함수 다시 시작
요청된 종속 항목이 누락된 경우 저장소를 가져오는 동안 구현 함수를 다시 시작할 수 있습니다. 이 경우 구현 함수의 실행이 중지되고 누락된 종속 항목이 해결되며 종속 항목이 해결된 후 함수가 다시 실행됩니다. 네트워크 액세스를 반복해야 할 수 있으므로 비용이 많이 드는 불필요한 다시 시작을 방지하기 위해 모든 라벨 인수를 기존 파일로 확인할 수 있는 경우 라벨 인수가 미리 가져옵니다. 함수 실행 중에만 구성된 문자열이나 라벨에서 경로를 확인하면 다시 시작이 발생할 수 있습니다.
외부 저장소 강제 재가져오기
정의나 종속 항목을 변경하지 않아도 외부 저장소가 오래될 수 있습니다. 예를 들어 소스를 가져오는 저장소는 서드 파티 저장소의 특정 브랜치를 따를 수 있으며 해당 브랜치에서 새 커밋을 사용할 수 있습니다. 이 경우 bazel sync를 호출하여 모든 외부 저장소를 무조건 다시 가져오도록 bazel에 요청할 수 있습니다.
또한 일부 규칙은 로컬 머신을 검사하며 로컬 머신이 업그레이드된 경우 오래된 규칙이 될 수 있습니다. 여기에서 repository_rule 정의에 configure 속성이 설정된 외부 저장소만 다시 가져오도록 Bazel에 요청할 수 있습니다. bazel sync --configure를 사용하세요.
예
C++ 자동 구성 도구 모음: 저장소 규칙을 사용하여 로컬 C++ 컴파일러, 환경, C++ 컴파일러가 지원하는 플래그를 찾아 Bazel용 C++ 구성 파일을 자동으로 만듭니다.
Go 저장소는 여러
repository_rule를 사용하여 Go 규칙을 사용하는 데 필요한 종속 항목 목록을 정의합니다.rules_jvm_external은 기본적으로
@maven라는 외부 저장소를 만들어 전이 종속 항목 트리의 모든 Maven 아티팩트의 빌드 타겟을 생성합니다.