lib/deploy

deploy module.

Source:

Members

(inner) getNextVersion

Source:

Obtain the next semantic version your project will use

Methods

(inner) withBumpType(options0, options1)

Source:

Kick-off remote side-effects of a version change such as NPM publish or git push w/ tags

Parameters:
Name Type Description
options0 Object

that contains some of the options for NPM &/or git deployment

  • bumpType: {String} the type of version increment to perform, e.g. "prerelease"
options1 Object

that contains some of the options for NPM &/or git deployment

  • dryRun: {Boolean} a switch for turning on log-only "deployment",
  • publish: {Boolean} a switch for turning on NPM publishing (default to true),
  • push: {Boolean} a switch for turning on git pushing (default to true),
  • CL_STATUS: {String} the initial git status of the CHANGELOG, used for error recovery,
  • PKG_STATUS: {String} the initial git status of package.json, used for error recovery,
  • CURRENT_SHA: {String} the git commit hash prior to deploy, used for error recovery
Returns:

Stream.