From 95a9e89141216e25c4dec9f3fbc3962790298c43 Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Thu, 22 Aug 2019 12:12:12 -0400 Subject: [PATCH] revert: fix(definitions): Repository documentation links This reverts commit 1eb302545e3ed16044cb0533430d39ce0eeed9e2. --- bin/semantic-release.js | 2 +- lib/definitions/errors.js | 36 ++++++++++++++++++------------------ 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/bin/semantic-release.js b/bin/semantic-release.js index d2999f18c3..12dd2b56b6 100755 --- a/bin/semantic-release.js +++ b/bin/semantic-release.js @@ -16,7 +16,7 @@ if (!semver.satisfies(process.version, pkg.engines.node)) { console.error( `[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); } diff --git a/lib/definitions/errors.js b/lib/definitions/errors.js index 3c005b80e4..69c2fb2259 100644 --- a/lib/definitions/errors.js +++ b/lib/definitions/errors.js @@ -19,11 +19,11 @@ Please verify your CI configuration to make sure the \`semantic-release\` comman ENOREPOURL: () => ({ message: 'The `repositoryUrl` option is required.', 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). Please make sure to add the \`repositoryUrl\` to the [semantic-release configuration] (${linkify( - 'docs/01-usage/configuration.md' + 'docs/usage/configuration.md' )}).`, }), 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}\`. 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( - '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).`, }), EINVALIDTAGFORMAT: ({tagFormat}) => ({ message: 'Invalid `tagFormat` option.', 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). Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`, @@ -49,14 +49,14 @@ Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.` ETAGNOVERSION: ({tagFormat}) => ({ message: 'Invalid `tagFormat` option.', details: `The [tagFormat](${linkify( - 'docs/01-usage/configuration.md#tagformat' + 'docs/usage/configuration.md#tagformat' )}) option must contain the variable \`version\` exactly once. Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`, }), EPLUGINCONF: ({type, required, pluginConf}) => ({ 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 ' : '' } 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}) => ({ message: 'The `plugins` configuration is invalid.', 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. 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. Please refer to the \`${pluginName}\` and [semantic-release plugins configuration](${linkify( - 'docs/01-usage/plugins.md' + 'docs/usage/plugins.md' )}) documentation for more details.`, }), 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** logs from your CI job - The value returned by the plugin: \`${stringify(result)}\` -- A link to the **semantic-release** plugin developer guide: [${linkify( - 'docs/04-developer-guide/plugin.md' - )}](${linkify('docs/04-developer-guide/plugin.md')})`, +- A link to the **semantic-release** plugin developer guide: [${linkify('docs/developer-guide/plugin.md')}](${linkify( + 'docs/developer-guide/plugin.md' + )})`, }), EGENERATENOTESOUTPUT: ({result, pluginName}) => ({ 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** logs from your CI job - The value returned by the plugin: \`${stringify(result)}\` -- A link to the **semantic-release** plugin developer guide: [${linkify( - 'docs/04-developer-guide/plugin.md' - )}](${linkify('docs/04-developer-guide/plugin.md')})`, +- A link to the **semantic-release** plugin developer guide: [${linkify('docs/developer-guide/plugin.md')}](${linkify( + 'docs/developer-guide/plugin.md' + )})`, }), EPUBLISHOUTPUT: ({result, pluginName}) => ({ 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** logs from your CI job - The value returned by the plugin: \`${stringify(result)}\` -- A link to the **semantic-release** plugin developer guide: [${linkify( - 'docs/04-developer-guide/plugin.md' - )}](${linkify('docs/04-developer-guide/plugin.md')})`, +- A link to the **semantic-release** plugin developer guide: [${linkify('docs/developer-guide/plugin.md')}](${linkify( + 'docs/developer-guide/plugin.md' + )})`, }), };