Bazel을 대대적으로 바꾸는 것은 불가피합니다. 디자인을 변경하고 제대로 작동하지 않는 부분을 수정해야 합니다. 하지만 커뮤니티와 Bazel 생태계가 따를 수 있도록 해야 합니다. 이를 위해 Bazel 프로젝트는 이전 버전과의 호환성 정책을 채택했습니다. 이 문서에서는 Bazel 기여자가 Bazel의 브레이킹 체인지를 이 정책을 준수하도록 하는 프로세스를 설명합니다.
GitHub 문제
Bazel 저장소에 GitHub 문제 제출 예시 보기
다음과 같이 하는 것이 좋습니다.
제목은 플래그 이름으로 시작합니다 (플래그 이름은
incompatible_로 시작).incompatible-change라벨을 추가합니다.설명에는 변경사항에 관한 설명과 관련 설계 문서 링크가 포함됩니다.
이 설명에는 사용자에게 코드를 업데이트하는 방법을 설명하는 이전 레시피가 포함됩니다. 기계적인 변경사항인 경우 이전 도구 링크를 포함하는 것이 좋습니다.
이 설명에는 사용자가 이전하지 않을 경우 표시되는 오류 메시지의 예가 포함되어 있습니다. 이렇게 하면 검색엔진에서 GitHub 문제를 더 쉽게 검색할 수 있습니다. 오류 메시지가 유용하고 실행 가능한지 확인하세요. 가능하면 오류 메시지에는 호환되지 않는 플래그의 이름이 포함되어야 합니다.
이전 도구의 경우 Buildifier에 참여해 보세요.
BUILD, WORKSPACE, .bzl 파일에 자동 수정사항을 적용할 수 있습니다.
또한 경고가 보고될 수도 있습니다.
구현
Bazel에서 새 플래그를 만듭니다. 기본값은 false여야 합니다. 도움말 텍스트에는 GitHub 문제의 URL이 포함되어야 합니다. 플래그 이름은 incompatible_로 시작하므로 메타데이터 태그가 필요합니다.
metadataTags = {
OptionMetadataTag.INCOMPATIBLE_CHANGE,
},
커밋 설명에 플래그에 관한 간단한 요약을 추가합니다.
또한 다음 형식으로 RELNOTES:를 추가합니다.
RELNOTES: --incompatible_name_of_flag has been added. See #xyz for details
커밋은 관련 문서도 업데이트하여 코드가 문서와 일치하지 않는 커밋 창이 생기지 않도록 해야 합니다. 이 문서는 버전이 관리되므로 문서의 변경사항이 실수로 조기에 출시되지 않습니다.
라벨
커밋이 병합되고 호환되지 않는 변경사항을 채택할 준비가 되면 migration-ready 라벨을 GitHub 문제에 추가합니다.
플래그에서 문제가 발견되고 사용자가 아직 이전할 것으로 예상되지 않는 경우 migration-ready 플래그를 삭제합니다.
다음 메이저 버전에서 플래그를 뒤집을 계획이라면 문제에 `breaking-change-X.0" 라벨을 추가합니다.
저장소 업데이트
Bazel CI는 Bazel@HEAD + Downstream에서 중요한 프로젝트 목록을 테스트합니다. 대부분은 다른 Bazel 프로젝트의 종속 항목인 경우가 많으므로 더 광범위한 커뮤니티의 이전을 차단하도록 프로젝트를 이전하는 것이 중요합니다.
이러한 프로젝트의 마이그레이션 상태를 모니터링하려면 bazelisk-plus-incompatible-flags 파이프라인을 사용하면 됩니다. 여기에서 이 파이프라인의 작동 방식을 확인하세요.
다운스트림 파이프라인에서 프로젝트를 마이그레이션하는 작업은 호환되지 않는 변경 작성자가 전적으로 책임지지 않습니다. 하지만 다음과 같이 하면 마이그레이션을 가속화하고 Bazel 사용자와 Bazel Green 팀 모두의 업무 효율을 높일 수 있습니다.
- GitHub 문제를 신고하여 호환되지 않는 변경사항으로 인해 손상된 다운스트림 프로젝트의 소유자에게 알립니다.
- 다운스트림 프로젝트를 수정하기 위해 PR을 보냅니다.
- 마이그레이션에 관한 도움이 필요한 경우 Bazel 커뮤니티에 문의하세요 (예: Bazel 규칙 작성자 SIG).
깃발 돌리기
플래그의 기본값을 true로 변경하기 전에 다음을 확인하세요.
생태계의 핵심 저장소가 마이그레이션됩니다.
bazelisk-plus-incompatible-flags파이프라인에서 플래그는The following flags didn't break any passing Bazel team owned/co-owned projects아래에 표시되어야 합니다.사용자의 우려사항과 질문이 해결되었습니다.
Bazel에서 플래그를 전환할 준비가 되었지만 Google의 내부 이전이 차단된 경우 내부 blazerc 파일에서 플래그 값을 false로 설정하여 플래그 뒤집을 차단 해제하세요. 이를 통해 Bazel 사용자가 가능한 한 빨리 기본적으로 새 동작에 의존하도록 할 수 있습니다.
플래그 기본값을 true로 변경하는 경우 다음 단계를 따르세요.
- 다음 형식으로 커밋 설명에
RELNOTES[INC]를 사용합니다.RELNOTES[INC]: --incompatible_name_of_flag is flipped to true. See #xyz for details커밋 설명의 나머지 부분에 추가 정보를 포함할 수 있습니다. - 커밋이 병합될 때 GitHub 문제가 종료되도록 설명에
Fixes #xyz를 사용합니다. - 문서를 검토하고 필요한 경우 업데이트합니다.
- 새로운 문제(
#abc)를 제출하여 신고 삭제를 추적합니다.
플래그 제거
플래그는 HEAD에서 뒤집으면 결국 Bazel에서 삭제됩니다. 호환되지 않는 플래그를 삭제하려는 경우:
- 호환되지 않는 주요 변경사항인 경우 사용자가 이전할 수 있도록 더 많은 시간을 확보하는 것이 좋습니다. 이상적으로 이 플래그는 하나 이상의 주 버전에서 사용할 수 있어야 합니다.
- 플래그를 삭제하는 커밋의 경우 설명에
Fixes #abc을 사용하여 커밋이 병합될 때 GitHub 문제가 종료되도록 합니다.