semantic-release/docs/usage/installation.md
2018-01-05 16:05:30 -05:00

33 lines
704 B
Markdown

# Installation
## Local installation
For [Node modules projects](https://docs.npmjs.com/getting-started/creating-node-modules) we recommend to install **semantic-release** locally and to run the `semantic-release` command with a [npm script](https://docs.npmjs.com/misc/scripts):
```bash
$ npm install --save-dev semantic-release
```
In your `package.json`:
```json
"scripts": {
"semantic-release": "semantic-release"
}
```
Then in the CI environment:
```bash
$ npm run semantic-release
```
## Global installation
For other type of projects we recommend to install **semantic-release** globally directly in the CI environment:
```bash
$ npm install -g semantic-release
$ semantic-release
```