Skip to content

Latest commit

 

History

History
154 lines (112 loc) · 7.65 KB

index.md

File metadata and controls

154 lines (112 loc) · 7.65 KB
Raw

changelog Command Line Reference

Version: 0.3.49-pre+6e74043735

Usage

changelog [--configurationFilePath|-c <VALUE>]
          [--currentVersion <VALUE>]
          [--githubAccessToken <VALUE>]
          [--gitlabAccessToken <VALUE>]
          [--outputPath|-o <VALUE>]
          --repository|-r <VALUE>
          [--template <VALUE>]
          [--verbose|-v]
          [--versionRange <VALUE>]

Parameters

Name Short Name Required Description
configurationFilePath c No The path of the configuration file to use. When no configuration file path is specified, changelog looks for a file named 'changelog.settings.json' in the repository directory. If no configuration file is found, default settings are used.
currentVersion No Sets the version of the currently checked-out commit. Value must be a valid semantic version
githubAccessToken No The access token to use if the GitHub integration is enabled.
gitlabAccessToken No The access token to use if the GitLab integration is enabled.
outputPath o No The path to save the changelog to.
repository r Yes The local path of the git repository to generate a change log for.
template No Sets the template to use for generating the changelog.
verbose v No Increase the level of detail for messages logged to the console.
versionRange No The range of versions to include in the change log. Value must be a valid NuGet version range.

configurationFilePath Parameter

The path of the configuration file to use. When no configuration file path is specified, changelog looks for a file named 'changelog.settings.json' in the repository directory. If no configuration file is found, default settings are used.
Name: configurationFilePath
Short name: c
Position: Named parameter
Required: No
Default value: None

currentVersion Parameter

Sets the version of the currently checked-out commit. Value must be a valid semantic version
Name: currentVersion
Position: Named parameter
Required: No
Default value: None

githubAccessToken Parameter

The access token to use if the GitHub integration is enabled.
Name: githubAccessToken
Position: Named parameter
Required: No
Default value: None

gitlabAccessToken Parameter

The access token to use if the GitLab integration is enabled.
Name: gitlabAccessToken
Position: Named parameter
Required: No
Default value: None

outputPath Parameter

The path to save the changelog to.
Name: outputPath
Short name: o
Position: Named parameter
Required: No
Default value: None

repository Parameter

The local path of the git repository to generate a change log for.
Name: repository
Short name: r
Position: Named parameter
Required: Yes
Default value: None

template Parameter

Sets the template to use for generating the changelog.
Name: template
Position: Named parameter
Required: No
Default value: None

verbose Parameter

Increase the level of detail for messages logged to the console.
Name: verbose
Short name: v
Position: Named parameter
Required: No (Switch parameter)
Default value: False

versionRange Parameter

The range of versions to include in the change log. Value must be a valid NuGet version range.
Name: versionRange
Position: Named parameter
Required: No
Default value: None

Documentation generated by MdDocs