v1

Documentation

Index

• Variables
• type AnalyzeProperties
• type CLIProperties
• type File
  • func New(data []byte) (File, error)
  • func (file File) APIKey() string
  • func (file File) Branch() string
  • func (file File) Fetcher() string
  • func (file File) JIRAProjectKey() string
  • func (file File) Link() string
  • func (file File) Modules() []module.Module
  • func (file File) Project() string
  • func (file File) ProjectURL() string
  • func (file File) Revision() string
  • func (file File) Server() string
  • func (file File) Team() string
  • func (file File) Title() string
• type ModuleProperties

Variables

var (
	ErrWrongVersion = errors.New("config file version is not 1")
)

Types

type AnalyzeProperties

type AnalyzeProperties struct {
	Modules []ModuleProperties `yaml:"modules,omitempty"`
}

type CLIProperties

type CLIProperties struct {
	// Upload configuration.
	APIKey         string `yaml:"api_key,omitempty"`
	Server         string `yaml:"server,omitempty"`
	Fetcher        string `yaml:"fetcher,omitempty"` // Defaults to custom
	Project        string `yaml:"project,omitempty"`
	Title          string `yaml:"title,omitempty"`
	Revision       string `yaml:"revision,omitempty"`
	Branch         string `yaml:"branch,omitempty"`           // Only used with custom fetcher
	ProjectURL     string `yaml:"project_url,omitempty"`      // Only used with custom fetcher
	JIRAProjectKey string `yaml:"jira_project_key,omitempty"` // Only used with custom fetcher
	Link           string `yaml:"link,omitempty"`
	Team           string `yaml:"team,omitempty"`
}

type File

type File struct {
	Version int `yaml:"version"`

	CLI     CLIProperties
	Analyze AnalyzeProperties
	// contains filtered or unexported fields
}

func New

func New(data []byte) (File, error)

func (File) APIKey

func (file File) APIKey() string

func (File) Branch

func (file File) Branch() string

func (File) Fetcher

func (file File) Fetcher() string

func (File) JIRAProjectKey

func (file File) JIRAProjectKey() string

func (File) Link

func (file File) Link() string

func (File) Modules

func (file File) Modules() []module.Module

func (File) Project

func (file File) Project() string

func (File) ProjectURL

func (file File) ProjectURL() string

func (File) Revision

func (file File) Revision() string

func (File) Server

func (file File) Server() string

func (File) Team

func (file File) Team() string

func (File) Title

func (file File) Title() string

type ModuleProperties

type ModuleProperties struct {
	Name        string                 `yaml:"name"`
	Type        string                 `yaml:"type"`
	Ignore      bool                   `yaml:"ignore,omitempty"`
	BuildTarget string                 `yaml:"target,omitempty"`
	Path        string                 `yaml:"path,omitempty"`
	Options     map[string]interface{} `yaml:"options,omitempty"`
}