이 문서는 Bazel 참여자를 대상으로 합니다.
Bazel의 커밋 설명에는 RELNOTES: 태그와 출시 메모가 포함됩니다. Bazel팀에서 각 출시의 변경사항을 추적하고
출시 발표
개요
변경사항이 버그 수정인가요? 이 경우 출시 노트가 필요하지 않습니다. 제발 GitHub 문제에 대한 참조를 포함하세요.
변경사항이 사용자에게 표시되는 방식으로 Bazel을 추가 / 삭제 / 변경하는 경우 언급하는 것이 유리할 수 있습니다.
중대한 변경이라면 설계 문서를 따르세요. 정책을 먼저 읽어보세요.
가이드라인
출시 노트는 사용자가 읽어야 하므로 짧아야 합니다. 전문 용어 (Bazel 내부 용어)를 피하고 중요한 역할을 합니다
관련 문서 링크를 포함합니다. 거의 모든 출시 노트는 링크 포함 설명에 플래그, 기능, 명령어 이름이 언급되면 사용자는 이에 대해 자세히 알고 싶어 할 것입니다.
코드, 기호, 플래그 또는 밑줄로 표시됩니다.
버그 설명을 복사하여 붙여넣지 마세요. 대개 비밀스러우며 사용자가 머릿속을 긁지 않도록 하는 것입니다. 출시 노트는 사용자가 이해할 수 있는 언어로 변경사항과 그 이유를 설명하기 위한 것입니다.
항상 현재 시제와 '이제 Bazel에서 Y를 지원합니다' 또는 '이제 X에서 Z를 지원합니다'와 같은 형식을 사용하세요. 출시 노트가 버그 항목처럼 들리지 않도록 합니다. 모든 출시 메모 항목은 유용한 정보를 제공하고 일관된 스타일과 언어를 사용해야 합니다.
지원 중단되었거나 삭제된 항목이 있는 경우 'X는 지원 중단됨'을 사용합니다. 또는 'X' 삭제되었습니다." '삭제됨' 또는 '삭제되었습니다'가 아닙니다.
이제 Bazel이 다르게 하는 경우 'X 이제 $newBehavior'를 $oldBehavior" 있습니다. 이렇게 하면 사용자가 새 버전을 사용할 때 어떤 일이 일어날지 자세히 알 수 있습니다.
현재 Bazel에서 무언가를 지원하거나 더 이상 지원하지 않는 경우 'Bazel에서 이제 / 더 이상 X를 지원하지 않습니다.'
특정 항목이 삭제 / 지원 중단 / 변경된 이유를 설명하세요. 한 문장으로 충분하지만 사용자가 빌드에 미치는 영향을 평가할 수 있어야 합니다.
향후 기능에 대한 약속은 하지 마세요. "이 플래그는 삭제됨" 또는 "변경될 것입니다." 불확실성을 야기합니다. 사용자가 가장 먼저 궁금해하는 것은 '언제?'입니다. 알 수 없는 시점에 현재 빌드가 중단될까 걱정하게 해서는 안 됩니다.
절차
이번 출시의 일환으로
,
모든 커밋의 RELNOTES 태그를 수집합니다. 우리는 모든 것을 Google
문서
여기에서 메모를 검토, 수정 및 정리할 수 있습니다.
출시 관리자가 bazel-dev 메일링 리스트에 이메일을 보냅니다. Bazel 참여자는 문서에 기여하고 변경사항이 공지사항에 올바르게 반영되는지 확인하도록 초대됩니다.
나중에 bazel-blog 저장소를 사용하여 공지사항이 Bazel 블로그에 제출됩니다.