File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 44
55## 🚀 What it will do?
66
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
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
1010
1111
1212## 🛠 Tech Stack
1515- Express
1616
1717## 🎯 How you use it in your project
18- - Add this workflow under .github/workflows/release.yml
18+ - Add the workflow under .github/workflows/release.yml (code is in github, can copy that)
1919- Push a new Git tag
20+ ``` bash
2021git tag v1.1.0
2122git push origin v1.1.0
22- (You can change v1.1.0 to whatever your new version is.)
23+ ```
24+ (You can change v1.1.0 to whatever your new version is)
2325- GitHub will automatically create a new Release with auto-generated notes!
2426
2527## 📦 Installation
@@ -36,3 +38,17 @@ npm install
3638
3739# Run the app
3840npm run start
41+
42+ # Run the following, it should trigger the workflow
43+ git commit -am " chore: prepare sample release v1.1.0" \
44+ && git tag v1.1.0 \
45+ && git push origin main --tags
46+ ```
47+
48+ ## 🧭 How to view Releases in your GitHub repository
49+ - Go to your GitHub Repository (example: https://github.com/your-username/your-repo-name/releases )
50+
51+ ## 📢 Tips
52+ - ** Manual/Draft Release:** You can manually create a draft release even without pushing a tag!
53+ - ** Auto Release:** If using GitHub Action like we set, it will auto-create a Release when you push a new tag!
54+
You can’t perform that action at this time.
0 commit comments