config

Documentation

Index

• Variables
• type Config
  • func New() *Config
  • func (c *Config) Acceptable(r *report.Report) error
  • func (c *Config) Build()
  • func (c *Config) BuildCentralConfig() error
  • func (c *Config) BuildDatastoreConfig() error
  • func (c *Config) CentralConfigReady() bool
  • func (c *Config) CodeToTestRatioBadgeConfigReady() bool
  • func (c *Config) CodeToTestRatioColor(ratio float64) string
  • func (c *Config) CodeToTestRatioReady() bool
  • func (c *Config) CoverageBadgeConfigReady() 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)
  • func (c *Config) TestExecutionTimeBadgeConfigReady() bool
  • func (c *Config) TestExecutionTimeColor(d time.Duration) string
• type ConfigCentral
• type ConfigCentralPush
• type ConfigCodeToTestRatio
• type ConfigCodeToTestRatioBadge
• type ConfigCoverage
• type ConfigCoverageBadge
• type ConfigDatastore
• type ConfigDatastoreGithub
• type ConfigTestExecutionTime
• type ConfigTestExecutionTimeBadge

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"`
	TestExecutionTime *ConfigTestExecutionTime `yaml:"testExecutionTime,omitempty"`
	Datastore         *ConfigDatastore         `yaml:"datastore,omitempty"`
	Central           *ConfigCentral           `yaml:"central,omitempty"`
	// contains filtered or unexported fields
}

func New

func New() *Config

func (*Config) Acceptable

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

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) CodeToTestRatioBadgeConfigReady

func (c *Config) CodeToTestRatioBadgeConfigReady() bool

func (*Config) CodeToTestRatioColor

func (c *Config) CodeToTestRatioColor(ratio float64) string

func (*Config) CodeToTestRatioReady

func (c *Config) CodeToTestRatioReady() bool

func (*Config) CoverageBadgeConfigReady

func (c *Config) CoverageBadgeConfigReady() 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)

func (*Config) TestExecutionTimeBadgeConfigReady

func (c *Config) TestExecutionTimeBadgeConfigReady() bool

func (*Config) TestExecutionTimeColor

func (c *Config) TestExecutionTimeColor(d time.Duration) string

type ConfigCentral

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

type ConfigCentralPush

type ConfigCentralPush struct {
	Enable bool   `yaml:"enable"`
	Root   string `yaml:"-"`
}

type ConfigCodeToTestRatio

type ConfigCodeToTestRatio struct {
	Code       []string                   `yaml:"code"`
	Test       []string                   `yaml:"test"`
	Badge      ConfigCodeToTestRatioBadge `yaml:"badge,omitempty"`
	Acceptable string                     `yaml:"acceptable,omitempty"`
}

type ConfigCodeToTestRatioBadge

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

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"`
}

type ConfigTestExecutionTime

type ConfigTestExecutionTime struct {
	Badge      ConfigTestExecutionTimeBadge `yaml:"badge,omitempty"`
	Acceptable string                       `yaml:"acceptable,omitempty"`
}

type ConfigTestExecutionTimeBadge

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