Table of Contents

Class DependabotGroup

Namespace
Invex.StructuredText.GithubActions.DependabotConfigModel.Model
Assembly
Invex.StructuredText.GithubActions.dll

Group configuration for dependencies.

[Union]
public abstract record DependabotGroup
Inheritance
object
DependabotGroup
Derived

Properties

AppliesTo

Use to specify whether the rules in the group apply to version updates or security updates.

public GroupAppliesTo? AppliesTo { get; init; }

Property Value

GroupAppliesTo?

DependencyType

Specify a dependency type to be included in the group.

public virtual GroupDependencyType? DependencyType { get; init; }

Property Value

GroupDependencyType?

ExcludePatterns

Exclude certain dependencies from the group.

public virtual IReadOnlyList<string> ExcludePatterns { get; init; }

Property Value

IReadOnlyList<string>

GroupBy

Configure how dependencies are grouped within this group.

public virtual GroupBy? GroupBy { get; init; }

Property Value

GroupBy?

Patterns

Define strings of characters that match with a dependency name to include those dependencies in the group.

public virtual IReadOnlyList<string> Patterns { get; init; }

Property Value

IReadOnlyList<string>

UpdateTypes

Specify the semantic versioning level to include in the group.

public virtual IReadOnlyList<GroupUpdateType> UpdateTypes { get; init; }

Property Value

IReadOnlyList<GroupUpdateType>

Methods

Match(Action<FromType>, Action<FromPatterns>, Action<FromExcludePatterns>, Action<FromUpdateTypes>, Action<FromGroupBy>)

public abstract void Match(Action<DependabotGroup.FromType> fromType, Action<DependabotGroup.FromPatterns> fromPatterns, Action<DependabotGroup.FromExcludePatterns> fromExcludePatterns, Action<DependabotGroup.FromUpdateTypes> fromUpdateTypes, Action<DependabotGroup.FromGroupBy> fromGroupBy)

Parameters

fromType Action<DependabotGroup.FromType>
fromPatterns Action<DependabotGroup.FromPatterns>
fromExcludePatterns Action<DependabotGroup.FromExcludePatterns>
fromUpdateTypes Action<DependabotGroup.FromUpdateTypes>
fromGroupBy Action<DependabotGroup.FromGroupBy>

MatchFromExcludePatterns(Action<FromExcludePatterns>, Action)

public abstract void MatchFromExcludePatterns(Action<DependabotGroup.FromExcludePatterns> fromExcludePatterns, Action @else)

Parameters

fromExcludePatterns Action<DependabotGroup.FromExcludePatterns>
else Action

MatchFromExcludePatterns<TMatchOutput>(Func<FromExcludePatterns, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchFromExcludePatterns<TMatchOutput>(Func<DependabotGroup.FromExcludePatterns, TMatchOutput> fromExcludePatterns, Func<TMatchOutput> @else)

Parameters

fromExcludePatterns Func<DependabotGroup.FromExcludePatterns, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchFromExcludePatterns<TState>(TState, Action<TState, FromExcludePatterns>, Action<TState>)

public abstract void MatchFromExcludePatterns<TState>(TState state, Action<TState, DependabotGroup.FromExcludePatterns> fromExcludePatterns, Action<TState> @else)

Parameters

state TState
fromExcludePatterns Action<TState, DependabotGroup.FromExcludePatterns>
else Action<TState>

Type Parameters

TState

MatchFromExcludePatterns<TState, TMatchOutput>(TState, Func<TState, FromExcludePatterns, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchFromExcludePatterns<TState, TMatchOutput>(TState state, Func<TState, DependabotGroup.FromExcludePatterns, TMatchOutput> fromExcludePatterns, Func<TState, TMatchOutput> @else)

Parameters

state TState
fromExcludePatterns Func<TState, DependabotGroup.FromExcludePatterns, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

MatchFromGroupBy(Action<FromGroupBy>, Action)

public abstract void MatchFromGroupBy(Action<DependabotGroup.FromGroupBy> fromGroupBy, Action @else)

Parameters

fromGroupBy Action<DependabotGroup.FromGroupBy>
else Action

MatchFromGroupBy<TMatchOutput>(Func<FromGroupBy, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchFromGroupBy<TMatchOutput>(Func<DependabotGroup.FromGroupBy, TMatchOutput> fromGroupBy, Func<TMatchOutput> @else)

Parameters

fromGroupBy Func<DependabotGroup.FromGroupBy, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchFromGroupBy<TState>(TState, Action<TState, FromGroupBy>, Action<TState>)

public abstract void MatchFromGroupBy<TState>(TState state, Action<TState, DependabotGroup.FromGroupBy> fromGroupBy, Action<TState> @else)

Parameters

state TState
fromGroupBy Action<TState, DependabotGroup.FromGroupBy>
else Action<TState>

Type Parameters

TState

MatchFromGroupBy<TState, TMatchOutput>(TState, Func<TState, FromGroupBy, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchFromGroupBy<TState, TMatchOutput>(TState state, Func<TState, DependabotGroup.FromGroupBy, TMatchOutput> fromGroupBy, Func<TState, TMatchOutput> @else)

Parameters

state TState
fromGroupBy Func<TState, DependabotGroup.FromGroupBy, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

MatchFromPatterns(Action<FromPatterns>, Action)

public abstract void MatchFromPatterns(Action<DependabotGroup.FromPatterns> fromPatterns, Action @else)

Parameters

fromPatterns Action<DependabotGroup.FromPatterns>
else Action

MatchFromPatterns<TMatchOutput>(Func<FromPatterns, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchFromPatterns<TMatchOutput>(Func<DependabotGroup.FromPatterns, TMatchOutput> fromPatterns, Func<TMatchOutput> @else)

Parameters

fromPatterns Func<DependabotGroup.FromPatterns, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchFromPatterns<TState>(TState, Action<TState, FromPatterns>, Action<TState>)

public abstract void MatchFromPatterns<TState>(TState state, Action<TState, DependabotGroup.FromPatterns> fromPatterns, Action<TState> @else)

Parameters

state TState
fromPatterns Action<TState, DependabotGroup.FromPatterns>
else Action<TState>

Type Parameters

TState

MatchFromPatterns<TState, TMatchOutput>(TState, Func<TState, FromPatterns, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchFromPatterns<TState, TMatchOutput>(TState state, Func<TState, DependabotGroup.FromPatterns, TMatchOutput> fromPatterns, Func<TState, TMatchOutput> @else)

Parameters

state TState
fromPatterns Func<TState, DependabotGroup.FromPatterns, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

MatchFromType(Action<FromType>, Action)

public abstract void MatchFromType(Action<DependabotGroup.FromType> fromType, Action @else)

Parameters

fromType Action<DependabotGroup.FromType>
else Action

MatchFromType<TMatchOutput>(Func<FromType, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchFromType<TMatchOutput>(Func<DependabotGroup.FromType, TMatchOutput> fromType, Func<TMatchOutput> @else)

Parameters

fromType Func<DependabotGroup.FromType, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchFromType<TState>(TState, Action<TState, FromType>, Action<TState>)

public abstract void MatchFromType<TState>(TState state, Action<TState, DependabotGroup.FromType> fromType, Action<TState> @else)

Parameters

state TState
fromType Action<TState, DependabotGroup.FromType>
else Action<TState>

Type Parameters

TState

MatchFromType<TState, TMatchOutput>(TState, Func<TState, FromType, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchFromType<TState, TMatchOutput>(TState state, Func<TState, DependabotGroup.FromType, TMatchOutput> fromType, Func<TState, TMatchOutput> @else)

Parameters

state TState
fromType Func<TState, DependabotGroup.FromType, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

MatchFromUpdateTypes(Action<FromUpdateTypes>, Action)

public abstract void MatchFromUpdateTypes(Action<DependabotGroup.FromUpdateTypes> fromUpdateTypes, Action @else)

Parameters

fromUpdateTypes Action<DependabotGroup.FromUpdateTypes>
else Action

MatchFromUpdateTypes<TMatchOutput>(Func<FromUpdateTypes, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchFromUpdateTypes<TMatchOutput>(Func<DependabotGroup.FromUpdateTypes, TMatchOutput> fromUpdateTypes, Func<TMatchOutput> @else)

Parameters

fromUpdateTypes Func<DependabotGroup.FromUpdateTypes, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchFromUpdateTypes<TState>(TState, Action<TState, FromUpdateTypes>, Action<TState>)

public abstract void MatchFromUpdateTypes<TState>(TState state, Action<TState, DependabotGroup.FromUpdateTypes> fromUpdateTypes, Action<TState> @else)

Parameters

state TState
fromUpdateTypes Action<TState, DependabotGroup.FromUpdateTypes>
else Action<TState>

Type Parameters

TState

MatchFromUpdateTypes<TState, TMatchOutput>(TState, Func<TState, FromUpdateTypes, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchFromUpdateTypes<TState, TMatchOutput>(TState state, Func<TState, DependabotGroup.FromUpdateTypes, TMatchOutput> fromUpdateTypes, Func<TState, TMatchOutput> @else)

Parameters

state TState
fromUpdateTypes Func<TState, DependabotGroup.FromUpdateTypes, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

Match<TMatchOutput>(Func<FromType, TMatchOutput>, Func<FromPatterns, TMatchOutput>, Func<FromExcludePatterns, TMatchOutput>, Func<FromUpdateTypes, TMatchOutput>, Func<FromGroupBy, TMatchOutput>)

public abstract TMatchOutput Match<TMatchOutput>(Func<DependabotGroup.FromType, TMatchOutput> fromType, Func<DependabotGroup.FromPatterns, TMatchOutput> fromPatterns, Func<DependabotGroup.FromExcludePatterns, TMatchOutput> fromExcludePatterns, Func<DependabotGroup.FromUpdateTypes, TMatchOutput> fromUpdateTypes, Func<DependabotGroup.FromGroupBy, TMatchOutput> fromGroupBy)

Parameters

fromType Func<DependabotGroup.FromType, TMatchOutput>
fromPatterns Func<DependabotGroup.FromPatterns, TMatchOutput>
fromExcludePatterns Func<DependabotGroup.FromExcludePatterns, TMatchOutput>
fromUpdateTypes Func<DependabotGroup.FromUpdateTypes, TMatchOutput>
fromGroupBy Func<DependabotGroup.FromGroupBy, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

Match<TState>(TState, Action<TState, FromType>, Action<TState, FromPatterns>, Action<TState, FromExcludePatterns>, Action<TState, FromUpdateTypes>, Action<TState, FromGroupBy>)

public abstract void Match<TState>(TState state, Action<TState, DependabotGroup.FromType> fromType, Action<TState, DependabotGroup.FromPatterns> fromPatterns, Action<TState, DependabotGroup.FromExcludePatterns> fromExcludePatterns, Action<TState, DependabotGroup.FromUpdateTypes> fromUpdateTypes, Action<TState, DependabotGroup.FromGroupBy> fromGroupBy)

Parameters

state TState
fromType Action<TState, DependabotGroup.FromType>
fromPatterns Action<TState, DependabotGroup.FromPatterns>
fromExcludePatterns Action<TState, DependabotGroup.FromExcludePatterns>
fromUpdateTypes Action<TState, DependabotGroup.FromUpdateTypes>
fromGroupBy Action<TState, DependabotGroup.FromGroupBy>

Type Parameters

TState

Match<TState, TMatchOutput>(TState, Func<TState, FromType, TMatchOutput>, Func<TState, FromPatterns, TMatchOutput>, Func<TState, FromExcludePatterns, TMatchOutput>, Func<TState, FromUpdateTypes, TMatchOutput>, Func<TState, FromGroupBy, TMatchOutput>)

public abstract TMatchOutput Match<TState, TMatchOutput>(TState state, Func<TState, DependabotGroup.FromType, TMatchOutput> fromType, Func<TState, DependabotGroup.FromPatterns, TMatchOutput> fromPatterns, Func<TState, DependabotGroup.FromExcludePatterns, TMatchOutput> fromExcludePatterns, Func<TState, DependabotGroup.FromUpdateTypes, TMatchOutput> fromUpdateTypes, Func<TState, DependabotGroup.FromGroupBy, TMatchOutput> fromGroupBy)

Parameters

state TState
fromType Func<TState, DependabotGroup.FromType, TMatchOutput>
fromPatterns Func<TState, DependabotGroup.FromPatterns, TMatchOutput>
fromExcludePatterns Func<TState, DependabotGroup.FromExcludePatterns, TMatchOutput>
fromUpdateTypes Func<TState, DependabotGroup.FromUpdateTypes, TMatchOutput>
fromGroupBy Func<TState, DependabotGroup.FromGroupBy, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

UnwrapFromExcludePatterns()

public abstract DependabotGroup.FromExcludePatterns UnwrapFromExcludePatterns()

Returns

DependabotGroup.FromExcludePatterns

UnwrapFromGroupBy()

public abstract DependabotGroup.FromGroupBy UnwrapFromGroupBy()

Returns

DependabotGroup.FromGroupBy

UnwrapFromPatterns()

public abstract DependabotGroup.FromPatterns UnwrapFromPatterns()

Returns

DependabotGroup.FromPatterns

UnwrapFromType()

public abstract DependabotGroup.FromType UnwrapFromType()

Returns

DependabotGroup.FromType

UnwrapFromUpdateTypes()

public abstract DependabotGroup.FromUpdateTypes UnwrapFromUpdateTypes()

Returns

DependabotGroup.FromUpdateTypes