Table of Contents

Class DependabotUpdate

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

Package ecosystem configuration for Dependabot updates.

public sealed record DependabotUpdate
Inheritance
object
DependabotUpdate

Constructors

DependabotUpdate()

public DependabotUpdate()

Properties

Allow

Customize which updates are allowed.

public IReadOnlyList<DependabotAllow>? Allow { get; init; }

Property Value

IReadOnlyList<DependabotAllow>

Assignees

Assignees to set on pull requests.

public IReadOnlyList<string>? Assignees { get; init; }

Property Value

IReadOnlyList<string>

CommitMessage

Commit message preferences.

public DependabotCommitMessage? CommitMessage { get; init; }

Property Value

DependabotCommitMessage

Cooldown

Defines a cooldown period for dependency updates.

public DependabotCooldown? Cooldown { get; init; }

Property Value

DependabotCooldown

Directories

Locations of package manifests.

public IReadOnlyList<string> Directories { get; init; }

Property Value

IReadOnlyList<string>

Directory

Location of package manifests.

public string? Directory { get; init; }

Property Value

string

ExcludePaths

List of file paths to exclude from dependency updates.

public IReadOnlyList<string>? ExcludePaths { get; init; }

Property Value

IReadOnlyList<string>

Groups

Configure groups for dependencies.

public IReadOnlyDictionary<string, DependabotGroup>? Groups { get; init; }

Property Value

IReadOnlyDictionary<string, DependabotGroup>

Ignore

Ignore certain dependencies or versions.

public IReadOnlyList<DependabotIgnore>? Ignore { get; init; }

Property Value

IReadOnlyList<DependabotIgnore>

InsecureExternalCodeExecution

Allow or deny code execution in manifest files.

public InsecureExternalCodeExecution? InsecureExternalCodeExecution { get; init; }

Property Value

InsecureExternalCodeExecution?

Labels

Labels to set on pull requests.

public IReadOnlyList<string>? Labels { get; init; }

Property Value

IReadOnlyList<string>

Milestone

Associate all pull requests raised for a package manager with a milestone.

public int? Milestone { get; init; }

Property Value

int?

MultiEcosystemGroup

String identifier linking this ecosystem to a multi-ecosystem group.

public string? MultiEcosystemGroup { get; init; }

Property Value

string

Name

A name for the update configuration.

public string? Name { get; init; }

Property Value

string

OpenPullRequestsLimit

Limit number of open pull requests for version updates.

public int? OpenPullRequestsLimit { get; init; }

Property Value

int?

PackageEcosystem

Package manager to use, as its package-ecosystem YAML value. Use ToYamlValue(PackageEcosystem) to get the value from a PackageEcosystem member.

public required string PackageEcosystem { get; init; }

Property Value

string

Patterns

Array of dependency patterns to include in a multi-ecosystem group.

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

Property Value

IReadOnlyList<string>

PullRequestBranchName

Pull request branch name preferences.

public DependabotPullRequestBranchName? PullRequestBranchName { get; init; }

Property Value

DependabotPullRequestBranchName

RebaseStrategy

Disable automatic rebasing.

public RebaseStrategy? RebaseStrategy { get; init; }

Property Value

RebaseStrategy?

Registries

Registries to use for this update configuration. Can be a list of registry names or "*" for all.

public DependabotRegistries? Registries { get; init; }

Property Value

DependabotRegistries

Schedule

Schedule preferences.

public DependabotSchedule? Schedule { get; init; }

Property Value

DependabotSchedule

TargetBranch

Specify a different branch for manifest files and for pull requests.

public string? TargetBranch { get; init; }

Property Value

string

Vendor

Tell Dependabot to vendor dependencies when updating them.

public bool? Vendor { get; init; }

Property Value

bool?

VersioningStrategy

How to update manifest version requirements.

public VersioningStrategy? VersioningStrategy { get; init; }

Property Value

VersioningStrategy?