This flows show how to automatically generate release notes from your GitHub commits when you create a release β without writing them manually every time!
- 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
- Node.js
- Express
- 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!
# 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
- Go to your GitHub Repository (example: https://github.com/your-username/your-repo-name/releases)
- 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!