config

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 20, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrConfigFileCantBeRead when config file cannot be read.
	ErrConfigFileCantBeRead = errors.New("config file can't be read")
	// ErrConfigFileHaveInvalidFormat when config file has invalid format.
	ErrConfigFileHaveInvalidFormat = errors.New("config file have invalid format")
)

Functions

This section is empty.

Types

type Branches

type Branches struct {
	Main             string `json:"main"             valid:"required"`
	ReleaseNext      string `json:"releaseNext"      valid:"required"`
	SynchCI          string `json:"synchCi"          valid:"required"`
	ReleaseTemplates `json:"releaseTemplates"`
	Searches         `json:"searches"`
}

Branches holds configuration for branches.

type Config

type Config struct {
	Upstream                   string               `json:"upstream"                   valid:"required"`
	Downstream                 string               `json:"downstream"                 valid:"required"`
	DryRun                     bool                 `json:"dryRun"`
	GithubWorkflowsRemovalGlob string               `json:"githubWorkflowsRemovalGlob" valid:"required"`
	SyncLabels                 []string             `json:"syncLabels"                 valid:"required"`
	DockerfileGen              dockerfilegen.Params `json:"dockerfileGen"`
	ResyncReleases             `json:"resyncReleases"`
	Branches                   `json:"branches"`
	Tags                       `json:"tags"`
	Messages                   `json:"messages"`
}

Config for a deviate to operate.

func New

func New(
	project Project,
	log log.Logger,
	informer git.RemoteURLInformer,
) (Config, error)

New creates a new default configuration.

type Messages

type Messages struct {
	TriggerCI       string `json:"triggerCi"       valid:"required"`
	TriggerCIBody   string `json:"triggerCiBody"   valid:"required"`
	ApplyForkFiles  string `json:"applyForkFiles"  valid:"required"`
	ImagesGenerated string `json:"imagesGenerated" valid:"required"`
}

Messages holds messages that are used to commit changes and create PRs.

type Project

type Project struct {
	Path       string
	ConfigPath string
}

Project information.

type ReleaseTemplates

type ReleaseTemplates struct {
	Upstream   string `json:"upstream"   valid:"required"`
	Downstream string `json:"downstream" valid:"required"`
}

ReleaseTemplates contains templates for release names.

type ResyncReleases

type ResyncReleases struct {
	Enabled  bool `json:"enabled"`
	NumberOf int  `json:"numberOf"`
}

ResyncReleases holds configuration for resyncing past releases.

type Searches

type Searches struct {
	UpstreamReleases   string `json:"upstreamReleases"   valid:"required"`
	DownstreamReleases string `json:"downstreamReleases" valid:"required"`
}

Searches contains regular expressions used to search for branches.

type Tags

type Tags struct {
	Synchronize bool   `json:"synchronize"`
	RefSpec     string `json:"refSpec"     valid:"required"`
}

Tags holds configuration for tags.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL