Global

Methods

caller()

Source:

Caller abstract method for promisifying traditional callback methods

Git(repo, initialBranch)

Source:
Parameters:
Name Type Description
repo string

repo URL

initialBranch string

the branch we'll move to gh-pages from

module:lib/gh-pages(options)

Source:

Push to gh-pages branch for github

Parameters:
Name Type Description
options Object

that contains all the options of the plugin

  • remoteUrl: The {String} remote url (github repository) of the project,
  • origin: The {String} origin of the git repository (default to "origin"),
  • branch: The {String} branch where deploy will by done (default to "gh-pages"),
  • cacheDir: {String} where the git repo will be located. (default to a temporary folder)
  • push: {Boolean} to know whether or not the branch should be pushed (default to true)
  • message: {String} commit message (default to "Update [timestamp]")
Returns:

Stream.

writeChangelog(options, done)

Source:

Output change information from git commits to CHANGELOG.md

Parameters:
Name Type Description
options Object

that contains all the options of the changelog writer

  • repoType: The {String} repo type (github or stash) of the project (default to "github"),
  • version: The {String} semantic version to add a change log for
done function

that gets called when the changelog write task has completed

Returns:

Function.