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

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 `valid:"required"`
	ReleaseNext string `valid:"required"`
	SynchCI     string `valid:"required"`
	ReleaseTemplates
	Searches
}

Branches holds configuration for branches.

type Config

type Config struct {
	Upstream                   string `valid:"required"`
	Downstream                 string `valid:"required"`
	SynchronizeTags            bool
	DryRun                     bool
	GithubWorkflowsRemovalGlob string `valid:"required"`
	Branches
}

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 `valid:"required"`
	Downstream string `valid:"required"`
}

ReleaseTemplates contains templates for release names.

type Searches

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

Searches contains regular expressions used to search for branches.