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

revert: fix(definitions): Repository documentation links

Browse Source 
This reverts commit 1eb302545e3ed16044cb0533430d39ce0eeed9e2.
This commit is contained in:
Pierre Vanduynslager 2019-08-22 12:12:12 -04:00
parent 54d8e3fe99
commit 95a9e89141
2 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bin/semantic-release.js
View File

@ -16,7 +16,7 @@ if (!semver.satisfies(process.version, pkg.engines.node)) {
console.error( console.error(
`[semantic-release]: node version ${pkg.engines.node} is required. Found ${process.version}. `[semantic-release]: node version ${pkg.engines.node} is required. Found ${process.version}.
See https://github.com/semantic-release/semantic-release/blob/master/docs/05-support/node-version.md for more details and solutions.` See https://github.com/semantic-release/semantic-release/blob/master/docs/support/node-version.md for more details and solutions.`
); );
process.exit(1); process.exit(1);
} }

36
lib/definitions/errors.js
View File

@ -19,11 +19,11 @@ Please verify your CI configuration to make sure the \`semantic-release\` comman
ENOREPOURL: () => ({ ENOREPOURL: () => ({
message: 'The `repositoryUrl` option is required.', message: 'The `repositoryUrl` option is required.',
details: `The [repositoryUrl option](${linkify( details: `The [repositoryUrl option](${linkify(
'docs/01-usage/configuration.md#repositoryurl' 'docs/usage/configuration.md#repositoryurl'
)}) cannot be determined from the semantic-release configuration, the \`package.json\` nor the [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes). )}) cannot be determined from the semantic-release configuration, the \`package.json\` nor the [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes).
Please make sure to add the \`repositoryUrl\` to the [semantic-release configuration] (${linkify( Please make sure to add the \`repositoryUrl\` to the [semantic-release configuration] (${linkify(
'docs/01-usage/configuration.md' 'docs/usage/configuration.md'
)}).`, )}).`,
}), }),
EGITNOPERMISSION: ({options}) => ({ EGITNOPERMISSION: ({options}) => ({
@ -33,15 +33,15 @@ Please make sure to add the \`repositoryUrl\` to the [semantic-release configura
}\` on remote Git repository with URL \`${options.repositoryUrl}\`. }\` on remote Git repository with URL \`${options.repositoryUrl}\`.
Please refer to the [authentication configuration documentation](${linkify( Please refer to the [authentication configuration documentation](${linkify(
'docs/01-usage/ci-configuration.md#authentication' 'docs/usage/ci-configuration.md#authentication'
)}) to configure the Git credentials on your CI environment and make sure the [repositoryUrl](${linkify( )}) to configure the Git credentials on your CI environment and make sure the [repositoryUrl](${linkify(
'docs/01-usage/configuration.md#repositoryurl' '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).`, )}) 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.',
details: `The [tagFormat](${linkify( details: `The [tagFormat](${linkify(
'docs/01-usage/configuration.md#tagformat' 'docs/usage/configuration.md#tagformat'
)}) must compile to a [valid Git reference](https://git-scm.com/docs/git-check-ref-format#_description). )}) must compile to a [valid Git reference](https://git-scm.com/docs/git-check-ref-format#_description).
Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`, Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`,
@ -49,14 +49,14 @@ Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`
ETAGNOVERSION: ({tagFormat}) => ({ ETAGNOVERSION: ({tagFormat}) => ({
message: 'Invalid `tagFormat` option.', message: 'Invalid `tagFormat` option.',
details: `The [tagFormat](${linkify( details: `The [tagFormat](${linkify(
'docs/01-usage/configuration.md#tagformat' 'docs/usage/configuration.md#tagformat'
)}) option must contain the variable \`version\` exactly once. )}) option must contain the variable \`version\` exactly once.
Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`, Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`,
}), }),
EPLUGINCONF: ({type, required, pluginConf}) => ({ EPLUGINCONF: ({type, required, pluginConf}) => ({
message: `The \`${type}\` plugin configuration is invalid.`, message: `The \`${type}\` plugin configuration is invalid.`,
details: `The [${type} plugin configuration](${linkify(`docs/01-usage/plugins.md#${toLower(type)}-plugin`)}) ${ details: `The [${type} plugin configuration](${linkify(`docs/usage/plugins.md#${toLower(type)}-plugin`)}) ${
required ? 'is required and ' : '' required ? 'is required and ' : ''
} must be a single or an array of plugins definition. A plugin definition is an npm module name, optionnaly wrapped in an array with an object. } must be a single or an array of plugins definition. A plugin definition is an npm module name, optionnaly wrapped in an array with an object.
@ -65,7 +65,7 @@ Your configuration for the \`${type}\` plugin is \`${stringify(pluginConf)}\`.`,
EPLUGINSCONF: ({plugin}) => ({ EPLUGINSCONF: ({plugin}) => ({
message: 'The `plugins` configuration is invalid.', message: 'The `plugins` configuration is invalid.',
details: `The [plugins](${linkify( details: `The [plugins](${linkify(
'docs/01-usage/configuration.md#plugins' 'docs/usage/configuration.md#plugins'
)}) option must be an array of plugin definions. A plugin definition is an npm module name, optionnaly wrapped in an array with an object. )}) option must be an array of plugin definions. A plugin definition is an npm module name, optionnaly wrapped in an array with an object.
The invalid configuration is \`${stringify(plugin)}\`.`, The invalid configuration is \`${stringify(plugin)}\`.`,
@ -77,7 +77,7 @@ The invalid configuration is \`${stringify(plugin)}\`.`,
The plugin \`${pluginName}\` doesn't have the property \`${type}\` and cannot be used for the \`${type}\` step. The plugin \`${pluginName}\` doesn't have the property \`${type}\` and cannot be used for the \`${type}\` step.
Please refer to the \`${pluginName}\` and [semantic-release plugins configuration](${linkify( Please refer to the \`${pluginName}\` and [semantic-release plugins configuration](${linkify(
'docs/01-usage/plugins.md' 'docs/usage/plugins.md'
)}) documentation for more details.`, )}) documentation for more details.`,
}), }),
EANALYZECOMMITSOUTPUT: ({result, pluginName}) => ({ EANALYZECOMMITSOUTPUT: ({result, pluginName}) => ({
@ -92,9 +92,9 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
- The **semantic-release** version: \`${pkg.version}\` - The **semantic-release** version: \`${pkg.version}\`
- The **semantic-release** logs from your CI job - The **semantic-release** logs from your CI job
- The value returned by the plugin: \`${stringify(result)}\` - The value returned by the plugin: \`${stringify(result)}\`
- A link to the **semantic-release** plugin developer guide: [${linkify( - A link to the **semantic-release** plugin developer guide: [${linkify('docs/developer-guide/plugin.md')}](${linkify(
'docs/04-developer-guide/plugin.md' 'docs/developer-guide/plugin.md'
)}](${linkify('docs/04-developer-guide/plugin.md')})`, )})`,
}), }),
EGENERATENOTESOUTPUT: ({result, pluginName}) => ({ EGENERATENOTESOUTPUT: ({result, pluginName}) => ({
message: 'The `generateNotes` plugin returned an invalid value. It must return a `String`.', message: 'The `generateNotes` plugin returned an invalid value. It must return a `String`.',
@ -106,9 +106,9 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
- The **semantic-release** version: \`${pkg.version}\` - The **semantic-release** version: \`${pkg.version}\`
- The **semantic-release** logs from your CI job - The **semantic-release** logs from your CI job
- The value returned by the plugin: \`${stringify(result)}\` - The value returned by the plugin: \`${stringify(result)}\`
- A link to the **semantic-release** plugin developer guide: [${linkify( - A link to the **semantic-release** plugin developer guide: [${linkify('docs/developer-guide/plugin.md')}](${linkify(
'docs/04-developer-guide/plugin.md' 'docs/developer-guide/plugin.md'
)}](${linkify('docs/04-developer-guide/plugin.md')})`, )})`,
}), }),
EPUBLISHOUTPUT: ({result, pluginName}) => ({ EPUBLISHOUTPUT: ({result, pluginName}) => ({
message: 'A `publish` plugin returned an invalid value. It must return an `Object`.', message: 'A `publish` plugin returned an invalid value. It must return an `Object`.',
@ -120,8 +120,8 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
- The **semantic-release** version: \`${pkg.version}\` - The **semantic-release** version: \`${pkg.version}\`
- The **semantic-release** logs from your CI job - The **semantic-release** logs from your CI job
- The value returned by the plugin: \`${stringify(result)}\` - The value returned by the plugin: \`${stringify(result)}\`
- A link to the **semantic-release** plugin developer guide: [${linkify( - A link to the **semantic-release** plugin developer guide: [${linkify('docs/developer-guide/plugin.md')}](${linkify(
'docs/04-developer-guide/plugin.md' 'docs/developer-guide/plugin.md'
)}](${linkify('docs/04-developer-guide/plugin.md')})`, )})`,
}), }),
}; };