0 ‐ CLI Options

Valid documentation for the version v2.2.0

Usage

Indicate which takes precedence: the command line arguments or the .versionize file. Write details about args :

• Argument names
• Type of argument (bool, string, nothing, ...)
  • Example : -w <workspaceLocation> for -w "C:\Projets\MyProject\src"
  • Example : --silent
  • Example : --proj-name <PROJECT_CONFIG_NAME> for --proj-name EShopProject_LibZero, --proj-name EShopProject_LibOne
• Default value
• (example of CLI usable)

List of args

WorkingDirectory

• Name : -w|--workingDir <WORKING_DIRECTORY>
• Description : Directory containing projects to version

ConfigurationDirectory

• Name : --configDir <CONFIG_DIRECTORY>
• Description : Directory containing the versionize configuration file

Silent

• Name : --silent
• Description : Suppress output to console

DryRun

• Name : -d|--dry-run
• Description : Skip changing versions in projects, changelog generation and git commit

ReleaseAs

• Name : -r|--release-as <VERSION>
• Description : Specify the release version manually

SkipDirty

• Name : --skip-dirty
• Description : Skip git dirty check

SkipCommit

• Name : --skip-commit
• Description : Skip commit and git tag after updating changelog and incrementing the version

SkipTag

• Name : --skip-tag
• Description : Skip git tag after making release commit

SkipChangelog

• Name : --skip-changelog
• Description : Skip changelog generation

TagOnly

• Name : --tag-only
• Description : Only works with git tags, does not commit or modify the csproj file.

IgnoreInsignificant

• Name : -i|--ignore-insignificant-commits
• Description : Do not bump the version if no significant commits (fix, feat or BREAKING) are found

ExitInsignificant

• Name : --exit-insignificant-commits
• Description : Exits with a non zero exit code if no significant commits (fix, feat or BREAKING) are found

CommitSuffix

• Name : --commit-suffix <SUFFIX>
• Description : Suffix to be added to the end of the release commit message (e.g. [skip ci])

Prerelease

• Name : -p|--pre-release <PRERELEASE_IDENTIFIER>
• Description : Release as pre-release version with given pre release label.

AggregatePrereleases

• Name : -a|--aggregate-pre-releases
• Description : Include all pre-release commits in the changelog since the last full version.

FirstParentOnlyCommits

• Name : --first-parent-only-commits
• Description : Ignore commits beyond the first parent.

Sign

• Name : -s|--sign
• Description : Sign the git commit and tag.

ProjectName

• Name : --proj-name <PROJECT_NAME>
• Description : Name of a project defined in the configuration file (for monorepos)

UseCommitMessageInsteadOfTagToFindLastReleaseCommit

• Name : --find-release-commit-via-message
• Description : Use commit message instead of tag to find last release commit