1.3.0 • Published 10 years ago

generate_release_notes v1.3.0

Weekly downloads
3
License
ISC
Repository
github
Last release
10 years ago

Generate Release Notes

This generates two files notes.html a view of your change logs and readme changelogs.json the github dump

CLI Usage

Install using

npm i -g generate_release_notes

You need the following param

  • --repo=:owner/:repo

The following params are optional

  • --save-to=folder_location saves notes.html and changelog.json to this folder, defaults to ./
  • --token=xxx the github oatuh token
  • --from-tag-name=x.x.x.x.x.x... assumption it is a versioned number
  • --last-releases=X gets the last X releases
  • --readme-location=file_location this will be in the top of notes.html, will not be present when not given
  • --style-sheet-location=file_location adds style sheet for notes.html, will still look like readme
  • --usage or --help exits and displays this message

Node Usage

Install using

npm i --save-dev generate_release_notes

var generate = require('generate_release_notes');

var options = {
    'repo':':owner/:repo',
    'save-to':'folder_location',
    'token':'xxx',
    'readme-location':'file_location',
    'style-sheet-location':'file_location',
    'from-tag-name':'x.x.x.x.x.x...',
    'last-releases': X,
    'callback': function(data) {
        console.log(data.notes) // the html string
        console.log(data.changelogs) // the json string
    }
}

generate.create(options);

In this case you will need the callback because of the call to github

1.3.0

10 years ago

1.2.4

10 years ago

1.2.3

10 years ago

1.2.2

10 years ago

1.2.1

10 years ago

1.2.0

10 years ago

1.1.0

10 years ago

1.0.0

10 years ago