simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
semantic-release/docs/usage/getting-started.md
Pierre Vanduynslager 6f33c76fde docs: various clarifications and language improvvements
2019-08-22 14:47:21 -04:00

1.1 KiB
Raw Permalink Blame History

Getting started

In order to use semantic-release you must follow these steps:

  1. Install semantic-release in your project
  2. Configure your Continuous Integration service to run semantic-release
  3. Configure your Git repository and package manager repository authentication in your Continuous Integration service
  4. Configure semantic-release options and plugins

Alternatively those steps can be easily done with the semantic-release interactive CLI:

npm install -g semantic-release-cli

cd your-module
semantic-release-cli setup

dialogue

See the semantic-release-cli documentation for more details.

Note: only a limited number of options, CI services and plugins are currently supported by semantic-release-cli.