hack

Documentation

Index

• Variables
• type Boilerplate
  • func (f *Boilerplate) SetTemplateDefaults() error
  • func (f Boilerplate) Validate() error

Variables

var DefaultBoilerplatePath = filepath.Join("hack", "boilerplate.go.txt")

DefaultBoilerplatePath is the default path to the boilerplate file

Types

type Boilerplate

type Boilerplate struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin

	// License is the License type to write
	License string

	// Licenses maps License types to their actual string
	Licenses map[string]string

	// Owner is the copyright owner - e.g. "The Kubernetes Authors"
	Owner string

	// Year is the copyright year
	Year string
}

Boilerplate scaffolds a file that defines the common header for the rest of the files

func (*Boilerplate) SetTemplateDefaults

func (f *Boilerplate) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template

func (Boilerplate) Validate

func (f Boilerplate) Validate() error

Validate implements file.RequiresValidation