simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
semantic-release/docs/usage/installation.md
Pierre Vanduynslager ba79c8590a docs: typos. clarifications
2018-01-05 18:58:22 -05:00

1.1 KiB
Raw Blame History

Installation

Local installation

For Node modules projects we recommend to install semantic-release locally and to run the semantic-release command with a npm script:

$ npm install --save-dev semantic-release

In your package.json:

"scripts": {
  "semantic-release": "semantic-release"
}

Then in the CI environment:

$ npm run semantic-release

Global installation

For other type of projects we recommend to install semantic-release globally directly in the CI environment:

$ 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.