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

docs: typos. clarifications

Browse Source
This commit is contained in:
Pierre Vanduynslager 2018-01-05 18:33:22 -05:00
parent 75778bcea4
commit ba79c8590a
3 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/recipes/gitlab-ci.md
View File

@ -51,7 +51,7 @@ publish:
- npm run semantic-release - npm run semantic-release
# Only for a global semantic-release installation # Only for a global semantic-release installation
- npm install semantic-release - npm install -g semantic-release
- semantic-release - semantic-release
``` ```

2
docs/support/FAQ.md
View File

@ -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. 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 - 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) - 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 - 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

1
docs/usage/installation.md
View File

@ -30,3 +30,4 @@ For other type of projects we recommend to install **semantic-release** globally
$ npm install -g semantic-release $ npm install -g semantic-release
$ 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.