Skip to content

Commit f394aef

Browse files
feat(release): add structured release notes template
- Create template with categorized sections for features, bug fixes, breaking changes - Include placeholders for version info, contributors, and installation instructions - Support dynamic content replacement via template variables - Add sections for upgrade notes and known issues
1 parent 4dd0bc0 commit f394aef

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

.github/release-notes-template.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Release Notes Template
2+
3+
This template is used to automatically generate release notes for create-polyglot.
4+
5+
## Release Notes for v{version}
6+
7+
### 🚀 Features Added
8+
{features}
9+
10+
### 🐛 Bug Fixes
11+
{bugfixes}
12+
13+
### ⚠️ Breaking Changes
14+
{breaking}
15+
16+
### 📚 Documentation
17+
{documentation}
18+
19+
### 🔧 Internal/DevOps
20+
{internal}
21+
22+
### 📦 Dependencies
23+
{dependencies}
24+
25+
### 🎉 Other Changes
26+
{other}
27+
28+
---
29+
30+
**Full Changelog**: {compare_url}
31+
32+
## What's Changed Since Last Release
33+
34+
{commits}
35+
36+
## Contributors
37+
38+
Thanks to all the contributors who made this release possible!
39+
40+
{contributors}
41+
42+
---
43+
44+
### Installation
45+
46+
```bash
47+
npm install -g create-polyglot@{version}
48+
# or
49+
npx create-polyglot@{version} init my-project
50+
```
51+
52+
### Upgrade Notes
53+
54+
{upgrade_notes}
55+
56+
### Known Issues
57+
58+
{known_issues}

0 commit comments

Comments
 (0)