Skip to content

rupachowrasia/create-release-note-using-github-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

22 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

GitHub's Auto-Generated Release Notes

This flows show how to automatically generate release notes from your GitHub commits when you create a release β€” without writing them manually every time!

πŸš€ What it will do?

  • Whenever you push a tag like v1.1.0 to GitHub
  • It will automatically create a Release
  • It will auto-generate release notes based on commit messages and PR titles

πŸ›  Tech Stack

  • Node.js
  • Express

🎯 How you use it in your project

  • Add the workflow under .github/workflows/release.yml (code is in github, can copy that)
  • Push a new Git tag
git tag v1.1.0
git push origin v1.1.0

(You can change v1.1.0 to whatever your new version is)

  • GitHub will automatically create a new Release with auto-generated notes!

πŸ“¦ Installation

# Clone the repo
git clone https://github.com/rupachowrasia/create-release-note-using-github-action.git

# Move into the project directory
cd create-release-note-using-github-action

# Install dependencies
npm install

# Run the app
npm run start

# Run the following, it should trigger the workflow
git commit -am "chore: prepare sample release v1.1.0" \
&& git tag v1.1.0 \
&& git push origin main --tags

🧭 How to view Releases in your GitHub repository

πŸ“’ Tips

  • Manual/Draft Release: You can manually create a draft release even without pushing a tag!
  • Auto Release: If using GitHub Action like we set, it will auto-create a Release when you push a new tag!

About

A simple demo to show how to automatically create Release Notes whenever we create a tag and push to main branch

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published