Constructor
new Rtk(versionSchemeNameopt, scmSchemeNameopt, preReleaseVersion, opts)
Construct release scheme with the version and SCM schemes to use.
- Source:
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
versionSchemeName |
String
|
<optional>
|
semver
|
version scheme name
|
scmSchemeName |
String
|
<optional>
|
git
|
SCM scheme name
|
preReleaseVersion |
String
|
|
|
current pre-release version
|
opts |
Object
|
|
|
release 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
|
|
Methods
post(resources, opts, cb)
Post step: set next pre-release version on all resources, then commit
the changes. A resource's params.post_release_value overrides the
post-release version.
- Source:
Parameters:
| Name |
Type |
Description |
resources |
Array.<Object>
|
resources which contain version value
|
opts |
Object
|
release settings
| Name |
Type |
Attributes |
Description |
dryRun |
Boolean
|
<optional>
|
when true, no change will be made
|
|
cb |
function
|
standard cb(err, result) callback
|
pre(resources, opts, cb)
Pre step: set release version on all resources, then commit the changes.
A resource's params.release_value overrides the release version, and
params.release_format formats it, e.g. v{version}.
- Source:
Parameters:
| Name |
Type |
Description |
resources |
Array.<Object>
|
resources which contain version value
|
opts |
Object
|
release settings
| Name |
Type |
Attributes |
Description |
dryRun |
Boolean
|
<optional>
|
when true, no change will be made
|
|
cb |
function
|
standard cb(err, result) callback
|
release(resources, opts, cb)
Release step: tag the release version.
- Source:
Parameters:
| Name |
Type |
Description |
resources |
Array.<Object>
|
resources which contain version value
|
opts |
Object
|
release settings
| Name |
Type |
Attributes |
Description |
dryRun |
Boolean
|
<optional>
|
when true, no change will be made
|
tagFormat |
String
|
|
SCM tag format, e.g. v{version}
|
|
cb |
function
|
standard cb(err, result) callback
|