changelogen

Generate Beautiful Changelogs using Conventional Commits

Quick Start

Generate changelog in markdown format to the console output:

npx changelogen@latest

CLI Usage

npx changelogen@latest [--from=...] [--to=...] [<rootDir>]

Arguments:

• from: Start commit reference. When not provided, latest git tag will be used as default.
• to: End commit reference. When not provided, latest commit in HEAD will be used as default.
• rootDir: Path to git repository. When not provided, current working directory will be used as as default.

Configuration

Configuration is loaded by unjs/c12 from cwd. You can use either changelog.json, changelog.{ts,js,mjs,cjs}, .changelogrc or use the changelog field in package.json.

See ./src/config.ts for available options and defaults.

💻 Development

• Clone this repository
• Enable Corepack using corepack enable (use npm i -g corepack for Node.js < 16.10)
• Install dependencies using pnpm install
• Run interactive tests using pnpm dev

License

Made with 💛

Published under MIT License.