-
Notifications
You must be signed in to change notification settings - Fork 79
Open
Description
The return type of analyzeCommits
is declared as String|null
in the JSDoc header. However, analyzeCommits
is an async function. Return type should be Promise<String|null>
instead.
Lines 12 to 26 in 685f65a
/** | |
* Determine the type of release to create based on a list of commits. | |
* | |
* @param {Object} pluginConfig The plugin configuration. | |
* @param {String} pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint') | |
* @param {String} pluginConfig.config Requirable npm package with a custom conventional-changelog preset | |
* @param {String|Array} pluginConfig.releaseRules A `String` to load an external module or an `Array` of rules. | |
* @param {Object} pluginConfig.parserOpts Additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`. | |
* @param {Object} context The semantic-release context. | |
* @param {Array<Object>} context.commits The commits to analyze. | |
* @param {String} context.cwd The current working directory. | |
* | |
* @returns {String|null} the type of release to create based on the list of commits or `null` if no release has to be done. | |
*/ | |
async function analyzeCommits(pluginConfig, context) { |
Metadata
Metadata
Assignees
Labels
No labels