diff --git a/docs/support/FAQ.md b/docs/support/FAQ.md index 7bbac18c..96deeaed 100644 --- a/docs/support/FAQ.md +++ b/docs/support/FAQ.md @@ -145,7 +145,7 @@ If you have introduced a breaking bug in a release you have 2 options: In both cases **semantic-release** will publish a new release, so your package users' will get the fixed/reverted version. -Depending on the package manager you are using, you might be able to un-publish or deprecate a release, in order to prevent users to download it by accident. For example npm allows you to [un-publish](https://docs.npmjs.com/cli/unpublish) in [next 72 hours](https://www.npmjs.com/policies/unpublish) after releasing or to [deprecate](https://docs.npmjs.com/cli/deprecate) a release. +Depending on the package manager you are using, you might be able to un-publish or deprecate a release, in order to prevent users from downloading it by accident. For example npm allows you to [un-publish](https://docs.npmjs.com/cli/unpublish) [within 72 hours](https://www.npmjs.com/policies/unpublish) after releasing. You may also [deprecate](https://docs.npmjs.com/cli/deprecate) a release if you would rather avoid un-publishing. In any case **do not remove the Git tag associated with the buggy version**, otherwise **semantic-release** will later try to republish that version. Publishing a version after un-publishing is not supported by most package managers. diff --git a/docs/support/troubleshooting.md b/docs/support/troubleshooting.md index d6e7a9de..75e7aafa 100644 --- a/docs/support/troubleshooting.md +++ b/docs/support/troubleshooting.md @@ -12,7 +12,7 @@ npm ERR! You do not have permission to publish "". Are you logged This is most likely related to a misconfiguration of the [npm registry authentication](https://github.com/semantic-release/npm#npm-registry-authentication) or to your user [missing permission](https://docs.npmjs.com/cli/team) for publishing. -It might also happen if the package name you are trying to publish already exists (in such case npm consider you are trying to publish a new version of a package that is not yours, hence the permission error). +It might also happen if the package name you are trying to publish already exists (in the case of npm, you may be trying to publish a new version of a package that is not yours, hence the permission error). To verify if your package name is available you can use [npm-name-cli](https://github.com/sindresorhus/npm-name-cli): ```bash diff --git a/docs/usage/ci-configuration.md b/docs/usage/ci-configuration.md index 940d8f6d..ef2c7292 100644 --- a/docs/usage/ci-configuration.md +++ b/docs/usage/ci-configuration.md @@ -26,7 +26,7 @@ Most **semantic-release** [plugins](plugins.md) require setting up authenticatio | `NPM_TOKEN` | npm token created via [npm token create](https://docs.npmjs.com/getting-started/working_with_tokens#how-to-create-new-tokens).
**Note**: Only the `auth-only` [level of npm two-factor authentication](https://docs.npmjs.com/getting-started/using-two-factor-authentication#levels-of-authentication) is supported. | | `GH_TOKEN` | GitHub authentication token.
**Note**: Only the [personal token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) authentication is supported. | -See each plugin documentation for the environment variables to set up. +See each plugin's documentation for the environment variables required. The authentication token/credentials have to be made available in the CI service via environment variables. diff --git a/docs/usage/shareable-configurations.md b/docs/usage/shareable-configurations.md index 18e7e3e5..bfaf3bab 100644 --- a/docs/usage/shareable-configurations.md +++ b/docs/usage/shareable-configurations.md @@ -1,6 +1,6 @@ # Shareable configurations -A sharable configuration is an [npm](https://www.npmjs.com/) package that exports a **semantic-release** configuration object. It allows for use of the same configuration across several projects. +A shareable configuration is an [npm](https://www.npmjs.com/) package that exports a **semantic-release** configuration object. It allows for use of the same configuration across several projects. The shareable configurations to use can be set with the [extends](configuration.md#extends) option.