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

docs: explain npx alternatives for Yarn

Browse Source
This commit is contained in:
Stephan Bönnemann 2018-01-28 03:24:21 +01:00 committed by Gregor Martynus
parent e3c9bb8bd4
commit dc416b2ce9
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/support/FAQ.md
View File

@ -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: 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 ```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. 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? ## 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. Yes, **semantic-release** is a Node CLI application but it can be used to publish any type of packages.