npm

Need private packages and team management tools?Check out npm Orgs. »

@readme/changelog

1.0.0 • Public • Published

@readme/changelog

Changelog generator in use at ReadMe

CircleCI

Installation

npm install @readme/changelog --save

Usage

Parses your recent git history for any commits that look like the following:

[feature][new] This is a brand new feature!

This is a longer description of the feature

This gets parsed out into a commit object like the following:

{
  "type": "new",
  "title": "This is a brand new feature!",
  "date": "2018-03-13 10:42:45 -0700",
  "description": "This is a longer description of the feature"
}

If you use the cli, an array of commits will get saved to changelog.json in the current working directory.

$ changelog

Credits

Dom Harrington

License

ISC

Keywords

none

install

npm i @readme/changelog

Downloadsweekly downloads

1

version

1.0.0

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability