simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: add clarification in EGITNOPERMISSION error message

Browse Source 
Clarify that the error might be due to an invalid `repositoryUrl` configuration.
This commit is contained in:
Pierre Vanduynslager 2018-05-20 16:04:25 -04:00
parent d7081fadb1
commit a72d8f52af
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
index.js
View File

@ -54,6 +54,7 @@ async function run(options, plugins) {
await verify(options); await verify(options);
const {repositoryUrl} = options;
options.repositoryUrl = await getGitAuthUrl(options); options.repositoryUrl = await getGitAuthUrl(options);
if (!(await isBranchUpToDate(options.branch))) { if (!(await isBranchUpToDate(options.branch))) {
@ -68,7 +69,7 @@ async function run(options, plugins) {
await verifyAuth(options.repositoryUrl, options.branch); await verifyAuth(options.repositoryUrl, options.branch);
} catch (err) { } catch (err) {
logger.error(`The command "${err.cmd}" failed with the error message %s.`, err.stderr); logger.error(`The command "${err.cmd}" failed with the error message %s.`, err.stderr);
throw getError('EGITNOPERMISSION', {options}); throw getError('EGITNOPERMISSION', {options, repositoryUrl});
} }
logger.log('Run automated release from branch %s', options.branch); logger.log('Run automated release from branch %s', options.branch);

8
lib/definitions/errors.js
View File

@ -27,15 +27,17 @@ Please make sure to add the \`repositoryUrl\` to the [semantic-release configura
'docs/usage/configuration.md' 'docs/usage/configuration.md'
)}).`, )}).`,
}), }),
EGITNOPERMISSION: ({options}) => ({ EGITNOPERMISSION: ({options, repositoryUrl}) => ({
message: 'The push permission to the Git repository is required.', message: 'The push permission to the Git repository is required.',
details: `**semantic-release** cannot push the version tag to the branch \`${ details: `**semantic-release** cannot push the version tag to the branch \`${
options.branch options.branch
}\` on remote Git repository. }\` on remote Git repository with URL \`${repositoryUrl}\`.
Please refer to the [authentication configuration documentation](${linkify( Please refer to the [authentication configuration documentation](${linkify(
'docs/usage/ci-configuration.md#authentication' 'docs/usage/ci-configuration.md#authentication'
)}) to configure the Git credentials on your CI environment.`, )}) to configure the Git credentials on your CI environment and make sure the [repositoryUrl](${linkify(
'docs/usage/configuration.md#repositoryurl'
)}) is configured with a [valid Git URL](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols).`,
}), }),
EINVALIDTAGFORMAT: ({tagFormat}) => ({ EINVALIDTAGFORMAT: ({tagFormat}) => ({
message: 'Invalid `tagFormat` option.', message: 'Invalid `tagFormat` option.',