semantic-release
AboutGitHubNeed Help?
next
next
  • Introduction
  • Usage
    • Getting started
    • Installation
    • CI Configuration
    • Configuration
    • Plugins
    • Workflow configuration
    • Shareable configurations
  • Extending
    • Plugins
    • Shareable configuration
  • Recipes
    • CI configurations
      • CircleCI 2.0
      • Travis CI
      • GitLab CI
    • Git hosted services
      • Git authentication with SSH keys
    • Package managers and languages
  • Developer guide
    • JavaScript API
    • Plugin development
    • Shareable configuration development
  • Support
    • Resources
    • Frequently Asked Questions
    • Troubleshooting
    • Node version requirement
    • Node Support Policy
Powered by GitBook
On this page
  • Local installation
  • Global installation
Edit on Git
  1. Usage

Installation

PreviousGetting startedNextCI Configuration

Last updated 5 years ago

Local installation

For we recommend installing semantic-release locally and running the semantic-release command with :

$ 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 for more details.

Global installation

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

$ 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). 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 for more details.

Node modules projects
npx
npx
What is npx
What is npx