lib

Documentation

Index

• Variables
• func Clone(url string, targetDir string, _refName string, _progress bool) (r *git.Repository)
• func ExecuteStep(commands []string, workingDirectory string)
• func Pull(targetDir string, _progress bool) (err error)
• func ReadFile(path string) []byte
• func Run(progress bool, target string, handleError bool, commands ...string) (bytes.Buffer, bytes.Buffer)
• type DependencyConfig
• type ProductConfig
  • func GetProductConfig(configFile string) ProductConfig
• type Step
• type StepConfiguration

Variables

var Catchy = color.New(color.Bold, color.FgCyan).PrintfFunc()

Catchy : bold and cyan text

var Error = color.New(color.Bold, color.FgRed).PrintfFunc()

Error : bold and red text

var Notice = color.New(color.Bold, color.FgBlue).PrintfFunc()

Notice : bold and blue text

var Warning = color.New(color.FgYellow).PrintfFunc()

Warning : yellow text

Functions

func Clone

func Clone(url string, targetDir string, _refName string, _progress bool) (r *git.Repository)

Clone : Clones a given repository into targetDir

func ExecuteStep

func ExecuteStep(commands []string, workingDirectory string)

ExecuteStep : executes all commands of a single step

func Pull

func Pull(targetDir string, _progress bool) (err error)

Pull : Pulls a given repository

func ReadFile

func ReadFile(path string) []byte

ReadFile : reads a file from a given path and returns its contents

func Run

func Run(progress bool, target string, handleError bool, commands ...string) (bytes.Buffer, bytes.Buffer)

Run : executes a process with the given parameters

Types

type DependencyConfig

type DependencyConfig struct {
	Version    string
	Repository string
	Artifacts  string
}

DependencyConfig : config for dependency

type ProductConfig

type ProductConfig struct {
	Name         string
	Version      string
	Description  string
	Dependencies map[string]*DependencyConfig
	Steps        Step
}

ProductConfig : config for product

func GetProductConfig

func GetProductConfig(configFile string) ProductConfig

GetProductConfig : receives a bytestring and returns a ProductConfig

type Step

type Step struct {
	Setup        StepConfiguration
	Update       StepConfiguration
	Dependencies StepConfiguration
}

Step : a step is a command of hantera for which additional commands/functionality can be configured

type StepConfiguration

type StepConfiguration struct {
	Pre      []string
	Override []string
	Post     []string
}

StepConfiguration : contains information about pre/post/override commands for a step