RTK

rtk~ RTK

RTK is the enchilada, Release The Kraken!

Constructor

new RTK(resources, optsopt)

Construct RTK object which will manage a set of resources.
Source:
Parameters:
Name Type Attributes Description
resources Array.<Object> resources which contain version value, the first resource is used as the source of truth of current version
opts Object <optional>
 optional settings
Name Type Attributes Description
dryRun Boolean <optional>
 when true, no change will be made
releaseIncrementType String <optional>
 major, minor, or patch
postReleaseIncrementType String <optional>
 major, minor, or patch
tagFormat String <optional>
 SCM tag format, e.g. v{version}

Methods

release(releaseSchemeNameopt, versionSchemeNameopt, scmSchemeNameopt, cb)

Execute release steps for the specified release scheme.
Source:
Parameters:
Name Type Attributes Default Description
releaseSchemeName String <optional>
 rtk release scheme name that defines the steps involved in a release
versionSchemeName String <optional>
 semver version scheme name that defines the release and post-release version values
scmSchemeName String <optional>
 git name of SCM used by the repository to be released
cb function standard cb(err, result) callback