Skip to content

feat: add release workflow with CHANGELOG generation#6

Merged
flo-kn merged 1 commit into
mainfrom
feat/changelog-and-release-workflow
Mar 11, 2026
Merged

feat: add release workflow with CHANGELOG generation#6
flo-kn merged 1 commit into
mainfrom
feat/changelog-and-release-workflow

Conversation

@flo-kn

@flo-kn flo-kn commented Mar 11, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds gh-release.yml triggered on pushes to main that touch source files
  • Adds commit-and-tag-version as a dev dependency with commit/tag skipped (workflow handles those)
  • On release: bumps version in package.json, generates categorized CHANGELOG.md, commits both back to main, then creates a GitHub Release using the latest CHANGELOG section as the release body

Why

GitHub's auto-generated release notes are a flat list of PR titles in merge order. The CHANGELOG groups changes by type (Features, Bug Fixes, CI, etc.) giving users a much cleaner upgrade story.

Test plan

  • Merge this PR
  • Verify the workflow triggers and creates a GitHub Release
  • Check that the release body contains categorized notes from CHANGELOG.md
  • Verify CHANGELOG.md is committed back to main

@flo-kn

flo-kn commented Mar 11, 2026

Copy link
Copy Markdown
Owner Author

Tested locally

@flo-kn
flo-kn merged commit f083d98 into main Mar 11, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant