changeset

Changeset Generator

지침

1. git diff main..HEAD로 모든 변경사항과 변경된 파일 목록 확인
2. packages/ 디렉토리 내 변경된 패키지 식별
3. 사용자에게 각 패키지별 버전 타입 질문 (major/minor/patch)
   1. 유의적 버전 명세에 맞게 일관된 타입을 추천 (https://semver.org/)
      • 기존 버전과 호환되지 않게 API가 바뀌면 "major 버전"을 올리고,
      • 기존 버전과 호환되면서 새로운 기능을 추가할 때는 "minor 버전"을 올리고,
      • 기존 버전과 호환되면서 버그를 수정한 것이라면 "patch 버전"을 올린다.
4. 커밋 메시지와 변경 사항을 기반으로 변경 내용을 일목요연하게 요약
   1. 전체 변경사항 요약 - 전체 변경사항을 한 문장으로 짧게 요약
   2. 상세 요약 - 변경 내용을 비슷한 유형끼리 그룹화하여 소제목과 함께 작성
      1. 그룹이 한개라면 소제목은 작성하지 않음(전체 요약으로 대체)
5. .changeset/[random-name].md 파일 생성
   1. 기존에 changeset 파일이 존재한다면 해당 파일을 덮어씀.
   2. 모노레포 환경에서 변경된 패키지가 여러개라면 changeset 파일을 각각 생성함.

파일 형식

생성되는 changeset 파일 형식:

---
"@naverpay/some-package": patch | minor | major
---

전체 요약

**변경 내용 요약 제목1**

- 변경 사항 1
- 변경 사항 2

**변경 내용 요약 제목2**

- 변경 사항 1

changeset 파일 예시

---
"@naverpay/utils": patch
---

someFunc 함수 로직 수정

- `someFunc` 함수에서 로직 오류 수정

---
"@naverpay/sdk": major
---

initialize 함수 시그니처 변경

**Breaking Changes**

- `initialize()` 함수의 시그니처 변경: `options` 파라미터가 필수로 변경됨
  - 기존: `initialize(apiKey?: string)`
  - 변경: `initialize(options: InitOptions)`

**문서 업데이트**

- README 업데이트

changeset 파일명 생성 방법

두 개의 랜덤 영단어를 조합해서 kebab-case로 생성합니다. (길이는 10-25자 정도로 생성합니다.)

패키지 명 확인 방법

변경된 패키지의 package.json 파일에서 name 필드를 읽어 사용합니다.

주의사항

• 변경된 패키지가 없으면 changeset 생성 불필요 안내
• skip-detect-change 레이블 사용 시 changeset 불필요