깃허브 릴리스, 체인지로그, git-cliff, 공개 노트 | 사용자가 뭐가 바뀌었는지 못 찾으면?

깃허브 릴리스는 태그를 사람이 읽게 포장한 화면입니다. 체인지로그 파일은 저장소 안에 남는 공개 노트입니다. 둘을 같이 쓰고, 본문은 파일에서 복사합니다.

공식 릴리스 문서는 태그를 배포 단위로 묶고, 노트와 바이너리 링크를 붙인다고 적습니다. 읽기 권한이면 화면을 볼 수 있고, 쓰기가 있어야 릴리스를 만듭니다. 킵어체인지로그는 이 화면이 깃허브 밖으로 잘 안 옮겨진다고 분명히 씁니다. 대문자 파일 이름만큼 찾기 쉽지도 않습니다. 버전 사이 커밋 비교 링크도 화면이 잘 안 줍니다.

저는 12개 사이트 배포를 태그 없이 넘긴 적이 있습니다. 다음날 파트너십 문의에 '뭐가 바뀌었냐'가 왔습니다. 알림톡 글은 결제 직후 한 통입니다. 기능 플래그 글은 노출을 켜고 끄는 칸입니다. 오늘은 배포가 끝난 뒤, 사람이 읽는 문장만 봅니다.

공개 노트는 기계가 아니라 사람을 위한 목록입니다. 버전마다 항목이 있고, 같은 종류끼리 묶고, 최신이 위입니다. 커밋 한 줄은 그 목록이 아닙니다.

킵어체인지로그 1.1은 친구에게 깃 로그를 덤프하지 말라고 첫 줄에 씁니다. 날짜는 아이소 형식입니다. 유의적 버전을 따르면 그 사실을 파일에 적습니다. 파일 이름은 체인지로그 점 엠디가 기본입니다. 히스토리, 뉴스, 릴리스라는 이름도 쓰이지만, 찾기 쉬운 쪽을 고르라고 합니다. 미공개 칸을 맨 위에 두면, 다음 버전에 무엇을 넣을지 미리 보입니다. 배포 날에는 그 칸을 새 버전 제목으로 내립니다.

핫픽스 형제 폴더에서 고친 칸은 워크트리 글입니다. 회사 폴더 커밋 메일은 계정 칸 글입니다. 공개 노트는 그 커밋을 나열하지 않습니다. '오타 수정', '린트' 같은 줄은 사용자에게 할 말이 아닙니다.

추가, 변경, 곧 삭제, 삭제, 고침, 보안 여섯 칸입니다. 빈 칸은 안 씁니다. 없는 종류는 제목도 빼라고 적혀 있습니다.

킵어체인지로그가 종류를 이렇게 나눕니다. 새 기능은 추가입니다. 있던 동작이 바뀌면 변경입니다. 곧 뺄 기능은 곧 삭제에 미리 알립니다. 이미 뺀 것은 삭제입니다. 버그는 고침입니다. 구멍은 보안입니다. 같은 종류끼리 묶어야 사용자가 자기 칸만 읽습니다.

기능 플래그로 아직 안 연 기능은 추가 칸에 넣지 않습니다. 플래그를 연 뒤에 넣습니다. 보안 구멍을 고쳤으면 릴리스만으로 끝내지 않습니다. 깃허브는 저장소 보안 권고를 따로 올리라고 적습니다. 시크릿이 커밋에 남은 칸은 시크릿 체크 글입니다.

깃허브 자동 생성은 병합된 풀 리퀘스트와 기여자, 전체 비교 링크를 뽑습니다. 깃클리프는 규약 커밋을 초안으로 뽑습니다. 둘 다 초안입니다. 공개 전에 사람 문장으로 고칩니다.

자동 생성 노트 문서는 초안 버튼 한 번으로 개요를 만든다고 적습니다. 라벨로 칸을 나누고, 봇 작성자를 빼는 설정 파일은 점 깃허브 아래 릴리스 와이aml입니다. 라벨이 없으면 의존성 봇과 기능이 한 덩어리로 붙습니다. 깃클리프 2.13은 규약 커밋과 정규식 파서를 씁니다. 미공개만 보려면 언릴리즈드 플래그입니다. 최신 태그부터는 레이티스트입니다. 파일 앞에 붙일 때는 프리펜드입니다.

저는 자동 생성만 올렸다가 '리팩터', '의존성 범프'가 사용자 화면에 나간 적이 있습니다. 지금은 깃클리프로 초안을 뽑고, 여섯 칸만 남깁니다. 액션이 같은 브랜치에서 겹치는 칸은 동시성 글입니다. 장기 키를 빼는 칸은 오아이디씨 글입니다. 오늘은 노트 초안 칸만 봅니다.

심각한 버그나 구멍 때문에 배포를 거둔 버전도 목록에서 지우지 않습니다. 제목 옆에 철회 표시를 붙입니다.

킵어체인지로그는 철회된 버전이 로그에서 자주 빠진다고 적습니다. 빠지면 안 됩니다. 표기는 버전 제목 뒤 대괄호 영크드입니다. 괄호라서 기계도 찾기 쉽고, 사람도 크게 봅니다. 날짜는 그 버전이 나갔던 날입니다. 후속 고침 버전을 바로 아래에 두고, 고침 칸에 왜 거뒀는지만 한 줄 적습니다.

워크트리 글은 핫픽스를 형제 폴더에서 고치는 칸입니다. 공개 노트는 그 핫픽스가 사용자에게 한 말입니다. '내부 수정'이라고 쓰면 사용자는 자기 화면이 왜 돌아왔는지 모릅니다. 결제 안내 한 통은 알림톡 글입니다. 장애 복구를 알림톡으로 돌리지 않습니다. 노트에 철회와 고침을 남기고, 필요하면 상태 페이지를 따로 둡니다.

규약 커밋을 모으고, 깃클리프로 초안을 붙이고, 여섯 칸을 손질한 뒤 태그를 답니다. 릴리스 화면에는 그 본문을 넣습니다. 액션은 전체 히스토리가 필요합니다.

깃클리프 액션 문서는 체크아웃 깊이를 0으로 두라고 적습니다. 얕은 클론이면 이전 태그를 못 봅니다. 출력 파일은 체인지로그 점 엠디입니다. 저장소 환경 변수도 같이 넘깁니다. 씨엘아이로 올릴 때는 노트 파일을 넘기는 편이 자동 생성보다 짧습니다. 자동 생성을 쓰더라도 올린 뒤 화면에서 한 번 고칩니다.

1. 미공개 칸에 사람이 읽을 줄을 미리 적습니다. 커밋 메시지가 아닙니다.
2. 깃클리프로 미공개 초안을 파일 앞에 붙입니다. 태그 이름을 같이 줍니다.
3. 추가 변경 곧삭제 삭제 고침 보안만 남깁니다. 린트와 의존성 범프는 뺍니다.
4. 주 브랜치에 파일을 커밋합니다. 그다음 주석 태그를 달고 원격에 밉니다.
5. 깃허브 씨엘아이로 릴리스를 만들고, 노트 파일은 손질한 본문입니다.
6. 사이트 푸터나 소개에 같은 파일 또는 같은 문단을 겁니다. 깃허브만 남기지 않습니다.

동시성 글은 같은 브랜치 분이 두 번 깎이는 칸입니다. 릴리스 워크플로에도 그룹을 한 줄 둡니다. 오아이디씨 글은 클라우드 키입니다. 노트 파일에는 토큰을 적지 않습니다.

• 킵어체인지로그 1.1 한국어 | 사람용 목록, 여섯 칸, 미공개, 철회
• 킵어체인지로그 1.1 영어 | 깃허브 릴리스 이식성 한계
• 깃클리프 공식 | 2.13, 규약 커밋 초안
• 깃클리프 인자 | 미공개, 레이티스트, 프리펜드, 태그
• 깃클리프 액션 | 체크아웃 깊이 0
• 깃허브 릴리스 개요 | 태그 기반, 자산 한도
• 자동 생성 릴리스 노트 | 풀 리퀘스트, 릴리스 와이aml
• 규약 커밋 한국어 | 초안 원문 형식
• 유의적 버전 한국어 | 메이저 마이너 패치
• 깃허브 씨엘아이 릴리스 생성 | 노트 파일, 자동 생성 플래그

내부 연계: 알림톡, 기능 플래그, 계정 칸, 워크트리, 액션 동시성, 오아이디씨