From dc416b2ce994885956f0ad13a376ec518eabf4ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stephan=20B=C3=B6nnemann?= Date: Sun, 28 Jan 2018 03:24:21 +0100 Subject: [PATCH] docs: explain npx alternatives for Yarn --- docs/support/FAQ.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/support/FAQ.md b/docs/support/FAQ.md index 94ee30a4..5e8e7a9f 100644 --- a/docs/support/FAQ.md +++ b/docs/support/FAQ.md @@ -35,11 +35,19 @@ Alternatively you can use a [global](../usage/installation.md#global-installatio If your CI environment provides [nvm](https://github.com/creationix/nvm) you can switch to Node 8 before installing and running the `semantic-release` command: ```bash -$ nvm install 8 && yarn install -g semantic-release && semantic-release +$ nvm install 8 && yarn global add semantic-release && semantic-release ``` See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments. +As `semantic-release` is recommended to be executed with [`npx`](https://www.npmjs.com/package/npx) an alternative is required for usage with Yarn. Even though it is possible to install npx with Yarn, it's not recommended. Yarn and npx would be using different cache locations. + +For [local installation](../usage/installation.md#local-installation) replace +`npx semantic-release` with `yarn run semantic-release`. + +For [global installation](../usage/installation.md#global-installation) replace +`npx semantic-release` with `yarn global add semantic-release && semantic-release`. + ## Can I use semantic-release to publish non-JavaScript packages? Yes, **semantic-release** is a Node CLI application but it can be used to publish any type of packages.