0 ‐ File settings ( .versionize )

Valid documentation for the version v2.2.0

General options

Silent

• Name : Silent ( bool )
• Default value : False
• Description : Descrption here

DryRun

• Name : DryRun ( bool )
• Default value : False
• Description : Descrption here

ReleaseAs

• Name : ReleaseAs ( string )
• Default value : null
• Description : Descrption here

SkipDirty

• Name : SkipDirty ( bool )
• Default value : False
• Description : Descrption here

SkipCommit

• Name : SkipCommit ( bool )
• Default value : False
• Description : Descrption here

SkipTag

• Name : SkipTag ( bool )
• Default value : False
• Description : Descrption here

SkipChangelog

• Name : SkipChangelog ( bool )
• Default value : False
• Description : Descrption here

TagOnly

• Name : TagOnly ( bool )
• Default value : False
• Description : Descrption here

IgnoreInsignificantCommits

• Name : IgnoreInsignificantCommits ( bool )
• Default value : False
• Description : Descrption here

ExitInsignificantCommits

• Name : ExitInsignificantCommits ( bool )
• Default value : False
• Description : Descrption here

CommitSuffix

• Name : CommitSuffix ( string )
• Default value : null
• Description : Descrption here

Prerelease

• Name : Prerelease ( string )
• Default value : null
• Description : Descrption here

AggregatePrereleases

• Name : AggregatePrereleases ( bool )
• Default value : False
• Description : Descrption here

FirstParentOnlyCommits

• Name : FirstParentOnlyCommits ( bool )
• Default value : False
• Description : Descrption here

Sign

• Name : Sign ( bool )
• Default value : False
• Description : Descrption here

CommitParserOptions

(What is the purpose of this parameter ?? I don't know what it does for me.)

• HeaderPatterns (list of string)

Project options

Describe how it's work and when we have to use it

• Name
• Path
• TagTemplate
• Changelog

Changelog options

• Header
• Path
• IncludeAllCommits
• Sections
• LinkTemplates

Changelog section

Type

• Name Type ( string )
• Default value : null
• Description : Description here

Section

• Name Section ( string )
• Default value : null
• Description : Description here

Hidden

• Name Hidden ( bool )
• Default value : nothing
• Description : Description here

Changelog template (add reference to your workitems, issues, PR, ...)

Describe how it's work and when we have to use it

• IssueLink
• CommitLink
• VersionTagLink

Words that will be replaced by the program :

• {issue} => issue Id
• {commitSha} => commit Sha
• {version} => version