Bazel Starlark 규칙은 다음 두 가지 시나리오에서 Bazel LTS 출시와의 호환성을 깨뜨릴 수 있습니다.
- 이 규칙은 의존하는 기능이 HEAD의 Bazel에서 삭제되므로 향후 LTS 출시와의 호환성이 깨집니다.
- 이 규칙은 종속된 기능이 최신 Bazel LTS 출시에서만 제공되므로 현재 또는 이전 LTS 출시와의 호환성을 깨뜨립니다.
한편 규칙 자체도 사용자에게 호환되지 않는 변경사항을 제공할 수 있습니다. Bazel의 호환성이 깨지는 변경사항과 결합되면 규칙 버전과 Bazel 버전을 업그레이드하는 것이 Bazel 사용자에게 종종 불만을 야기할 수 있습니다. 이 페이지에서는 규칙 작성자가 사용자가 Bazel과 규칙을 더 쉽게 업그레이드할 수 있도록 Bazel과의 규칙 호환성을 유지하는 방법을 설명합니다.
관리 가능한 마이그레이션 프로세스
모든 Bazel 버전과 모든 규칙 버전 간의 호환성을 보장하는 것은 불가능하지만, Google의 목표는 Bazel 사용자가 이전 프로세스를 관리할 수 있도록 하는 것입니다. 관리 가능한 이전 프로세스는 사용자가 규칙의 주 버전과 Bazel의 주 버전을 동시에 업그레이드하지 않아도 되는 프로세스로 정의되며, 이를 통해 사용자는 한 번에 한 소스에서 호환되지 않는 변경사항을 처리할 수 있습니다.
예를 들어 다음 호환성 매트릭스를 사용합니다.
- 사용자가 rules_foo와 Bazel의 주요 버전을 동시에 업그레이드해야 하므로 rules_foo 1.x + Bazel 4.x에서 rules_foo 2.x + Bazel 5.x로 이전하는 것은 관리하기 쉽지 않습니다.
- rules_foo 2.x + Bazel 5.x에서 rules_foo 3.x + Bazel 6.x로의 마이그레이션은 사용자가 먼저 주요 Bazel 버전을 변경하지 않고 rules_foo를 2.x에서 3.x로 업그레이드한 다음 Bazel을 5.x에서 6.x로 업그레이드할 수 있으므로 관리 가능한 것으로 간주됩니다.
| rules_foo 1.x | rules_foo 2.x | rules_foo 3.x | HEAD | |
|---|---|---|---|---|
| Bazel 4.x | ✅ | ❌ | ❌ | ❌ |
| Bazel 5.x | ❌ | ✅ | ✅ | ❌ |
| Bazel 6.x | ❌ | ❌ | ✅ | ✅ |
| HEAD | ❌ | ❌ | ❌ | ✅ |
❌: 주 규칙 버전이 Bazel LTS 버전과 호환되지 않습니다.
✅: 규칙의 하나 이상의 버전이 최신 버전의 Bazel LTS 출시와 호환됩니다.
권장사항
Bazel 규칙 작성자는 다음 권장사항을 따라 사용자를 위한 관리 가능한 이전 프로세스를 보장할 수 있습니다.
- 규칙은 시맨틱 버전 관리를 따라야 합니다. 동일한 주 버전의 부 버전은 이전 버전과 호환됩니다.
- HEAD의 규칙은 최신 Bazel LTS 버전과 호환되어야 합니다.
- HEAD의 규칙은 HEAD의 Bazel과 호환되어야 합니다. 이를 위해 다음을 수행하면 됩니다.
- HEAD에서 Bazel을 사용하여 자체 CI 테스트 설정
- Bazel 다운스트림 테스트에 프로젝트를 추가합니다. Bazel의 호환성이 깨지는 변경사항이 프로젝트에 영향을 미치는 경우 Bazel팀에서 프로젝트에 문제를 신고하며, 문제를 적시에 해결하려면 다운스트림 프로젝트 정책을 따라야 합니다.
- 규칙의 최신 메이저 버전은 최신 Bazel LTS 출시와 호환되어야 합니다.
- 규칙의 새 주 버전은 규칙의 이전 주 버전에서 지원하는 마지막 Bazel LTS 버전과 호환되어야 합니다.
2번과 3번을 달성하는 것이 가장 중요한 작업입니다. 그래야 4번과 5번을 달성할 수 있기 때문입니다. 자연스럽게
HEAD의 Bazel과 최신 Bazel LTS 출시 버전과의 호환성을 쉽게 유지할 수 있도록 규칙 작성자는 다음을 수행할 수 있습니다.
- 최신 LTS 버전으로 백포트할 하위 호환 기능 요청. 자세한 내용은 출시 프로세스를 참고하세요.
- bazel_features를 사용하여 Bazel 기능 감지를 실행합니다.
일반적으로 권장되는 접근 방식을 사용하면 규칙이 Bazel 비호환 변경사항에 맞게 이전되고 최신 Bazel LTS 출시와의 호환성을 유지하면서 HEAD에서 새로운 Bazel 기능을 사용할 수 있습니다.