changelogen

changelogen

Generate Beautiful Changelogs using Conventional Commits

Quick Start

Generate changelog in markdown format and update (or create) CHANGELOG.md:

npx changelogen@latest

CLI Usage

npx changelogen@latest [...args] [<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.
• --output: Changelog file name to create or update. Defaults to CHANGELOG.md and resolved relative to rootDir. Use --no-output to write to console only.
• --bump: Determine semver change and update version in package.json.
• --release. Bumps version in package.json and creates commit and git tags using local git. You can disable commit using --no-commit and tag using --no-tag.

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.

Changelog

0.2.0

🚀 Enhancements

• GetGitDiff ignores from (#17)
• Add gitmoji support (#22)
• Auto-update changelog files (#24)
• Support --bump to update version while generating changelog (9bf9aff)
• Basic --release support (934c487)

🩹 Fixes

• Expose ./config (#10)
• Use getCurrentGitRef (#15)
• parse: ⚠️ references with type (#27)
• Convertminor to patch for 0.x versions (011b6a1)
• Run release step last (b052f55)
• Handle breaking change commits for bumping (f7ffaa4)
• Show original semver type without 0.x changes in log (ddd818a)
• Use v prefix for git tag and annotate (bf6b5da)
• Add missing annotate message (157b0c5)

💅 Refactors

• Use lines array for constructing markdown (#16)

🏡 Chore

• Update lockfile and vitest config (48f609b)
• Use changelogen release flow (2a8bb4f)

⚠️ Breaking Changes

• parse: ⚠️ references with type (#27)

❤️ Contributors

• Anthony Fu
• Conner
• Pooya Parsa
• 三咲智子