이 문서에는 Android 스튜디오 출시 노트를 만드는 방법에 관한 안내가 포함되어 있습니다.
목표
GitHub 저장소의 커밋에 대한 자세한 출시 노트를 만듭니다.
안내
다음 안내를 순서대로 완전히 따르세요.
1단계: 저장소 클론 또는 업데이트
이 프로젝트에서 studio-main 폴더를 확인합니다. 저장소가 없으면 다음 명령어를 사용하여 studio-main 저장소를 클론합니다.
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
디렉터리가 이미 있는 경우 GitHub에서 저장소의 콘텐츠를 가져와 디렉터리를 새로고침합니다.
계속하기 전에 studio-main의 상태를 알려주세요.
2단계: 저장소 학습
저장소의 콘텐츠를 학습합니다.
3단계: 커밋 가져오기
내가 제공한 기간 동안 studio-main 저장소에 제출된 모든 커밋을 가져와 줘. 계속하기 전에 개수를 알려주세요. 항상 wc -l을 사용하여 개수를 셉니다.
타겟 커밋 식별: git 로그에서 내가 제공한 제품 이름인
이 포함된 정확한 문자열 'Relnote: '이 포함된 모든 커밋의 전체 커밋 블록을 추출합니다. 제품 이름을 제공하지 않으면 'Relnote'로 검색해 줘. '커밋 블록'에는 커밋 해시, 작성자, 날짜, 전체 커밋 메시지, 코드 차이가 포함됩니다.
올바른 도구 사용: 날짜 범위와 제품 이름으로 커밋을 필터링하려면 다음 명령어를 사용하세요.
git log --after="
" --before=" " --grep="Relnote: " 여기서
및 은 내가 제공한 기간이고 은 내가 제공한 제품 이름입니다. 제품 이름을 제공하지 않은 경우 다음 명령어를 사용하세요.
git log --after="
" --before=" " --grep="Relnote" 개수 확인: 확인된 모든 커밋의 총 개수, 해시, 제목을 표시해 줘. 계속 진행해도 되는지 확인해 드리겠습니다.
4단계: 자세한 출시 노트 생성
커밋 분석: 이전 단계에서 식별한 각 커밋에 대해 다음을 포함한 세부 분석을 실행합니다.
- 전체 커밋 메시지를 읽습니다.
- 코드 차이 (git show
)를 검사하여 변경사항을 이해합니다. - 연결된 버그 (예: Bug: 12345678)를 따라 맥락을 자세히 파악합니다.
계속하기 전에 저에게 확인해 주세요.
docs 폴더에서 커밋과 관련된 정보를 위해 관련 문서를 분석합니다. 이 정보를 사용하여 콘텐츠가 풍부한 출시 노트를 만드세요.
계속하기 전에 문서 폴더에 관련 정보가 있는 커밋을 알려주세요.
커밋에서 참조되는 버그를 가져옵니다. 버그의 정보를 사용하여 커밋의 출시 노트를 만듭니다.
출시 노트 작성: 각 커밋에 대해 다음을 포함하는 출시 노트를 작성합니다.
커밋 참조: 각 출시 노트 앞에 소스 커밋 해시가 포함된 마크다운 주석을 추가합니다(예: ).
명확한 제목: 변경사항을 간결하게 요약한 문장입니다.
자세한 설명: 변경사항에 대해 설명하는 단락입니다.
다음 순서로 변경사항에 관한 주요 사항을 확인하세요.
a. 이유: 변경된 내용과 변경된 이유 b. 영향: 앱 개발자에게 미치는 영향 c. 마이그레이션: 마이그레이션 경로 (있는 경우)
'전' 및 '후' 코드 예시: 커밋에 사용자 대상 코드 변경사항 (예: .gradle 파일의 DSL 변경사항 또는 API 수정사항)이 포함된 경우 변경사항을 보여주는 명확하고 간결한 코드 스니펫을 제공합니다.
https://developer.android.com/studio/releases의 출시 노트 스타일을 따릅니다.
5단계: 마크다운 파일에 출시 노트 작성
- 프로젝트의 루트에 release-notes-YYYY-MM-DDTHH:MM.md라는 마크다운 파일을 만듭니다. 여기서 YYYY-MM-DD (연도-월-일)는 ISO 8601 형식의 현재 날짜이고, T는 구분자이며, HH:MM (24시간 시계의 시간:분)은 현재 시간입니다.
- 출시 노트의 목적을 설명하는 소개를 작성해 줘.
- 출시 노트를 요약해 줘.
- 서식이 지정된 전체 출시 노트를 작성합니다.
6단계: 커밋 만들기
출시 노트 파일의 Fig 커밋을 만듭니다. 버그 ID를 포함하지 마세요.
7단계: 변경 목록 만들기
커밋의 CL을 만듭니다.