Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 213 Commits
.github		.github
.vscode		.vscode
src		src
test		test
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
build.config.ts		build.config.ts
cli.mjs		cli.mjs
eslint.config.js		eslint.config.js
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
tsconfig.json		tsconfig.json

Repository files navigation

changelogithub

Generate changelog for GitHub releases fromConventional Commits, powered bychangelogen.

👉 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:Releasepermissions:contents:writeon:push:tags:      -'v*'jobs:release:runs-on:ubuntu-lateststeps:      -uses:actions/checkout@v4with:fetch-depth:0      -name:Set nodeuses:actions/setup-node@v4with:registry-url:https://registry.npmjs.org/node-version:lts/*      -run:npx changelogithub# or changelogithub@0.12 to ensure a stable resultenv:GITHUB_TOKEN:${{secrets.GITHUB_TOKEN}}

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

Configuration

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

Preview Locally

npx changelogithub --dry

Why?

I used to useconventional-github-releaser for almost all my projects. Until I found that itdoes NOT support using exclamation marks for breaking changes - hiding those important breaking changes in the changelog without the awareness from maintainers.