Skip to content

coderaiser/changelog-io

Repository files navigation

ChangeLog License NPM version Build Status Coverage Status

Generate changelog with one command.

Install

npm i changelog-io -g

How it works?

If you already have tags and use conventions like this:

  • feature(scope) command message;
  • fix(scope) commit message;
  • docs(scope) commit message;
  • chore(scope) commit message;
  • refactor(scope) commit message;

Or:

  • feature: scope: command message;
  • fix: scope: commit message;
  • docs: scope: commit message;
  • chore: scope: commit message;
  • refactor: scope: commit message;

feature and fix commit messages from previous tag will print out to screen.

How to use?

changelog                       # to log output
changelog version > ChangeLog   # to save output to ChangeLog

API

import changelog from 'changelog-io';

changelog('v1.0.0');
// returns
`
2021.08.25

feature:
- a1d0d14 (package) eslint-plugin-putout v9.2.1
- a1d0d15 (package) putout v19.0.0
- a1d0d16  (changelog) convert ot ESM
`;

License

MIT