config

package
v0.42.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 18, 2022 License: MIT Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

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

Functions

func Generate added in v0.36.0 

func Generate(ctx context.Context, lang string, wr io.Writer) error

Types

type Config 

type Config struct {
	Repository        string                   `yaml:"repository"`
	Coverage          *ConfigCoverage          `yaml:"coverage"`
	CodeToTestRatio   *ConfigCodeToTestRatio   `yaml:"codeToTestRatio,omitempty"`
	TestExecutionTime *ConfigTestExecutionTime `yaml:"testExecutionTime,omitempty"`
	Report            *ConfigReport            `yaml:"report,omitempty"`
	Central           *ConfigCentral           `yaml:"central,omitempty"`
	Push              *ConfigPush              `yaml:"push,omitempty"`
	Comment           *ConfigComment           `yaml:"comment,omitempty"`
	Summary           *ConfigSummary           `yaml:"summary,omitempty"`
	Diff              *ConfigDiff              `yaml:"diff,omitempty"`
	GitRoot           string                   `yaml:"-"`
	// contains filtered or unexported fields
}

func New 

func New() *Config

func (*Config) Acceptable added in v0.8.0 

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

func (*Config) Build 

func (c *Config) Build()

func (*Config) CentralConfigReady added in v0.2.0 

func (c *Config) CentralConfigReady() error

func (*Config) CentralPushConfigReady added in v0.9.0 

func (c *Config) CentralPushConfigReady() error

func (*Config) CheckIf added in v0.27.0 

func (c *Config) CheckIf(cond string) (bool, error)

func (*Config) CodeToTestRatioBadgeConfigReady added in v0.6.0 

func (c *Config) CodeToTestRatioBadgeConfigReady() error

func (*Config) CodeToTestRatioColor added in v0.6.0 

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

func (*Config) CodeToTestRatioConfigReady added in v0.12.0 

func (c *Config) CodeToTestRatioConfigReady() error

func (*Config) CommentConfigReady added in v0.11.0 

func (c *Config) CommentConfigReady() error

func (*Config) CoverageBadgeConfigReady added in v0.6.0 

func (c *Config) CoverageBadgeConfigReady() error

func (*Config) CoverageColor added in v0.2.0 

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

func (*Config) CoverageConfigReady added in v0.12.0 

func (c *Config) CoverageConfigReady() error

func (*Config) DiffConfigReady added in v0.20.0 

func (c *Config) DiffConfigReady() error

func (*Config) Getwd added in v0.5.0 

func (c *Config) Getwd() string

func (*Config) Load 

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

func (*Config) Loaded added in v0.2.0 

func (c *Config) Loaded() bool

func (*Config) PushConfigReady added in v0.9.0 

func (c *Config) PushConfigReady() error

func (*Config) ReportConfigReady added in v0.14.0 

func (c *Config) ReportConfigReady() error

func (*Config) ReportConfigTargetReady added in v0.20.1 

func (c *Config) ReportConfigTargetReady() error

func (*Config) Root added in v0.2.0 

func (c *Config) Root() string

func (*Config) Setwd added in v0.5.0 

func (c *Config) Setwd(path string)

func (*Config) SummaryConfigReady added in v0.42.0 

func (c *Config) SummaryConfigReady() error

func (*Config) TestExecutionTimeBadgeConfigReady added in v0.7.0 

func (c *Config) TestExecutionTimeBadgeConfigReady() error

func (*Config) TestExecutionTimeColor added in v0.7.0 

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

func (*Config) TestExecutionTimeConfigReady added in v0.12.0 

func (c *Config) TestExecutionTimeConfigReady() error

func (*Config) UnmarshalYAML added in v0.38.0 

func (c *Config) UnmarshalYAML(data []byte) error

type ConfigCentral added in v0.2.0 

type ConfigCentral struct {
	Root    string               `yaml:"root"`
	Reports ConfigCentralReports `yaml:"reports"`
	Badges  ConfigCentralBadges  `yaml:"badges"`
	Push    *ConfigPush          `yaml:"push,omitempty"`
	If      string               `yaml:"if,omitempty"`
}

func (*ConfigCentral) UnmarshalYAML added in v0.38.0 

func (c *ConfigCentral) UnmarshalYAML(data []byte) error

type ConfigCentralBadges added in v0.27.0 

type ConfigCentralBadges struct {
	Datastores []string `yaml:"datastores"`
}

type ConfigCentralReports added in v0.14.0 

type ConfigCentralReports struct {
	Datastores []string `yaml:"datastores"`
}

type ConfigCodeToTestRatio added in v0.6.0 

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

type ConfigCodeToTestRatioBadge added in v0.6.0 

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

type ConfigComment added in v0.11.0 

type ConfigComment struct {
	HideFooterLink bool   `yaml:"hideFooterLink"`
	DeletePrevious bool   `yaml:"deletePrevious"`
	If             string `yaml:"if,omitempty"`
}

type ConfigCoverage 

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

type ConfigCoverageBadge added in v0.3.0 

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

type ConfigDiff added in v0.20.0 

type ConfigDiff struct {
	Path       string   `yaml:"path,omitempty"`
	Datastores []string `yaml:"datastores,omitempty"`
	If         string   `yaml:"if,omitempty"`
}

type ConfigPush added in v0.9.0 

type ConfigPush struct {
	If string `yaml:"if,omitempty"`
}

type ConfigReport added in v0.14.0 

type ConfigReport struct {
	If         string   `yaml:"if,omitempty"`
	Path       string   `yaml:"path,omitempty"`
	Datastores []string `yaml:"datastores,omitempty"`
}

type ConfigSummary added in v0.42.0 

type ConfigSummary struct {
	If string `yaml:"if,omitempty"`
}

type ConfigTestExecutionTime added in v0.7.0 

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

type ConfigTestExecutionTimeBadge added in v0.7.0 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.