changelog.md
How does it work
- Get last version from git tag, if no tags it defaults to
0.0.0
- Get the commits since last version
- Prompt user to enter the type of each commit
- Infer the new version from the types of all commits
- Generate markdown string from commits and prompt answers
- Create or prepend to
CHANGELOG.md
and update package.json
version field - Commits changes and create new git tag
Install
$ yarn global add changelog.md
Usage
$ changelog
Recipes
Commit types
- patch: Bug fixes
- minor: Backward-compatible updates
- major: Introducing breaking changes
- ignore: Do not include this commit in changelog
Besides choosing ignore
in prompts to exclude commits in changelog, the commit message that starts with [skip]
[ignore]
[skip $foo]
[ignore $foo]
will also be excluded.
Work with npm publish
$ git add -am "change the world"
$ npm test
$ changelog
$ git push --follow-tags
$ npm publish
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Author
changelog.md © EGOIST, Released under the MIT License.
Authored and maintained by EGOIST with help from contributors (list).
egoistian.com · GitHub @EGOIST · Twitter @rem_rin_rin