gen-changelogs v0.1.0

gen-changelogs

Install

$ npm install gen-changelogs --save-dev
# or
$ yarn add gen-changelogs -D

Documentation

Table of Contents

• getCurrentActiveType
  • Parameters
• shouldContinuePrerelease
  • Parameters
• getTypePriority
  • Parameters
• bumpVersion
  • Parameters

getCurrentActiveType

extract the in-pre-release type in target version

Parameters

• version String

Returns string

shouldContinuePrerelease

if a version is currently in pre-release state, and if it current in-pre-release type is same as expect type, it should continue the pre-release with the same type

Parameters

• version String
• expectType String

Returns boolean

getTypePriority

calculate the priority of release type, major - 2, minor - 1, patch - 0

Parameters

• type String

Returns number

bumpVersion

determine the recommended version bump

Parameters

• releaseAs String a semver release type major|minor|patch
• preset String conventional-changelog preset to use (optional, default 'angular')

Returns Promise resolves the determined version bump