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(r *report.Report)
  • func (c *Config) BuildDatastoreConfig() error
  • func (c *Config) DatastoreConfigReady() bool
  • func (c *Config) Load(path string) error
• type ConfigCoverage
• 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,omitempty"`
	// CodeToTestRatio ConfigCodeToTestRatio `yaml:"codeToTestRatio,omitempty"`
	Datastore ConfigDatastore `yaml:"datastore,omitempty"`
}

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(r *report.Report)

func (*Config) BuildDatastoreConfig

func (c *Config) BuildDatastoreConfig() error

func (*Config) DatastoreConfigReady

func (c *Config) DatastoreConfigReady() bool

func (*Config) Load

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

type ConfigCoverage

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

type ConfigDatastore

type ConfigDatastore struct {
	Github ConfigDatastoreGithub `yaml:"github,omitempty"`
}

type ConfigDatastoreGithub

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