Skip to content

Commit

Permalink
docs(configuration.md): Updated documentation for dry-run feature of …
Browse files Browse the repository at this point in the history
…semantic Release (semantic-release#1607)
  • Loading branch information
kopal2212 authored and pull[bot] committed Aug 6, 2020
1 parent f4cf4df commit 36b3e90
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/usage/configuration.md
Expand Up @@ -116,7 +116,9 @@ Type: `Boolean`<br>
Default: `false` if running in a CI environment, `true` otherwise<br>
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

Expand Down

0 comments on commit 36b3e90

Please sign in to comment.