config

Documentation

Index

• type Configuration
  • func Unmarshal(yamlContent []byte) Configuration
  • func UnmarshalFile(filePath string) Configuration
  • func UnmarshalString(yamlString string) Configuration
  • func (c *Configuration) Repositories() []Repository
• type Repository

Examples

• Configuration

Types

type Configuration

type Configuration struct {
	// work directory where the listed repositories are located
	WorkDir string `yaml:"workdir"`

	// the remote url prefix lets you change the protocol or use a different git server
	// - for SSL use: 'git@github.com:' (default)
	// - for HTTPS use: 'https://github.com/'
	RemoteUrlPrefix string `yaml:"remote_url_prefix"`

	// clone projects if they do not exist
	Clone bool `yaml:"clone"`

	// remove projects if they are not listed (i.e. moves them into a folder 'removed')
	Remove bool `yaml:"remove"`

	// if command output should be redirected to stdout
	Verbose bool `yaml:"verbose"`

	// list of repositories to be processes if the org is listed
	Repos map[string][]string `yaml:"repos"`
}

Example

config := UnmarshalFile(testFile)
log.Printf("%v\n", config)
log.Printf("%v\n", config.Repositories())

func Unmarshal

func Unmarshal(yamlContent []byte) Configuration

func UnmarshalFile

func UnmarshalFile(filePath string) Configuration

func UnmarshalString

func UnmarshalString(yamlString string) Configuration

func (*Configuration) Repositories

func (c *Configuration) Repositories() []Repository

type Repository

type Repository struct {
	//
	Organisation string
	//
	Name string
}