bbc/generate_release_notes

Name: generate_release_notes

Owner: BBC

Description: Reads github to generate release notes

Created: 2016-02-18 12:45:47.0

Updated: 2016-02-18 12:55:12.0

Pushed: 2016-03-08 12:12:52.0

Homepage: null

Size: 650

Language: CSS

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Generate Release Notes

This generates two files

CLI Usage

Install using

need the following param

`--repo=:owner/:repo```

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
rsioned 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

ode Usage
all using

generate = require('generate_release_notes');

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
}


rate.create(options);

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