Header menu logo Partas.GitNet

GitNetRuntime Module

Types

Type Description

GitNetRuntime

Runtime for a GitNetConfig; contains resources that are repeatedly shared between functions. Not intended for side effects. Just to prevent boiler plate parameters being passed around.

Functions and values

Function or value Description

willBump runtime

Full Usage: willBump runtime

Parameters:
    runtime : GitNetRuntime - The provider for the values to match against the bump types.

Returns: ParsedCommit -> BumpType voption

Checks the ParsedCommit against the GitNetConfig to determine if the commit would indicate a bump, and if so, of what type.

Automatically returns ValueNone for UnconventionalCommits currently.

Checks in order of precedence:
Epoch > Major > Minor > Patch

runtime : GitNetRuntime

The provider for the values to match against the bump types.

Returns: ParsedCommit -> BumpType voption

Type something to start searching.