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
또한 커밋은 코드가 문서와 일치하지 않는 커밋 기간이 없도록 관련 문서를 업데이트해야 합니다. 문서에 버전이 지정되어 있으므로 문서 변경사항이 실수로 조기에 출시되지 않습니다.
라벨
커밋이 병합되고 호환되지 않는 변경사항을 적용할 준비가 되면 GitHub 문제에 migration-ready 라벨을 추가합니다.
플래그에 문제가 발견되었으나 아직 사용자가 이전하지 않을 것으로 예상되는 경우 플래그 migration-ready를 삭제합니다.
다음 주요 출시에서 플래그를 전환할 계획이라면 문제에 `breaking-change-X.0' 라벨을 추가하세요.
저장소 업데이트
Bazel CI는 Bazel@HEAD + Downstream에서 중요한 프로젝트 목록을 테스트합니다. 대부분은 다른 Bazel 프로젝트의 종속 항목인 경우가 많으므로 더 넓은 커뮤니티의 이전을 차단 해제하려면 이전해야 합니다. 이러한 프로젝트의 마이그레이션 상태를 모니터링하려면 bazelisk-plus-incompatible-flags 파이프라인을 사용하면 됩니다.
이 파이프라인의 작동 방식은 여기를 참고하세요.
Google 개발자 지원팀에서 migration-ready 라벨을 모니터링합니다. GitHub 문제에 이 라벨을 추가하면 다음을 처리합니다.
GitHub 문제에 주석을 작성하여 실패 목록과 이전해야 하는 다운스트림 프로젝트를 추적합니다 (예 참고).
호환되지 않는 변경사항으로 인해 손상된 모든 다운스트림 프로젝트의 소유자에게 알리기 위해 GitHub 문제를 제출합니다 (예 참고).
타겟 출시일 전에 모든 문제가 해결되었는지 확인하기 위한 후속 조치
하류 파이프라인의 프로젝트를 이전하는 것은 비호환 변경사항 작성자의 전적인 책임은 아니지만 다음을 실행하여 이전을 가속화하고 Bazel 사용자와 Bazel Green팀 모두의 작업을 더 쉽게 할 수 있습니다.
PR을 보내 다운스트림 프로젝트를 수정합니다.
마이그레이션에 대한 도움이 필요하면 Bazel 커뮤니티에 문의하세요 (예: Bazel Rules Authors 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 문제가 닫히도록 합니다.