changelog-updater
v2.0.3
Published
Update [Unreleased] in CHANGELOG.md to current package version.
Downloads
9,374
Readme
changelog-updater
Update [Unreleased] in CHANGELOG.md to current package version.
Expects the changelog to follow keepachangelog.com v1.0.0 guidelines.
Usage
- Install with npm:
$ npm i -D changelog-updater
- Add script
version
topackage.json
:
{
"scripts": {
"version": "changelog-updater && git add CHANGELOG.md"
}
}
Options
--init
Creates a new changelog if it does not exist.
Set repository
in package.json
:
{
"repository": {
"url": "https://github.com/username/repository.git"
}
}
Use in the root of your new project:
$ npx changelog-updater --init
--check
Fails if the changelog does not have any changes under [Unreleased], otherwise exits normally without updating the changelog.
Use as a pre-commit hook or in testing pipelines:
$ npx changelog-updater --check
Or, use as a preversion
script:
{
"scripts": {
"preversion": "changelog-updater --check",
"version": "changelog-updater && git add CHANGELOG.md"
}
}