config

Documentation

Index

• Variables
• type BuildSettings
  • func NewBuildSettings() *BuildSettings
• type Config
  • func NewConfig() *Config
• type EnvVariable
  • func NewEnvVariable(key string, value string) *EnvVariable
• type UserOptions
  • func NewUserOptions() *UserOptions

Variables

var (
	// ErrOSNotSupported indicates that the given OS is not supported yet
	ErrOSNotSupported = errors.New("OS Not supported")
)

Types

type BuildSettings

type BuildSettings struct {
	// BuildDirectory represents the base build directory
	BuildDirectory string
}

BuildSettings represents the settings necessary for build environment

func NewBuildSettings

func NewBuildSettings() *BuildSettings

NewBuildSettings creates a new environment

type Config

type Config struct {
	UserOptions *UserOptions

	Settings *BuildSettings
}

Config is an abstraction of config needed by CI build environment

func NewConfig

func NewConfig() *Config

NewConfig creates a new config

type EnvVariable

type EnvVariable struct {
	Key   string
	Value string
}

EnvVariable represents a single environment variable

func NewEnvVariable

func NewEnvVariable(key string, value string) *EnvVariable

NewEnvVariable creates a new environment variable given the key and values

type UserOptions

type UserOptions struct {
	//BaseBuildDirectory represents the directory under which build happens
	BaseBuildDirectory string

	//Env represents the Environment variables as specified by the user
	Env []EnvVariable

	// RootCommands represents the list of commands as executed by root
	RootCommands []string

	// Commands represents the name of the commands as executed the BuildUser
	Commands []string

	// BaseImage represents the base docker image for building this
	BaseImage string
}

UserOptions represents the options as given by the user directly

func NewUserOptions

func NewUserOptions() *UserOptions

NewUserOptions creates a set of new UserOptions