Namespace: PROMPTS

PROMPTS

Prompts functions

Source:

Methods

(async, static) checkStagedFiles(staged, data)

check if staged files are available

Parameters:
Name Type Description
staged Array.<string>

if staged files

data DATA

data object

Source:
Returns:

undefined

(async, static) confirmGenerateChangelog(data) → {Promise.<boolean>}

Confirm changelog generation

Parameters:
Name Type Description
data DATA

data object

Source:
Returns:
  • true if confirmed
Type
Promise.<boolean>

(async, static) confirmPublishReleaseNotes() → {Promise.<boolean>}

Ask if GitHub release notes should be published

Source:
Returns:
  • true if confirmed
Type
Promise.<boolean>

(async, static) confirmPush() → {Promise.<boolean>}

Confirm git push to remote repository and push tags

Source:
Returns:
  • true if confirmed
Type
Promise.<boolean>

(async, static) confirmReleaseCommit(data) → {Promise.<boolean>}

Confirm release commit

Parameters:
Name Type Description
data DATA

data object

Source:
Returns:
  • true if confirmed
Type
Promise.<boolean>

(async, static) confirmToContinue() → {Promise.<boolean>}

Confirm to continue

Source:
Returns:
  • true if confirmed
Type
Promise.<boolean>

(async, static) createChangelogFile(file) → {Promise.<boolean>}

ask if create a changelog file

Parameters:
Name Type Description
file string

file name

Source:
Returns:
Type
Promise.<boolean>

(async, static) customReleaseVersion(data) → {Promise.<string>}

Custom release version

Parameters:
Name Type Description
data DATA

data object

Source:
Returns:

portal name|names

Type
Promise.<string>

(async, static) selectReleaseType(data) → {Promise.<string>}

Select release type

Parameters:
Name Type Description
data DATA

data object

Source:
Returns:
  • release type
Type
Promise.<string>

(async, static) selectReleaseVersion(data) → {Promise.<string>}

Select a new release version

Parameters:
Name Type Description
data DATA

data object

Source:
Returns:
  • release version
Type
Promise.<string>

Table of contents