From ba79c8590aae648a898248e865e1c826c63e24ee Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Fri, 5 Jan 2018 18:33:22 -0500 Subject: [PATCH] docs: typos. clarifications --- docs/recipes/gitlab-ci.md | 2 +- docs/support/FAQ.md | 2 +- docs/usage/installation.md | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/recipes/gitlab-ci.md b/docs/recipes/gitlab-ci.md index 742c426aeb..2a42d4eeb3 100644 --- a/docs/recipes/gitlab-ci.md +++ b/docs/recipes/gitlab-ci.md @@ -51,7 +51,7 @@ publish: - npm run semantic-release # Only for a global semantic-release installation - - npm install semantic-release + - npm install -g semantic-release - semantic-release ``` diff --git a/docs/support/FAQ.md b/docs/support/FAQ.md index 355d1b925d..adada6e9a8 100644 --- a/docs/support/FAQ.md +++ b/docs/support/FAQ.md @@ -38,7 +38,7 @@ See the [CI configuration recipes](../recipes/README.md#ci-configurations) for m Yes, **semantic-release** is a Node CLI application but it can be used to publish any type of packages. -To publish a non-JavaScript package you would need to: +To publish a non-Node package (without a `package.json`) you would need to: - Use a [global](../usage/installation.md#global-installation) **semantic-release** installation - Set **semantic-release** [options](../usage/configuration.md#options) via [CLI arguments or rc file](../usage/configuration.md#configuration) - Make sure your CI job executing the `semantic-release` command has access to [Node >= 8](#why-does-semantic-release-require-node-version--8) to execute the `semantic-release` command diff --git a/docs/usage/installation.md b/docs/usage/installation.md index ac30313bf8..3bb3b90d14 100644 --- a/docs/usage/installation.md +++ b/docs/usage/installation.md @@ -30,3 +30,4 @@ For other type of projects we recommend to install **semantic-release** globally $ npm install -g semantic-release $ semantic-release ``` +**Note:**: For a global installation, it's recommended to specify the major **semantic-release** version to install (for example with with `npm install -g semantic-release@12`). This way your build will not automatically use the next major **semantic-release** release that could possibly break your build. You will have to upgrade manually when a new major version is released.