Class ApiChangeFlags

Namespace

NoeticTools.Git2SemVer.Core.ConventionCommits

Assembly

NoeticTools.Git2SemVer.Core.dll

Flags indicating breaking changes, new features, or fixes are present.

public sealed class ApiChangeFlags

Inheritance

object

ApiChangeFlags

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

Any

A change has been made since last release.

[JsonIgnore]
public bool Any { get; }

Property Value

bool

BreakingChange

A breaking change has been made since last release.

public bool BreakingChange { get; set; }

Property Value

bool

Remarks

From Semantic Version spec item 8: "Major version X (X.y.z | X > 0) MUST be incremented if any backward incompatible changes are introduced to the public API. It MAY also include minor and patch level changes. Patch and minor versions MUST be reset to 0 when major version is incremented."

Fix

A backward compatible bug fix has been made since last release.

public bool Fix { get; set; }

Property Value

bool

Remarks

From Semantic Version spec item 6: "Patch version Z (x.y.Z | x > 0) MUST be incremented if only backward compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect behavior."

FunctionalityChange

A backward compatible functional change has been made since last release. This includes feature depreciation.

public bool FunctionalityChange { get; set; }

Property Value

bool

Remarks

From Semantic Version spec item 7: "Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backward compatible functionality is introduced to the public API. It MUST be incremented if any public API functionality is marked as deprecated. It MAY be incremented if substantial new functionality or improvements are introduced within the private code. It MAY include patch level changes. Patch version MUST be reset to 0 when minor version is incremented."

Methods

Aggregate(ApiChangeFlags)

public void Aggregate(ApiChangeFlags changeFlags)

Parameters

changeFlags ApiChangeFlags

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.