Release

릴리즈 가이드

이 문서는 프로젝트의 릴리즈 방식에 대해 설명합니다.

릴리즈 방식

우리는 Changesets을 이용해 릴리즈를 관리합니다. 왜 많은 버저닝 관련 툴 중에서 Changesets을 적용했는지 궁금하시다면, Apply Changesets (#855) PR을 참고해주세요.

릴리즈는 다음과 같은 방식으로 이루어집니다.

1. 변경이 이루어진 브랜치에서 yarn changeset 명령어를 실행합니다.
2. CLI에서 버전 업데이트가 필요한 패키지를 선택합니다.
3. 버전 관리 전략에 따라 적절한 버전을 선택합니다.
4. 변경사항에 대한 설명을 영문으로 작성합니다. 이 변경사항이 릴리즈 노트에 포함됩니다.
5. 만들어진 changeset(마크다운 파일)을 커밋합니다.
6. changeset이 포함된 커밋이 업스트림 저장소에 푸시되면, GitHub Action이 자동으로 릴리즈 PR을 생성합니다. 릴리즈 PR이 이미 존재한다면, 해당 PR을 업데이트합니다.
7. 다음 릴리즈가 준비되면, 앞선 릴리즈 PR을 머지합니다.
8. 릴리즈 PR이 머지되면, GitHub Action이 자동으로 릴리즈 및 퍼블리시를 진행합니다.

프리릴리즈(Prerelease)

정식 릴리즈 이전 실험적인 기능들을 미리 릴리즈하고, 애플리케이션에서 테스트해보고 싶을 수 있습니다. 이 때 프리릴리즈를 사용하세요. 프리릴리즈를 진행하기 전, 몇 가지 주의사항이 있습니다.

• 프리릴리즈는 복잡합니다. 꼭 가이드라인 문서를 숙지하고 진행하세요.
• 프리릴리즈는 main 브랜치에서 진행하지 마세요. main 브랜치는 항상 정식 릴리즈만을 포함해야 합니다. 별도의 브랜치를 생성하고, 그 브랜치에서 프리릴리즈를 진행하세요.
• 프리릴리즈 모드로 전환하면, 레포지토리의 버저닝 대상이 되는 모든 패키지가 프리릴리즈 모드로 전환됩니다. 프리릴리즈 모드로 전환된 패키지는 정식 릴리즈가 이루어질 때까지 프리릴리즈 모드를 유지합니다. 프리릴리즈 모드를 해제하려면, 모든 패키지를 정식 릴리즈 모드로 전환해야 합니다.