setting

Documentation

Index

• Constants
• func BootstrapPhlowConfig(local, integrationBranch string) error
• func GetDefaultBranchFromInternalDefault() (string, error)
• func NewConfigError(field, block string) error
• func ValidateLoadedSetting(setting *ProjectSetting) error
• type ConfigError
  • func (ce *ConfigError) Error() string
• type ProjectSetting
  • func LoadSettings(INIBlock string, git githandler.Git) *ProjectSetting
  • func NewProjectStg(INIBlock string) *ProjectSetting
  • func (setting *ProjectSetting) ToString() string

Constants

const (
	InternalDefaultService              = "github"
	InternalDefaultIntegrationBranch    = "master"
	InternalDefaultRemote               = "origin"
	InternalDefaultApi                  = "https://api.github.com"
	InternalDefaultWeb                  = "https://github.com"
	InternalDefaultDeliveryBranchPrefix = "ready"
	InternalDefaultScope                = "internal"
	InternalDefaultOrigin               = "none"
)

Default configuration

Functions

func BootstrapPhlowConfig

func BootstrapPhlowConfig(local, integrationBranch string) error

BootstrapPhlowConfig ... Creates a new .phlow ini file on given location

func GetDefaultBranchFromInternalDefault

func GetDefaultBranchFromInternalDefault() (string, error)

GetDefaultBranchFromInternalDefault ... Trying to retrieve the default branch from github

func NewConfigError

func NewConfigError(field, block string) error

NewConfigError ... Create a new configuration error

func ValidateLoadedSetting

func ValidateLoadedSetting(setting *ProjectSetting) error

ValidateLoadedSetting ... checks if all required fields have been set

Types

type ConfigError

type ConfigError struct {
	// contains filtered or unexported fields
}

ConfigError ... Error type for settings

func (*ConfigError) Error

func (ce *ConfigError) Error() string

Error ... error message generated for config

type ProjectSetting

type ProjectSetting struct {
	Service              string `ini:"service"`
	IntegrationBranch    string `ini:"integration-branch"`
	Remote               string `ini:"remote"`
	IssueApi             string `ini:"issue-api"`
	IssueWeb             string `ini:"issue-web"`
	PipelineUrl          string `ini:"pipeline"`
	DeliveryBranchPrefix string `ini:"delivery-branch-prefix"`
	Scope                string
	INIBlock             string
}

ProjectSetting ...

func LoadSettings

func LoadSettings(INIBlock string, git githandler.Git) *ProjectSetting

LoadSettings ... Loads a new setting

func NewProjectStg

func NewProjectStg(INIBlock string) *ProjectSetting

NewProjectStg ... initializes project settings from .phlow INI files

func (*ProjectSetting) ToString

func (setting *ProjectSetting) ToString() string

ToString ... String representation of struct