Header menu logo Partas.GitNet

Defaults Module

Contains default configuration values and settings used across the application. This module provides default strategies, configurations, and mappings related to various components such as file splitting, output paths, versioning, commit grouping, and release generation.

Functions and values

Function or value Description

allowUnconventional

Full Usage: allowUnconventional

Returns: bool

Default true

Returns: bool

allowUnmatched

Full Usage: allowUnmatched

Returns: bool

Default true

Returns: bool

assemblyFileManagement

Full Usage: assemblyFileManagement

Returns: AssemblyFileManagement

Default AssemblyFileManagement.UpdateIfExists

Returns: AssemblyFileManagement

bumpConfig

Full Usage: bumpConfig

Returns: BumpConfig

 Mapping = commitBumpTypeMapping
 DefaultBumpStrategy = forceBumpStrategy
 GenerateRelease = generateRelease
 GenerateReleaseStrategy = generateReleaseStrategy

Returns: BumpConfig

commitBumpTypeMapping

Full Usage: commitBumpTypeMapping

Returns: CommitBumpTypeMapping

Epoch: EpochMatcher 'epoch'

Major: Types - 'breaking', 'remove'

Minor: Types - 'feat', 'new', 'add'

Patch: Types - 'fix', 'perf', 'update', 'change'

Returns: CommitBumpTypeMapping

commitConfig

Full Usage: commitConfig

Returns: CommitConfig

Default { Ignore = [] }

Returns: CommitConfig

defaultUnmatchedGroup

Full Usage: defaultUnmatchedGroup

Returns: CommitGroup

Default CommitGroup.Defaults.other

Returns: CommitGroup

forceBumpStrategy

Full Usage: forceBumpStrategy

Returns: ForceBumpStrategy

Default ForceBumpStrategy.None

Returns: ForceBumpStrategy

forceBumpValue

Full Usage: forceBumpValue

Returns: ForceBumpValue

Default ForceBumpValue.Auto

Returns: ForceBumpValue

fsharpNameResolution

Full Usage: fsharpNameResolution

Returns: FSharpNameResolution

Default FSharpNameResolution.Auto

Returns: FSharpNameResolution

gitNetConfig isFSharp

Full Usage: gitNetConfig isFSharp

Parameters:
    isFSharp : 'a

Returns: GitNetConfig
isFSharp : 'a
Returns: GitNetConfig

githubConfig

Full Usage: githubConfig

Returns: GithubConfig

Default Url = GitHubUrlStrategy.Auto

Returns: GithubConfig

groupMatchers

Full Usage: groupMatchers

Returns: GroupMatcher list

Breaking: breaking

Changed: update, change, updated

Deprecated: depr, deprecated, deprecate

Feat: feat, enhancement, new, added

Fix: fix, fixed

Revert: revert, rollback

Returns: GroupMatcher list

ignoreCommits

Full Usage: ignoreCommits

Returns: IgnoreCommit list

 IgnoreCommit.SkipCi
 IgnoreCommit.FooterKeyValue("changelog", "true")
 IgnoreCommit.FooterKeyValue("gitnet", "ignore")

Returns: IgnoreCommit list

networkConfig

Full Usage: networkConfig

Returns: NetworkConfig

Default { Github = githubConfig }

Returns: NetworkConfig

outputConfig

Full Usage: outputConfig

Returns: OutputConfig

 FileSplitting = fileSplittingStrategy
 MacroGrouping = macroGroupType
 Path = IO.Path.Combine(Environment.CurrentDirectory, "RELEASE_NOTES.md") |> outputPathType
 Formatting = macroGroupType
 GroupMatcher = groupMatchers
 Ignore = ignoreCommits
 AllowUnconventional = allowUnconventional
 DefaultUnmatchedGroup = defaultUnmatchedGroup
 AllowUnmatched = allowUnmatched

Returns: OutputConfig

projectFSharpConfig

Full Usage: projectFSharpConfig

Returns: ProjectConfig

 IgnoredProjects = []
 AutoScoping = _.Split('.') >> Seq.last >> Some
 OverrideExplicitScopes = false
 NameResolution = fsharpNameResolution
module Seq from Microsoft.FSharp.Collections
val last: source: 'T seq -> 'T
union case Option.Some: Value: 'T -> Option<'T>

Returns: ProjectConfig

projectInitialVersion

Full Usage: projectInitialVersion

Returns: ProjectInitialVersionStrategy

Default ProjectInitialVersionStrategy.Simple

Returns: ProjectInitialVersionStrategy

scopeStrategy

Full Usage: scopeStrategy

Returns: ScopeStrategy

Default ScopeStrategy.Auto

Returns: ScopeStrategy

Type something to start searching.