Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(configuration.md): Updated documentation for dry-run feature of semantic Release #1607

Merged
merged 3 commits into from Jul 29, 2020
Merged

docs(configuration.md): Updated documentation for dry-run feature of semantic Release #1607

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
37a6613
docs(configuration.md): modified documentation for dry-run
kopal2212 Jul 29, 2020
41948d1
Merge pull request #7 from kopal2212/feature-kopal
kopal2212 Jul 29, 2020
22720ad
docs: Updated dry -run documentation
kopal2212 Jul 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/usage/configuration.md
View file
Open in desktop
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