config

Documentation

Index

• Variables
• func ConvertFileToCRLF(filePath string) error
• func GetDebug() bool
• func InitConfig() error
• type Config
  • func (c *Config) Validate() error
• type EnvVarError
  • func (e *EnvVarError) Error() string
• type ExpansionError
  • func (e *ExpansionError) Error() string

Variables

var (
	CRLF = []byte{13, 10}
	LF   = []byte{10}
)

Functions

func ConvertFileToCRLF

func ConvertFileToCRLF(filePath string) error

ConvertFileToCRLF converts line endings in a file to CRLF.

func GetDebug

func GetDebug() bool

func InitConfig

func InitConfig() error

InitConfig will initialize the configuration from environment variables. This will set 'SlackConfig' to the loaded configuration.

Types

type Config

type Config struct {
	// Required configuration
	AccessToken string
	Channels    string

	// Trigger matching
	BranchPattern      string
	TagPattern         string
	EventToSendMessage string
	JobBranch          string
	JobStatus          string
	JobTag             string

	// Flags
	Debug        bool
	IgnoreErrors string
	InvertMatch  string

	// Message template
	TemplateInline string
	TemplateName   string
	TemplatePath   string
	TemplateVar    string

	// Overridable for testing
	SlackAPIBaseUrl string
}

Config represents the configuration loaded from environment variables.

var SlackConfig Config

func (*Config) Validate

func (c *Config) Validate() error

Validate checks whether the necessary environment variables are set.

type EnvVarError

type EnvVarError struct {
	VarName string
}

func (*EnvVarError) Error

func (e *EnvVarError) Error() string

type ExpansionError

type ExpansionError struct {
	FieldName string
	Err       error
}

func (*ExpansionError) Error

func (e *ExpansionError) Error() string