Skip to content

Commit fb31124

Browse files
committed
docs(release): README.md 현재 폴더 구조 반영
- 버전별 폴더 구조(v1/v1.0.0-alpha.N/) 반영 - 릴리스 목록 테이블에 alpha.1~3 전체 포함 - 미디어 파일 확장자 표 추가 (mp4, mp3, m4a, pdf, pptx) - 스크립트 사용 예시 업데이트
1 parent b2d478c commit fb31124

1 file changed

Lines changed: 42 additions & 16 deletions

File tree

.release-notes/README.md

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,51 @@
99
├── README.md # 이 문서
1010
├── TEMPLATE.md # 릴리스 노트 작성 템플릿
1111
├── validate-release-notes.ps1 # 릴리스 노트 크기 검증 스크립트
12-
├── RELEASE-v{VERSION}.md # 영문 릴리스 노트
13-
├── RELEASE-v{VERSION}-KR.md # 한글 릴리스 노트
14-
├── RELEASE-v{VERSION}-KR.mp4 # 한글 릴리스 소개 영상
15-
├── RELEASE-v{VERSION}-KR.mp3 # 한글 릴리스 소개 음성
12+
├── v1/ # v1.x 릴리스 노트
13+
│ ├── v1.0.0-alpha.1/
14+
│ │ ├── RELEASE-v1.0.0-alpha.1.md # 영문
15+
│ │ ├── RELEASE-v1.0.0-alpha.1-KR.md # 한글
16+
│ │ ├── RELEASE-v1.0.0-alpha.1-KR.mp4 # 소개 영상
17+
│ │ └── RELEASE-v1.0.0-alpha.1-KR.mp3 # 소개 음성
18+
│ ├── v1.0.0-alpha.2/
19+
│ │ ├── RELEASE-v1.0.0-alpha.2.md
20+
│ │ ├── RELEASE-v1.0.0-alpha.2-KR.md
21+
│ │ ├── RELEASE-v1.0.0-alpha.2-KR.mp4
22+
│ │ ├── RELEASE-v1.0.0-alpha.2-KR.m4a
23+
│ │ ├── RELEASE-v1.0.0-alpha.2-KR.pdf
24+
│ │ └── RELEASE-v1.0.0-alpha.2-KR.pptx
25+
│ └── v1.0.0-alpha.3/
26+
│ ├── RELEASE-v1.0.0-alpha.3.md
27+
│ └── RELEASE-v1.0.0-alpha.3-KR.md
1628
└── scripts/ # 릴리스 노트 생성 스크립트
1729
├── AnalyzeAllComponents.cs # 컴포넌트 변경사항 분석
1830
├── AnalyzeFolder.cs # 개별 폴더 상세 분석
1931
├── ExtractApiChanges.cs # API 변경사항 추출
2032
├── ApiGenerator.cs # Public API 생성
2133
├── config/ # 분석 설정 파일
2234
├── docs/ # 5-Phase 워크플로우 문서
23-
└── .analysis-output/ # 분석 결과 출력
35+
└── .analysis-output/ # 분석 결과 출력 (gitignore)
2436
```
2537

2638
## 릴리스 노트 목록
2739

28-
| 버전 | 문서 | 미디어 | 설명 |
29-
|------|------|--------|------|
30-
| v1.0.0-alpha.1 | [영문](RELEASE-v1.0.0-alpha.1.md) / [한글](RELEASE-v1.0.0-alpha.1-KR.md) | [MP4](RELEASE-v1.0.0-alpha.1-KR.mp4) / [MP3](RELEASE-v1.0.0-alpha.1-KR.mp3) | 첫 번째 알파 릴리스 |
40+
| 버전 | 날짜 | 문서 | 미디어 | 주요 변경 |
41+
|------|------|------|--------|----------|
42+
| v1.0.0-alpha.3 | 2026-04-19 | [EN](v1/v1.0.0-alpha.3/RELEASE-v1.0.0-alpha.3.md) / [KR](v1/v1.0.0-alpha.3/RELEASE-v1.0.0-alpha.3-KR.md) || IRepository 재설계, EF Core 성능 최적화, [GenerateSetters] Source Generator |
43+
| v1.0.0-alpha.2 | 2026-03-28 | [EN](v1/v1.0.0-alpha.2/RELEASE-v1.0.0-alpha.2.md) / [KR](v1/v1.0.0-alpha.2/RELEASE-v1.0.0-alpha.2-KR.md) | [MP4](v1/v1.0.0-alpha.2/RELEASE-v1.0.0-alpha.2-KR.mp4) | ErrorType partial 분리, Pipeline opt-in, 폴더 재구성 |
44+
| v1.0.0-alpha.1 | 2026-03-15 | [EN](v1/v1.0.0-alpha.1/RELEASE-v1.0.0-alpha.1.md) / [KR](v1/v1.0.0-alpha.1/RELEASE-v1.0.0-alpha.1-KR.md) | [MP4](v1/v1.0.0-alpha.1/RELEASE-v1.0.0-alpha.1-KR.mp4) / [MP3](v1/v1.0.0-alpha.1/RELEASE-v1.0.0-alpha.1-KR.mp3) | 첫 번째 알파 릴리스 |
3145

3246
## 릴리스 노트 작성 가이드
3347

3448
### 빠른 시작
3549

36-
1. **템플릿 복사**: `TEMPLATE.md``RELEASE-v{VERSION}.md`로 복사
50+
1. **템플릿 복사**: `TEMPLATE.md``v{MAJOR}/v{VERSION}/RELEASE-v{VERSION}.md`로 복사
3751
2. **데이터 수집**: `scripts/` 폴더의 분석 스크립트 실행
3852
3. **내용 작성**: 5-Phase 워크플로우에 따라 작성
3953
4. **검증**: `validate-release-notes.ps1`로 크기 검증
4054

4155
### 5-Phase 워크플로우
4256

43-
릴리스 노트 작성은 다음 5단계 워크플로우를 따릅니다:
44-
4557
| Phase | 문서 | 설명 |
4658
|-------|------|------|
4759
| 1 | [phase1-setup.md](scripts/docs/phase1-setup.md) | 환경 검증 및 준비 |
@@ -59,14 +71,14 @@
5971
cd .release-notes/scripts
6072

6173
# 컴포넌트 분석 실행
62-
dotnet AnalyzeAllComponents.cs
74+
dotnet AnalyzeAllComponents.cs --base v1.0.0-alpha.2 --target HEAD
6375

6476
# API 변경사항 추출
6577
dotnet ExtractApiChanges.cs
6678

6779
# 릴리스 노트 크기 검증 (GitHub Release body 제한: 125,000자)
6880
cd ..
69-
.\validate-release-notes.ps1 -FilePath "RELEASE-v1.0.0-alpha.1.md"
81+
powershell.exe -File validate-release-notes.ps1 -FilePath "v1/v1.0.0-alpha.3/RELEASE-v1.0.0-alpha.3.md"
7082
```
7183

7284
## 핵심 원칙
@@ -76,14 +88,24 @@ cd ..
7688
- 모든 문서화된 API는 분석 결과에 존재해야 합니다
7789
- API를 임의로 만들어내지 않습니다
7890
- 모든 기능은 커밋/PR로 추적 가능해야 합니다
79-
- 코드 예제은 `all-api-changes.txt`에서 검증합니다
91+
- 코드 예제는 `all-api-changes.txt`에서 검증합니다
8092

8193
### Breaking Changes 감지
8294

8395
- `.api` 폴더의 Git diff 분석을 우선합니다
8496
- 커밋 메시지 패턴(`!:`, `breaking`)은 보조 수단입니다
8597
- 삭제/변경된 API는 모두 Breaking Change로 처리합니다
8698

99+
### 버전별 폴더 구조
100+
101+
릴리스 노트는 메이저 버전별로 폴더를 분리합니다:
102+
103+
```
104+
v1/v1.0.0-alpha.1/RELEASE-v1.0.0-alpha.1.md # v1.x 프리릴리스
105+
v1/v1.0.0/RELEASE-v1.0.0.md # v1.0.0 정식
106+
v2/v2.0.0-beta.1/RELEASE-v2.0.0-beta.1.md # v2.x 프리릴리스
107+
```
108+
87109
### 문서 언어
88110

89111
- `RELEASE-v{VERSION}.md`: 영문 릴리스 노트 (GitHub Release 기본)
@@ -93,8 +115,12 @@ cd ..
93115

94116
릴리스 노트에 포함되는 미디어 파일:
95117

96-
- **MP4**: 릴리스 소개 영상 (주요 기능 데모)
97-
- **MP3**: 릴리스 소개 음성 (팟캐스트 형식 설명)
118+
| 확장자 | 용도 |
119+
|--------|------|
120+
| `.mp4` | 릴리스 소개 영상 (주요 기능 데모) |
121+
| `.mp3` / `.m4a` | 릴리스 소개 음성 (팟캐스트 형식) |
122+
| `.pdf` | 릴리스 소개 슬라이드 (PDF) |
123+
| `.pptx` | 릴리스 소개 슬라이드 (원본) |
98124

99125
## 참고 자료
100126

0 commit comments

Comments
 (0)