changelogithub

NPM version

Generate changelog for GitHub releases from Conventional Commits, powered by changelogen.

👉 Changelog example

Features

  • Support exclamation mark as breaking change, e.g. chore!: drop node v10
  • Grouped scope in changelog
  • Create the release note, or update the existing one
  • List contributors

Usage

In GitHub Actions:

# .github/workflows/release.ymlname: Releaseon:  push:    tags:      - 'v*'jobs:  release:    runs-on: ubuntu-latest    steps:      - uses: actions/[email protected]        with:          fetch-depth: 0      - uses: actions/[email protected]        with:          node-version: 16.x      - run: npx changelogithub        env:          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

It will be trigged whenever you push a tag to GitHub that starts with v.

Preview Locally

npx changelogithub --dry

Why?

I used to use conventional-github-releaser for almost all my projects. Until I found that it does NOT support using exclamation mark for breaking changes – hiding those important breaking changes in the changelog without the awareness from maintainers.

License

MIT License © 2022 Anthony Fu

GitHub

View Github