config

Documentation

Index

• Variables
• type Config
  • func New() *Config
  • func (c *Config) Accepptable(r *report.Report) error
  • func (c *Config) BadgeConfigReady() bool
  • func (c *Config) Build()
  • func (c *Config) BuildCentralConfig() error
  • func (c *Config) BuildDatastoreConfig() error
  • func (c *Config) CentralConfigReady() bool
  • func (c *Config) CoverageColor(cover float64) string
  • func (c *Config) DatastoreConfigReady() bool
  • func (c *Config) Getwd() string
  • func (c *Config) Load(path string) error
  • func (c *Config) Loaded() bool
  • func (c *Config) Root() string
  • func (c *Config) Setwd(path string)
• type ConfigCentral
• type ConfigCoverage
• type ConfigCoverageBadge
• type ConfigDatastore
• type ConfigDatastoreGithub

Variables

var DefaultConfigFilePaths = []string{".octocov.yml", "octocov.yml"}

Types

type Config

type Config struct {
	Repository string          `yaml:"repository"`
	Coverage   *ConfigCoverage `yaml:"coverage"`
	// CodeToTestRatio *ConfigCodeToTestRatio `yaml:"codeToTestRatio,omitempty"`
	Datastore *ConfigDatastore `yaml:"datastore,omitempty"`
	Central   *ConfigCentral   `yaml:"central,omitempty"`
	// contains filtered or unexported fields
}

func New

func New() *Config

func (*Config) Accepptable

func (c *Config) Accepptable(r *report.Report) error

func (*Config) BadgeConfigReady

func (c *Config) BadgeConfigReady() bool

func (*Config) Build

func (c *Config) Build()

func (*Config) BuildCentralConfig

func (c *Config) BuildCentralConfig() error

func (*Config) BuildDatastoreConfig

func (c *Config) BuildDatastoreConfig() error

func (*Config) CentralConfigReady

func (c *Config) CentralConfigReady() bool

func (*Config) CoverageColor

func (c *Config) CoverageColor(cover float64) string

func (*Config) DatastoreConfigReady

func (c *Config) DatastoreConfigReady() bool

func (*Config) Getwd

func (c *Config) Getwd() string

func (*Config) Load

func (c *Config) Load(path string) error

func (*Config) Loaded

func (c *Config) Loaded() bool

func (*Config) Root

func (c *Config) Root() string

func (*Config) Setwd

func (c *Config) Setwd(path string)

type ConfigCentral

type ConfigCentral struct {
	Enable  bool   `yaml:"enable"`
	Reports string `yaml:"reports"`
	Badges  string `yaml:"badges"`
	Root    string `yaml:"root"`
}

type ConfigCoverage

type ConfigCoverage struct {
	Path       string              `yaml:"path,omitempty"`
	Badge      ConfigCoverageBadge `yaml:"badge,omitempty"`
	Acceptable string              `yaml:"acceptable,omitempty"`
}

type ConfigCoverageBadge

type ConfigCoverageBadge struct {
	Path string `yaml:"path,omitempty"`
}

type ConfigDatastore

type ConfigDatastore struct {
	If     string                 `yaml:"if,omitempty"`
	Github *ConfigDatastoreGithub `yaml:"github,omitempty"`
}

type ConfigDatastoreGithub

type ConfigDatastoreGithub struct {
	Repository string `yaml:"repository"`
	Branch     string `yaml:"branch"`
	Path       string `yaml:"path"`
}