From 468f8a8bda01ea1d8202f9f405ad77f8adbf2a9a Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Mon, 3 Sep 2018 13:55:46 -0400 Subject: [PATCH] docs: clarify the `--ci` / `--no-ci` CLI option --- docs/support/FAQ.md | 2 +- docs/usage/configuration.md | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/support/FAQ.md b/docs/support/FAQ.md index d898a3cc..2baa44d3 100644 --- a/docs/support/FAQ.md +++ b/docs/support/FAQ.md @@ -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? -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 $ NPM_TOKEN= GH_TOKEN= npx semantic-release --no-ci diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index ef83982c..f421b960 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -100,13 +100,15 @@ CLI arguments: `-d`, `--dry-run` Dry-run mode, skip publishing, print next version and release notes. -### noCi +### ci Type: `Boolean`
-Default: `false`
-CLI arguments: `--no-ci` +Default: `true`
+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