Skip to content

Commit 718c992

Browse files
committed
chore: prepare release v1.1.0
1 parent 9591cb5 commit 718c992

1 file changed

Lines changed: 38 additions & 1 deletion

File tree

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,38 @@
1-
# github-release-note-template
1+
# GitHub's Auto-Generated Release Notes
2+
3+
> This flows show how to automatically generate release notes from your GitHub commits when you create a release — without writing them manually every time!
4+
5+
## 🚀 What it will do?
6+
7+
- ✨ Whenever you push a tag like v1.1.0 to GitHub
8+
- ⚡ It will automatically create a Release
9+
- 🔒 It will auto-generate release notes based on commit messages and PR titles
10+
11+
12+
## 🛠 Tech Stack
13+
14+
- Node.js
15+
- Express
16+
17+
## 🎯 How you use it in your project
18+
- Add this workflow under .github/workflows/release.yml
19+
- Push a new Git tag
20+
git tag v1.1.0
21+
git push origin v1.1.0
22+
(You can change v1.1.0 to whatever your new version is.)
23+
- GitHub will automatically create a new Release with auto-generated notes!
24+
25+
## 📦 Installation
26+
27+
```bash
28+
# Clone the repo
29+
git clone https://github.com/rupachowrasia/github-release-note-template.git
30+
31+
# Move into the project directory
32+
cd github-release-note-template
33+
34+
# Install dependencies
35+
npm install
36+
37+
# Run the app
38+
npm run start

0 commit comments

Comments
 (0)