changelogens
v0.5.3
Published
Generate Beautiful Changelogs using Conventional Commits
Downloads
12
Readme
changelogens
Forked from changelogen
Changes in this fork:
- Disable emoji before the title
- Add the current date after the version
- Show only the name of the contributor in markdown
Quick Start
Generate changelog in markdown format and show in console:
npx changelogens@latest
Generate changelog, bump version in package.json
automatically and update CHANGELOG.md
(without commit)
npx changelogens@latest --bump
Bump version, update CHANGELOG.md
and make a git commit and tag:
npx changelogens@latest --release
CLI Usage
npx changelogens@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 toCHANGELOG.md
and resolved relative to rootDir. Use--no-output
to write to console only.--bump
: Determine semver change and update version inpackage.json
.--release
. Bumps version inpackage.json
and creates commit and git tags using localgit
. You can disable commit using--no-commit
and tag using--no-tag
.-r
: Release as specific version.
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.