Wondering what’s next for npm?Check out our public roadmap! »

ezchangelog

4.0.2 • Public • Published

ezchangelog

Log changes easily.

Usage

npm i -g ezchangelog
 
cd repo
 
# create a new changelog.md file 
ezchangelog
 
# do some commits 
 
# prepend new changes 
ezchangelog
 
# Print the new changelog contents 
git log | ezchangelogStream -p
 

Example

See changelog

ezchangelog

Use it the way you do git log, and your changelog file will be updated.

By default, --no-merges is enabled.

ezchangelogStream

Specify more custom options.

git log | ezchangelog-stream
 

Pass any valid arguments to git log.

Options for ezchangelog-stream:

-p, --print: print the changelog contents rather than write to disk.

-o, --out: specify the changelog file path.

--inc, --incremental: used together with --out to update changelog incrementally.

package.json

{
  "ezchangelog": {
    "baseUrl": "https://github.com/zoubin/ezchangelog/commit/",
    "out": "changelog.md"
  }
}

There are links to all commits.

baseUrl: specify the base path for each commit. By default, commits are linked to github.

out: specify the changelog file path

Install

npm i [email protected]

Version

4.0.2

License

MIT

Last publish

Collaborators

  • avatar