← Back to Packages
  • changelogithub

changelogithub

Package information

by Chadrick Halvorson

Update Action Github

Generate changelog for GitHub

Support

#changelogithub on Discord

Views

652

License

MIT

Documentation

changelogithub

NPM version

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

👉 Changelog example

Features

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: 16.x
 
- run: npx changelogithub # or changelogithub@0.12 if ensure the stable result
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

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

Configuration

You can put a configuration file in the project root, named as changelogithub.config.{json,ts,js,mjs,cjs}, .changelogithubrc or use the changelogithub field in package.json.

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