💱 Initializes a keepachangelog.com changelog in the current directory
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
.gitignore
CHANGELOG.md
README.md
changelog-init.gif
index.js
package.json

README.md

changelog-init

release npm stability

Creates a keepachangelog.com changelog in the current directory. It tries to grab some default values from package.json and folder names.

demo

Install

$ npm i changelog-init -g

Or use it apart of a larger work flow.

CLI

$ cd project-dir
$ changelog-init
CHANGELOG.md created at /project-dir/CHANGELOG.md
$ cat CHANGELOG.md
# project-dir Change Log
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## 2.34.5 - 2015-03-30
* ...

changelog-init won't overwrite existing changelogs unless you tell it to:

$ changelog-init
CHANGELOG.md already exists
$ changelog-init -F
Force overwriting existing changelog
CHANGELOG.md created at /project/CHANGELOG.md

You can specify a path as well:

$ changelog-init /path/to/project
CHANGELOG.md created at /path/to/project/CHANGELOG.md

API

var init = require('changelog-init')
var opts = {force: false}
init('/path/to/project/', opts, function(err, path) {
  // Stuff
})

init returns an error and a path where the CHANGELOG.md was saved.

See Also

References

License

ISC