Skip to content

Commit 092d4f7

Browse files
committed
docs: CHANGELOG 버전 헤더 누락 및 계층 구조 개선
semantic-release 설정에 headerPartial 템플릿이 없어서 버전 번호, 날짜, compare 링크가 생성되지 않았고, 그룹 헤더(##)와 타입 헤더(###)가 버전 헤더(##)와 같은 레벨이라 계층이 불명확했음. - headerPartial 추가로 버전 헤더 자동 생성 - 그룹(Highlights/Maintenance)을 h3, 타입(Features/Bug Fixes 등)을 h4로 변경 - 기존 CHANGELOG에 새 형식 수동 적용
1 parent 996be3f commit 092d4f7

2 files changed

Lines changed: 311 additions & 395 deletions

File tree

.releaserc.js

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
const mainTemplate = `{{#if noteGroups}}
1+
const headerPartial = `## {{#if linkCompare}}[{{version}}]({{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}){{else}}{{version}}{{/if}} ({{date}})
2+
`;
3+
4+
const mainTemplate = `{{> header}}
5+
6+
{{#if noteGroups}}
27
{{#each noteGroups}}
38
49
### {{title}}
@@ -10,10 +15,10 @@ const mainTemplate = `{{#if noteGroups}}
1015
{{/if}}
1116
1217
{{#if highlightGroups}}
13-
## 🎯 Highlights
18+
### 🎯 Highlights
1419
{{~#each highlightGroups}}
1520
16-
### {{title}}
21+
#### {{title}}
1722
1823
{{#each commits}}
1924
* {{#if scope}}**{{scope}}:** {{/if}}{{subject}}{{#if hash}} ([{{shortHash}}]({{@root.host}}/{{@root.owner}}/{{@root.repository}}/commit/{{hash}})){{/if}}
@@ -22,10 +27,10 @@ const mainTemplate = `{{#if noteGroups}}
2227
{{/if}}
2328
2429
{{#if maintenanceGroups}}
25-
## 🔧 Maintenance
30+
### 🔧 Maintenance
2631
{{~#each maintenanceGroups}}
2732
28-
### {{title}}
33+
#### {{title}}
2934
3035
{{#each commits}}
3136
* {{#if scope}}**{{scope}}:** {{/if}}{{subject}}{{#if hash}} ([{{shortHash}}]({{@root.host}}/{{@root.owner}}/{{@root.repository}}/commit/{{hash}})){{/if}}
@@ -103,6 +108,7 @@ export default {
103108

104109
return context;
105110
},
111+
headerPartial,
106112
mainTemplate,
107113
},
108114
},
@@ -111,6 +117,7 @@ export default {
111117
"@semantic-release/changelog",
112118
{
113119
changelogFile: "CHANGELOG.md",
120+
changelogTitle: "# Changelog",
114121
},
115122
],
116123
[

0 commit comments

Comments
 (0)