config

Documentation

Index

• Variables
• type Branches
• type Config
  • func New(project Project, log log.Logger, informer git.RemoteURLInformer) (Config, error)
• type Project
• type ReleaseTemplates
• type Searches
• type Tags

Variables

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")
)

Types

type Branches

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

Branches holds configuration for branches.

type Config

type Config struct {
	Upstream                   string `yaml:"upstream" valid:"required"`
	Downstream                 string `yaml:"downstream" valid:"required"`
	DryRun                     bool   `yaml:"dryRun"`
	GithubWorkflowsRemovalGlob string `yaml:"githubWorkflowsRemovalGlob" valid:"required"`
	Branches                   `yaml:"branches"`
	Tags                       `yaml:"tags"`
}

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 Project

type Project struct {
	Path       string
	ConfigPath string
}

Project information.

type ReleaseTemplates

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

ReleaseTemplates contains templates for release names.

type Searches

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

Searches contains regular expressions used to search for branches.

type Tags

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

Tags holds configuration for tags.