support

Documentation

Overview

Package support contains tools for linting charts.

Linting is the process of testing charts for errors or warnings regarding formatting, compilation, or standards compliance.

Index

• Constants
• type LintError
• type Linter
  • func (l *Linter) RunLinterRule(severity int, lintError LintError) bool
• type Message
  • func (m Message) String() string

Constants

const (
	// UnknownSev indicates that the severity of the error is unknown, and should not stop processing.
	UnknownSev = iota
	// InfoSev indicates information, for example missing values.yaml file
	InfoSev
	// WarningSev indicates that something does not meet code standards, but will likely function.
	WarningSev
	// ErrorSev indicates that something will not likely function.
	ErrorSev
)

Severity indicatest the severity of a Message.

Types

type LintError

type LintError interface {
	error
}

LintError describes an error encountered while linting.

type Linter

type Linter struct {
	Messages []Message
	// The highest severity of all the failing lint rules
	HighestSeverity int
	ChartDir        string
}

Linter encapsulates a linting run of a particular chart.

func (*Linter) RunLinterRule

func (l *Linter) RunLinterRule(severity int, lintError LintError) bool

RunLinterRule returns true if the validation passed

type Message

type Message struct {
	// Severity is one of the *Sev constants
	Severity int
	// Text contains the message text
	Text string
}

Message is a linting output message

func (Message) String

func (m Message) String() string

String prints a string representation of this Message.

Implements fmt.Stringer.