core

Documentation

Index

• Variables
• type AutoRenderWorkflowConfig
• type BinaryConfiguration
• type CIWorkflowConfig
• type Configuration
  • func (c *Configuration) Validate() error
  • func (c Configuration) Variable(name, defaultValue string) string
• type CoverageConfiguration
• type GithubWorkflowConfiguration
• type GolangciLintConfiguration
• type LicenseWorkflowConfig
• type RenovateConfig
• type SecurityChecksWorkflowConfig
• type SpellCheckConfiguration
• type SpellCheckWorkflowConfig
• type VendoringConfiguration

Variables

var AutogeneratedHeader = strings.TrimSpace(`
################################################################################
# This file is AUTOGENERATED with <https://github.com/SuperSandro2000/go-makefile-maker> #
# Edit Makefile.maker.yaml instead.                                            #
################################################################################
`)

Types

type AutoRenderWorkflowConfig

type AutoRenderWorkflowConfig struct {
	Enabled bool `yaml:"enabled"`
}

AutoRenderWorkflowConfig appears in type Configuration.

type BinaryConfiguration

type BinaryConfiguration struct {
	Name        string `yaml:"name"`
	FromPackage string `yaml:"fromPackage"`
	InstallTo   string `yaml:"installTo"`
}

BinaryConfiguration appears in type Configuration.

type CIWorkflowConfig

type CIWorkflowConfig struct {
	Enabled      bool     `yaml:"enabled"`
	RunnerOSList []string `yaml:"runOn"`
	Coveralls    bool     `yaml:"coveralls"`
	Postgres     struct {
		Enabled bool   `yaml:"enabled"`
		Version string `yaml:"version"`
	} `yaml:"postgres"`
	// contains filtered or unexported fields
}

CIWorkflowConfig appears in type Configuration.

type Configuration

type Configuration struct {
	Verbatim       string                       `yaml:"verbatim"`
	VariableValues map[string]string            `yaml:"variables"`
	Binaries       []BinaryConfiguration        `yaml:"binaries"`
	Coverage       CoverageConfiguration        `yaml:"coverageTest"`
	Vendoring      VendoringConfiguration       `yaml:"vendoring"`
	GolangciLint   GolangciLintConfiguration    `yaml:"golangciLint"`
	SpellCheck     SpellCheckConfiguration      `yaml:"spellCheck"`
	GitHubWorkflow *GithubWorkflowConfiguration `yaml:"githubWorkflow"`
	Renovate       RenovateConfig               `yaml:"renovate"`
}

Configuration is the data structure that we read from the input file.

func (*Configuration) Validate

func (c *Configuration) Validate() error

func (Configuration) Variable

func (c Configuration) Variable(name, defaultValue string) string

Variable returns the value of this variable if it's overridden in the config, or the default value otherwise.

type CoverageConfiguration

type CoverageConfiguration struct {
	Only   string `yaml:"only"`
	Except string `yaml:"except"`
}

CoverageConfiguration appears in type Configuration.

type GithubWorkflowConfiguration

type GithubWorkflowConfiguration struct {
	// These global-level settings are applicable for all workflows. They are
	// superseded by their workflow-level counterpart(s).
	Global struct {
		Assignees     []string `yaml:"assignees"`
		DefaultBranch string   `yaml:"defaultBranch"`
		GoVersion     string   `yaml:"goVersion"`
		// contains filtered or unexported fields
	} `yaml:"global"`

	CI             CIWorkflowConfig             `yaml:"ci"`
	License        LicenseWorkflowConfig        `yaml:"license"`
	SpellCheck     SpellCheckWorkflowConfig     `yaml:"spellCheck"`
	SecurityChecks SecurityChecksWorkflowConfig `yaml:"securityChecks"`
	AutoRender     AutoRenderWorkflowConfig     `yaml:"autoRender"`
}

GithubWorkflowConfiguration appears in type Configuration.

type GolangciLintConfiguration

type GolangciLintConfiguration struct {
	CreateConfig     bool     `yaml:"createConfig"`
	ErrcheckExcludes []string `yaml:"errcheckExcludes"`
}

GolangciLintConfiguration appears in type Configuration.

type LicenseWorkflowConfig

type LicenseWorkflowConfig struct {
	Enabled  bool     `yaml:"enabled"`
	Patterns []string `yaml:"patterns"`
	// contains filtered or unexported fields
}

LicenseWorkflowConfig appears in type Configuration.

type RenovateConfig

type RenovateConfig struct {
	Enabled   bool   `yaml:"enabled"`
	GoVersion string `yaml:"goVersion"`
}

RenovateConfig appears in type Configuration.

type SecurityChecksWorkflowConfig

type SecurityChecksWorkflowConfig struct {
	Enabled bool `yaml:"enabled"`
}

SecurityChecksWorkflowConfig appears in type Configuration.

type SpellCheckConfiguration

type SpellCheckConfiguration struct {
	IgnoreWords []string `yaml:"ignoreWords"`
}

SpellCheckConfiguration appears in type Configuration.

type SpellCheckWorkflowConfig

type SpellCheckWorkflowConfig struct {
	Enabled bool `yaml:"enabled"`
	// contains filtered or unexported fields
}

SpellCheckWorkflowConfig appears in type Configuration.

type VendoringConfiguration

type VendoringConfiguration struct {
	Enabled bool `yaml:"enabled"`
}

VendoringConfiguration appears in type Configuration.