GithubReleaseNotes

GithubReleaseNotes

new GithubReleaseNotes(optionsopt)

Parameters:
Name Type Attributes Description
options Object <optional>

The options of the module
Since:
  • 0.1.0
Source:

Methods

changelog(type)

Generate the Changelog based on the github releases, or from fresh generated releases.

Parameters:
Name Type Description
type string

The type of changelog
Since:
  • 0.5.0
Source:

init(action) → {Promise}

Initialise the GithubReleaseNotes module, create the options and run a given module method

Parameters:
Name Type Description
action function
Since:
  • 0.5.0
Source:
Returns:

The generated options

Type
Promise

release() → {Promise}

Get All the tags, get the dates, get the commits between those dates and prepeare the release

Since:
  • 0.1.0
Source:
Returns:
Type
Promise