@vvlad1973/gen-changelog
v1.1.5
Published
Simple script to generate changelog from git commits based on conventional commits
Downloads
22
Maintainers
Readme
gen-changelog
A CHANGELOG.md generator based on Git commit history with support for Conventional Commits, BREAKING CHANGES, details sections, and initial commits.
Installation
Install as a development dependency:
npm install --save-dev gen-changelogOr use directly with npx:
npx gen-changelogFeatures
Generates CHANGELOG grouped by version and commit type
Sorts releases in reverse chronological order
Groups commits into: Features, Fixes, Documentation, and Breaking Changes
Supports BREAKING CHANGE: sections in commit messages
Includes additional details: blocks from commit body
Recognizes and includes initial commits
Usage
Run the command:
npx gen-changelogThis will create or update a CHANGELOG.md file based on your Git history.
Commit format
Follows the Conventional Commits specification:
feat: Add new authentication module
details:
Implements JWT-based authentication with refresh tokens.
BREAKING CHANGE: Login endpoint has been renamed to /api/auth/loginLicense
MIT with Commercial Use
Copyright (c) 2023 Vladislav Vnukovskiy
