Bazel 모듈

문제 신고 소스 보기 나이틀리 빌드 · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Bazel 모듈은 여러 버전을 가질 수 있는 Bazel 프로젝트로, 각 버전은 종속된 다른 모듈에 관한 메타데이터를 게시합니다. 이는 Maven 아티팩트, npm 패키지, Go 모듈, Cargo 크레이트와 같은 다른 종속 항목 관리 시스템의 친숙한 개념과 유사합니다.

모듈에는 저장소 루트에 MODULE.bazel 파일이 있어야 합니다. 이 파일은 모듈의 매니페스트로, 이름, 버전, 직접 종속 항목 목록 및 기타 정보를 선언합니다. 기본 예시:

module(name = "my-module", version = "1.0")

bazel_dep(name = "rules_cc", version = "0.0.1")
bazel_dep(name = "protobuf", version = "3.19.0")

MODULE.bazel 파일에서 사용할 수 있는 명령어의 전체 목록을 참고하세요.

모듈 확인을 실행하기 위해 Bazel은 루트 모듈의 MODULE.bazel 파일을 읽는 것으로 시작한 다음 전체 종속성 그래프를 발견할 때까지 Bazel 레지스트리에서 종속 항목의 MODULE.bazel 파일을 반복적으로 요청합니다.

그러면 Bazel이 사용할 각 모듈의 버전을 하나 선택합니다. Bazel은 각 모듈을 저장소로 나타내고 레지스트리를 다시 참고하여 각 저장소를 정의하는 방법을 알아냅니다.

버전 형식

Bazel에는 다양한 생태계가 있으며 프로젝트에서는 다양한 버전 관리 스키마를 사용합니다. 가장 인기 있는 버전 관리 체계는 SemVer이지만, 버전이 날짜 기반인 20210324.2와 같은 Abseil과 같이 다른 체계를 사용하는 유명 프로젝트도 있습니다.

이러한 이유로 Bzlmod는 더 완화된 버전의 SemVer 사양을 채택합니다. 차이점은 다음과 같습니다.

  • SemVer에서는 버전의 'release' 부분이 MAJOR.MINOR.PATCH의 세그먼트로 구성되어야 한다고 규정합니다. Bazel에서는 이 요구사항이 완화되어 세그먼트 수가 허용됩니다.
  • SemVer에서 '버전' 부분의 각 세그먼트는 숫자만으로 구성되어야 합니다. Bazel에서는 문자도 허용하도록 완화되어 비교 의미 체계가 '사전 출시' 부분의 '식별자'와 일치합니다.
  • 또한 주 버전, 부 버전, 패치 버전 증가의 시맨틱이 적용되지 않습니다. 하지만 이전 버전과의 호환성을 나타내는 방법에 관한 자세한 내용은 호환성 수준을 참고하세요.

유효한 SemVer 버전은 유효한 Bazel 모듈 버전입니다. 또한 두 SemVer 버전 a와 b는 Bazel 모듈 버전으로 비교될 때 동일한 경우에만 a < b를 비교합니다.

버전 선택

버전이 지정된 종속 항목 관리 공간에서 흔히 볼 수 있는 다이아몬드 종속 항목 문제를 생각해 보세요. 다음과 같은 종속 항목 그래프가 있다고 가정해 보겠습니다.

       A 1.0
      /     \
   B 1.0    C 1.1
     |        |
   D 1.0    D 1.1

어떤 버전의 D를 사용해야 하나요? 이 문제를 해결하기 위해 Bzlmod는 Go 모듈 시스템에 도입된 최소 버전 선택(MVS) 알고리즘을 사용합니다. MVS는 모듈의 모든 새 버전이 이전 버전과 호환된다고 가정하므로 종속 항목 (이 예에서는 D 1.1)에서 지정한 가장 높은 버전을 선택합니다. D 1.1가 Google의 요구사항을 충족할 수 있는 가장 초기 버전이기 때문에 '최소'라고 합니다. D 1.2 이상이 있더라도 선택하지 않습니다. MVS를 사용하면 충실도가 높고 재현 가능한 버전 선택 프로세스가 생성됩니다.

삭제된 버전

레지스트리는 보안 취약점과 같이 피해야 하는 특정 버전을 yanked로 선언할 수 있습니다. 모듈의 취소된 버전을 선택하면 Bazel에서 오류가 발생합니다. 이 오류를 해결하려면 더 새로운 버전으로 업그레이드하거나 --allow_yanked_versions 플래그를 사용하여 yanked 버전을 명시적으로 허용하세요.

호환성 수준

Go에서는 하위 호환성에 관한 MVS의 가정이 작동합니다. 모듈의 하위 호환되지 않는 버전을 별도의 모듈로 취급하기 때문입니다. SemVer 측면에서 이는 A 1.x과 A 2.x이 별개의 모듈로 간주되며 해결된 종속 항목 그래프에서 공존할 수 있음을 의미합니다. 이는 Go에서 패키지 경로에 주 버전을 인코딩하여 컴파일 시간 또는 링크 시간 충돌이 발생하지 않도록 함으로써 가능합니다.

하지만 Bazel은 이러한 보장을 제공할 수 없으므로 하위 호환되지 않는 버전을 감지하려면 '주 버전' 번호가 필요합니다. 이 숫자를 호환성 수준이라고 하며 각 모듈 버전에서 module() 지시문에 지정합니다. 이 정보를 통해 Bazel은 호환성 수준이 다른 동일한 모듈 버전이 해결된 종속 항목 그래프에 있음을 감지할 때 오류를 발생시킬 수 있습니다.

재정의

MODULE.bazel 파일에서 재정의를 지정하여 Bazel 모듈 확인 동작을 변경합니다. 루트 모듈의 재정의만 적용됩니다. 모듈이 종속 항목으로 사용되면 재정의가 무시됩니다.

각 재정의는 특정 모듈 이름에 대해 지정되며 종속 항목 그래프의 모든 버전에 영향을 미칩니다. 루트 모듈의 재정의만 적용되지만 루트 모듈이 직접 종속되지 않는 전이 종속 항목에 대한 재정의일 수 있습니다.

단일 버전 재정의

single_version_override는 여러 용도로 사용됩니다.

  • version 속성을 사용하면 종속 항목 그래프에서 요청된 종속 항목 버전에 관계없이 종속 항목을 특정 버전에 고정할 수 있습니다.
  • registry 속성을 사용하면 일반적인 레지스트리 선택 프로세스를 따르는 대신 이 종속성이 특정 레지스트리에서 가져오도록 강제할 수 있습니다.
  • patch* 속성을 사용하면 다운로드된 모듈에 적용할 패치 집합을 지정할 수 있습니다.

이러한 속성은 모두 선택사항이며 서로 혼합하여 사용할 수 있습니다.

다중 버전 재정의

multiple_version_override을 지정하여 동일한 모듈의 여러 버전이 해결된 종속 항목 그래프에 공존하도록 할 수 있습니다.

해결 전에 종속 항목 그래프에 모두 있어야 하는 허용된 버전의 명시적 목록을 모듈에 지정할 수 있습니다. 각 허용된 버전에 따라 일부 전이 종속 항목이 있어야 합니다. 해결 후 허용된 모듈 버전만 남고 Bazel은 다른 모듈 버전을 동일한 호환성 수준에서 가장 가까운 상위 허용 버전으로 업그레이드합니다. 동일한 호환성 수준에서 허용되는 더 높은 버전이 없으면 Bazel에서 오류가 발생합니다.

예를 들어 해결 전 종속 항목 그래프에 버전 1.1, 1.3, 1.5, 1.7, 2.0이 있고 주 버전이 호환성 수준인 경우 다음이 적용됩니다.

  • 1.3, 1.7, 2.0를 허용하는 다중 버전 재정의를 사용하면 1.1이 1.3로 업그레이드되고 1.5이 1.7로 업그레이드되며 다른 버전은 동일하게 유지됩니다.
  • 1.5 및 2.0을 허용하는 다중 버전 재정의는 오류를 발생시킵니다. 1.7에는 업그레이드할 동일한 호환성 수준의 상위 버전이 없기 때문입니다.
  • 1.9 및 2.0을 허용하는 다중 버전 재정의는 오류를 발생시킵니다. 1.9이 해결 전 종속 항목 그래프에 없기 때문입니다.

또한 사용자는 단일 버전 재정의와 마찬가지로 registry 속성을 사용하여 레지스트리를 재정의할 수도 있습니다.

레지스트리 외 재정의

레지스트리 외 재정의는 버전 확인에서 모듈을 완전히 삭제합니다. Bazel은 레지스트리가 아닌 저장소 자체에서 이러한 MODULE.bazel 파일을 요청합니다.

Bazel은 다음과 같은 비레지스트리 재정의를 지원합니다.

Bazel 모듈을 나타내지 않는 저장소 정의

bazel_dep를 사용하면 다른 Bazel 모듈을 나타내는 저장소를 정의할 수 있습니다. Bazel 모듈을 나타내지 않는 저장소를 정의해야 하는 경우가 있습니다. 예를 들어 데이터로 읽을 일반 JSON 파일이 포함된 저장소가 있습니다.

이 경우 use_repo_rule 지시문을 사용하여 저장소 규칙을 호출하여 저장소를 직접 정의할 수 있습니다. 이 저장소는 정의된 모듈에만 표시됩니다.

내부적으로 이는 모듈 확장 프로그램과 동일한 메커니즘을 사용하여 구현되므로 더 유연하게 저장소를 정의할 수 있습니다.

저장소 이름 및 엄격한 종속 항목

모듈을 직접 지원하는 저장소의 명시적 이름은 bazel_dep 지시문의 repo_name 속성이 달리 명시하지 않는 한 기본적으로 모듈 이름으로 설정됩니다. 즉, 모듈은 직접 종속 항목만 찾을 수 있습니다. 이렇게 하면 전이 종속 항목의 변경으로 인해 실수로 발생하는 중단을 방지할 수 있습니다.

모듈을 지원하는 저장소의 표준 이름은 전체 종속 항목 그래프에 모듈의 여러 버전이 있는지에 따라 module_name~version (예: bazel_skylib~1.0.3) 또는 module_name~ (예: bazel_features~)입니다 (multiple_version_override 참고). 표준 이름 형식은 종속되어야 하는 API가 아니며 언제든지 변경될 수 있습니다. 정규 이름을 하드 코딩하는 대신 지원되는 방식으로 Bazel에서 직접 가져옵니다.

  • BUILD 및 .bzl 파일에서 저장소의 명시적 이름으로 제공된 라벨 문자열에서 생성된 Label 인스턴스에 Label.repo_name를 사용합니다.예를 들면 다음과 같습니다. Label("@bazel_skylib").repo_name.
  • 실행 파일을 조회할 때는 $(rlocationpath ...) 또는 @bazel_tools//tools/{bash,cpp,java}/runfiles의 실행 파일 라이브러리 중 하나를 사용하거나 규칙 집합 rules_foo의 경우 @rules_foo//foo/runfiles를 사용하세요.
  • IDE나 언어 서버와 같은 외부 도구에서 Bazel과 상호작용할 때는 bazel mod dump_repo_mapping 명령어를 사용하여 특정 저장소 집합의 명시적 이름에서 표준 이름으로의 매핑을 가져옵니다.

모듈 확장 프로그램은 모듈의 표시 범위에 추가 저장소를 도입할 수도 있습니다.