From 37a66135e30af1ef9556b177d290d0a25132f83b Mon Sep 17 00:00:00 2001 From: kopal2212 Date: Wed, 29 Jul 2020 17:36:27 +0530 Subject: [PATCH 1/2] docs(configuration.md): modified documentation for dry-run --- docs/usage/configuration.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index 536faf43d6..cebe340564 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -116,7 +116,10 @@ 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 Dry-run mode is to get preview of the release results before rolling out the final release. +Dry-run mode, skips the following steps i.e. prepare, publish, success and fail. In addition to this it prints the next version and release notes on 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 configuartion issues. ### ci From 22720ad4757782f8547cb202e454d0b06c5a2f64 Mon Sep 17 00:00:00 2001 From: kopal <50901044+kopal2212@users.noreply.github.com> Date: Wed, 29 Jul 2020 22:15:17 +0530 Subject: [PATCH 2/2] docs: Updated dry -run documentation Co-authored-by: Gregor Martynus --- docs/usage/configuration.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index cebe340564..38e2213cde 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -116,10 +116,9 @@ Type: `Boolean`
Default: `false` if running in a CI environment, `true` otherwise
CLI arguments: `-d`, `--dry-run` -The objective of Dry-run mode is to get preview of the release results before rolling out the final release. -Dry-run mode, skips the following steps i.e. prepare, publish, success and fail. In addition to this it prints the next version and release notes on the console. +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 configuartion issues. +**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