@release-it/keep-a-changelog

Keep a Changelog plugin for release-it

Showing:

Popularity

Downloads/wk

1.8K

GitHub Stars

7

Maintenance

Last Commit

4mos ago

Contributors

7

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Keep-a-changelog plugin for release-it

This release-it plugin maintains your CHANGELOG.md file according to the Keep A Changelog standards.

The idea and initial implementation comes from @eMarek.

npm install --save-dev @release-it/keep-a-changelog

In release-it config:

"plugins": {
  "@release-it/keep-a-changelog": {
    "filename": "CHANGELOG.md"
  }
}

Options

optiondefault valuedescription
filename'CHANGELOG.md'File with changelogs.
strictLatesttrueEntry of latest version must be present in order to get correct changelog. Set this option to false if you expect latest version without logs.
addUnreleasedfalseIt leaves "Unreleased" title row if set to true.
keepUnreleasedfalseIt leaves "Unreleased" title row unchanged if set to true.
addVersionUrlfalseLinks the version to the according changeset.
head'HEAD'The git revision the new version tag is compared to in the Unreleased URL.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial