Skip to content
This repository has been archived by the owner on Dec 21, 2022. It is now read-only.

hypermodules/changelog-init

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
 
 
 
 
 
 
 
 

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

About

💱 Initializes a keepachangelog.com changelog in the current directory

Resources

Stars

Watchers

Forks

Packages

No packages published