IgnoreCommit (Partas.GitNet)

IgnoreCommit Type

Namespace: Partas.GitNet
Assembly: Partas.GitNet.dll
Parent Module: ConfigTypes
Base Type: obj
All Interfaces: IEquatable<IgnoreCommit> , IStructuralEquatable

Commit ignore strategies. See Remarks for overview.

Strategy Description

AuthorIgnores commits based on the Author which is distinct from the Committer
EmailIgnores commits based on the Author email.
TypeIgnores commits based on the Type if they are conventional commits
FooterKeyIgnores commits based on the presence of a FooterKey if they are conventional commits
FooterKeyValueIgnores commits based on whether a particular Footer key value pair is present (if they are conventional commits).
ShaIgnores commits based on their Sha. It only checks the abbreviated forms as is provided by most tools, and will shorten full Shas if required.
TagIgnore all the commits of a particular Tag
TimeRangeIgnore commits that fall within a specific time period.
CommitScopeIgnore commits that have a specified conventional commit scope. (eg: fix(ci): summary has a scope of ci)
SubjectRegexIgnore commits based on their subject (or the first line) that matches the given regex.
SkipCiIgnore commits that start with [skip ci]

Union cases

Union case	Description
`Author author` Full Usage: `Author author` Parameters: author : `string`	Ignores commits based on the `Author` name. The committer is distinguished from the author. author : `string`
`CommitScope scope` Full Usage: `CommitScope scope` Parameters: scope : `string`	Ignore all commits that have a specified conventional commit scope. scope : `string`
`Email email` Full Usage: `Email email` Parameters: email : `string`	Ignores commits based on the `Author` email. email : `string`
`FooterKey footerToken` Full Usage: `FooterKey footerToken` Parameters: footerToken : `string`	Ignores commits based on a `FooterKey` (if they are conventional commits). footerToken : `string`
`FooterKeyValue(footerToken, footerValue)` Full Usage: `FooterKeyValue(footerToken, footerValue)` Parameters: footerToken : `string` footerValue : `string`	Ignores commits based on a `FooterKey` and `FooterValue` combination (if they are conventional commits). footerToken : `string` footerValue : `string`
`Sha sha` Full Usage: `Sha sha` Parameters: sha : `string`	Ignores commits based on their `Sha`. We only check that the beginning of the actual `Sha` matches the given `Sha`. This means you can use abbreviated Shas at your own discretion. sha : `string`
`SkipCi` Full Usage: `SkipCi`	Ignore all commits that start with [skip ci].
`SubjectRegex regex` Full Usage: `SubjectRegex regex` Parameters: regex : `Regex`	Ignore all commits that have conventional commit subject, or a first line that matches the given regex. regex : `Regex`
`Tag tag` Full Usage: `Tag tag` Parameters: tag : `string`	Ignore all commits related to a tag. tag : `string`
`TimeRange(fromDate, timeSpan)` Full Usage: `TimeRange(fromDate, timeSpan)` Parameters: fromDate : `DateTimeOffset` timeSpan : `TimeSpan`	Ignore all commits that were made within a specified time period. fromDate : `DateTimeOffset` timeSpan : `TimeSpan`
`Type type` Full Usage: `Type type` Parameters: type : `string`	Ignores commits based on the `Type` (if they are conventional commits). type : `string`

Instance members

Instance member	Description
`this.IsAuthor` Full Usage: `this.IsAuthor` Returns: `bool`	Returns: `bool`
`this.IsCommitScope` Full Usage: `this.IsCommitScope` Returns: `bool`	Returns: `bool`
`this.IsEmail` Full Usage: `this.IsEmail` Returns: `bool`	Returns: `bool`
`this.IsFooterKey` Full Usage: `this.IsFooterKey` Returns: `bool`	Returns: `bool`
`this.IsFooterKeyValue` Full Usage: `this.IsFooterKeyValue` Returns: `bool`	Returns: `bool`
`this.IsSha` Full Usage: `this.IsSha` Returns: `bool`	Returns: `bool`
`this.IsSkipCi` Full Usage: `this.IsSkipCi` Returns: `bool`	Returns: `bool`
`this.IsSubjectRegex` Full Usage: `this.IsSubjectRegex` Returns: `bool`	Returns: `bool`
`this.IsTag` Full Usage: `this.IsTag` Returns: `bool`	Returns: `bool`
`this.IsTimeRange` Full Usage: `this.IsTimeRange` Returns: `bool`	Returns: `bool`
`this.IsType` Full Usage: `this.IsType` Returns: `bool`	Returns: `bool`