changeloggithub

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

• Forked from changelogithub
• Forked from changelogen

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
• Support --dry mode to preview the changelog
• Support --all mode to write to a file
• Support --from and --to mode to write to a file between two tags

Usage

In GitHub Actions:

# .github/workflows/release.yml

name: Release

permissions:
  contents: write

on:
  push:
    tags:
      - 'v*'

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - uses: actions/setup-node@v3
        with:
          node-version: 18.x

      - run: npx changeloggithub@latest
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

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

Preview Locally

npx changeloggithub@latest --dry

Write to a file

npx changeloggithub@latest --all true

Write to a file between two tags

npx changeloggithub@latest --from v1.0.0 --to v2.0.0 --output changelog-v2.0.0.md