dependabot

Documentation

Index

• Constants
• type CommitMessage
• type Day
• type Dependabot
• type Dependency
• type DependencyType
• type Include
• type Interval
• type PackageEcosystem
• type PullRequestBranchName
• type RebaseStrategy
• type Schedule
• type Separator
• type Update
• type VersioningStrategy

Constants

const Version = 2

Types

type CommitMessage

type CommitMessage struct {
	Prefix            string  `yaml:",omitempty"`
	PrefixDevelopment string  `yaml:"prefix-development,omitempty"`
	Include           Include `yaml:",omitempty"`
}

type Day

type Day string

const (
	Monday    Day = "monday"
	Tuesday   Day = "tuesday"
	Wednesday Day = "wednesday"
	Thursday  Day = "thursday"
	Friday    Day = "friday"
	Saturday  Day = "saturday"
	Sunday    Day = "sunday"
)

type Dependabot

type Dependabot struct {
	Version int      `yaml:",omitempty"`
	Updates []Update `yaml:",omitempty"`
}

type Dependency

type Dependency struct {
	Name string         `yaml:"dependency-name,omitempty"`
	Type DependencyType `yaml:"dependency-type,omitempty"`
}

type DependencyType

type DependencyType string

const (
	DirectDependencyType      DependencyType = "direct"
	IndirectDependencyType    DependencyType = "indirect"
	AllDependencyType         DependencyType = "all"
	ProductionDependencyType  DependencyType = "production"
	DevelopmentDependencyType DependencyType = "development"
)

type Include

type Include string

const (
	ScopeInclude Include = "scope"
)

type Interval

type Interval string

const (
	DailyInterval   Interval = "daily"
	WeeklyInterval  Interval = "weekly"
	MonthlyInterval Interval = "monthly"
)

type PackageEcosystem

type PackageEcosystem string

const (
	BundlerPackageEcosystem       PackageEcosystem = "bundler"
	CargoPackageEcosystem         PackageEcosystem = "cargo"
	ComposerPackageEcosystem      PackageEcosystem = "composer"
	DockerPackageEcosystem        PackageEcosystem = "docker"
	ElmPackageEcosystem           PackageEcosystem = "elm"
	GitSubmodulePackageEcosystem  PackageEcosystem = "gitsubmodule"
	GitHubActionsPackageEcosystem PackageEcosystem = "github-actions"
	GoModulesPackageEcosystem     PackageEcosystem = "gomod"
	GradlePackageEcosystem        PackageEcosystem = "gradle"
	MavenPackageEcosystem         PackageEcosystem = "maven"
	MixPackageEcosystem           PackageEcosystem = "mix"
	NPMPackageEcosystem           PackageEcosystem = "npm"
	NuGetPackageEcosystem         PackageEcosystem = "nuget"
	PipPackageEcosystem           PackageEcosystem = "pip"
	TerraformPackageEcosystem     PackageEcosystem = "terraform"
)

type PullRequestBranchName

type PullRequestBranchName struct {
	Separator Separator `yaml:",omitempty"`
}

type RebaseStrategy

type RebaseStrategy string

const (
	DisabledRebaseStrategy RebaseStrategy = "disabled"
	AutoRebaseStrategy     RebaseStrategy = "auto"
)

type Schedule

type Schedule struct {
	Interval Interval `yaml:",omitempty"`
	Day      Day      `yaml:",omitempty"`
	Time     string   `yaml:",omitempty"`
	Timezone string   `yaml:",omitempty"`
}

type Separator

type Separator string

const (
	HyphenSeparator     Separator = "-"
	UnderscoreSeparator Separator = "_"
	SlashSeparator      Separator = "/"
)

type Update

type Update struct {
	PackageEcosystem      PackageEcosystem      `yaml:"package-ecosystem,omitempty"`
	Directory             string                `yaml:",omitempty"`
	Schedule              Schedule              `yaml:",omitempty"`
	Allow                 []Dependency          `yaml:",omitempty"`
	Assignees             []string              `yaml:",omitempty"`
	CommitMessage         CommitMessage         `yaml:"commit-message,omitempty"`
	Ignore                []Dependency          `yaml:",omitempty"`
	Labels                []string              `yaml:",omitempty"`
	Milestone             int                   `yaml:",omitempty"`
	OpenPullRequestsLimit int                   `yaml:"open-pull-requests-limit,omitempty"`
	PullRequestBranchName PullRequestBranchName `yaml:"pull-request-branch-name,omitempty"`
	RebaseStrategy        RebaseStrategy        `yaml:"rebase-strategy,omitempty"`
	Reviewers             []string              `yaml:",omitempty"`
	TargetBranch          string                `yaml:"target-branch,omitempty"`
	VersioningStrategy    VersioningStrategy    `yaml:"versioning-strategy,omitempty"`
}

type VersioningStrategy

type VersioningStrategy string

const (
	LockfileOnlyVersioningStrategy        VersioningStrategy = "lockfile-only"
	AutoVersioningStrategy                VersioningStrategy = "auto"
	WidenVersioningStrategy               VersioningStrategy = "widen"
	IncreaseVersioningStrategy            VersioningStrategy = "increase"
	IncreaseIfNecessaryVersioningStrategy VersioningStrategy = "increase-if-necessary"
)