simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
semantic-release/docs/01-usage/installation.md
Emmanuel Sciara 5a5eaec3da docs: made doc file org clearer and augmented content 
This is a first step to improving the doc: - renamed directories; - augmented a fair bit of content.
To be continued
2019-07-31 14:40:10 -07:00

1.4 KiB
Raw Blame History

Installation

Local installation

For Node modules projects we recommend installing semantic-release locally and running the semantic-release command with npx:

$ npm install --save-dev semantic-release

Then in the CI environment:

$ npx semantic-release

Note: npx is a tool bundled with npm@>=5.2.0. It is used to conveniently find the semantic-release binary and to execute it. See What is npx for more details.

Global installation

For other type of projects we recommend installing semantic-release directly in the CI environment, also with npx:

$ npx semantic-release

Note: For a global installation, it's recommended to specify the major semantic-release version to install (for example with with npx semantic-release@15, or npm install -g semantic-release@15). 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.

Note: npx is a tool bundled with npm@>=5.2.0. It is used to conveniently install the semantic-release binary and to execute it. See What is npx for more details.