simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: clarify the --ci / --no-ci CLI option

Browse Source
This commit is contained in:
Pierre Vanduynslager 2018-09-03 13:55:46 -04:00
parent dffe148e33
commit 468f8a8bda
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/support/FAQ.md
View File

@ -98,7 +98,7 @@ See the [CI configuration recipes](../recipes/README.md#ci-configurations) for m
## Can I run semantic-release on my local machine rather than on a CI server? ## Can I run semantic-release on my local machine rather than on a CI server?
Yes, you can by explicitly setting the [`--no-ci` CLI option](../usage/configuration.md#options) option. You will also have to set the required [authentication](../usage/ci-configuration.md#authentication) via environment variables on your local machine, for example: Yes, you can by explicitly setting the [`--no-ci` CLI option](../usage/configuration.md#ci) option. You will also have to set the required [authentication](../usage/ci-configuration.md#authentication) via environment variables on your local machine, for example:
```bash ```bash
$ NPM_TOKEN=<your_npm_token> GH_TOKEN=<your_github_token> npx semantic-release --no-ci $ NPM_TOKEN=<your_npm_token> GH_TOKEN=<your_github_token> npx semantic-release --no-ci

10
docs/usage/configuration.md
View File

@ -100,13 +100,15 @@ CLI arguments: `-d`, `--dry-run`
Dry-run mode, skip publishing, print next version and release notes. Dry-run mode, skip publishing, print next version and release notes.
### noCi ### ci
Type: `Boolean`<br> Type: `Boolean`<br>
Default: `false`<br> Default: `true`<br>
CLI arguments: `--no-ci` CLI arguments: `--ci` / `--no-ci`
Skip Continuous Integration environment verifications. This allows for making releases from a local machine. Set to `fasle` to skip Continuous Integration environment verifications. This allows for making releases from a local machine.
**Note**: The CLI arguments `--no-ci` is equivalent to `--ci false`.
### debug ### debug