From 36b3e900cf709d73515142566c1ba57168f6caf7 Mon Sep 17 00:00:00 2001 From: kopal <50901044+kopal2212@users.noreply.github.com> Date: Thu, 30 Jul 2020 03:55:32 +0530 Subject: [PATCH] docs(configuration.md): Updated documentation for dry-run feature of semantic Release (#1607) --- docs/usage/configuration.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index 536faf43d6..38e2213cde 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -116,7 +116,9 @@ Type: `Boolean`
Default: `false` if running in a CI environment, `true` otherwise
CLI arguments: `-d`, `--dry-run` -Dry-run mode, skip publishing, print next version and release notes. +The objective of the dry-run mode is to get a preview of the pending release. Dry-run mode skips the following steps: prepare, publish, success and fail. In addition to this it prints the next version and release notes to the console. + +**Note**: The Dry-run mode verifies the repository push permission, even though nothing will be pushed. The verification is done to help user to figure out potential configuration issues. ### ci