diff --git a/lib/git.js b/lib/git.js index 6833785e..77931be9 100644 --- a/lib/git.js +++ b/lib/git.js @@ -4,7 +4,7 @@ const debug = require('debug')('semantic-release:git'); /** * Get the commit sha for a given tag. * - * @param {string} tagName Tag name for which to retrieve the commit sha. + * @param {String} tagName Tag name for which to retrieve the commit sha. * @param {Object} [execaOpts] Options to pass to `execa`. * * @return {string} The commit sha of the tag in parameter or `null`. @@ -35,10 +35,10 @@ async function getTags(execaOpts) { /** * Verify if the `ref` is in the direct history of the current branch. * - * @param {string} ref The reference to look for. + * @param {String} ref The reference to look for. * @param {Object} [execaOpts] Options to pass to `execa`. * - * @return {boolean} `true` if the reference is in the history of the current branch, falsy otherwise. + * @return {Boolean} `true` if the reference is in the history of the current branch, falsy otherwise. */ async function isRefInHistory(ref, execaOpts) { try { @@ -73,7 +73,7 @@ async function fetch(repositoryUrl, execaOpts) { * * @param {Object} [execaOpts] Options to pass to `execa`. * - * @return {string} the sha of the HEAD commit. + * @return {String} the sha of the HEAD commit. */ function getGitHead(execaOpts) { return execa.stdout('git', ['rev-parse', 'HEAD'], execaOpts); @@ -155,10 +155,10 @@ async function push(repositoryUrl, branch, execaOpts) { /** * Verify a tag name is a valid Git reference. * - * @param {string} tagName the tag name to verify. + * @param {String} tagName the tag name to verify. * @param {Object} [execaOpts] Options to pass to `execa`. * - * @return {boolean} `true` if valid, falsy otherwise. + * @return {Boolean} `true` if valid, falsy otherwise. */ async function verifyTagName(tagName, execaOpts) { try {