helmignore

Documentation

Index

• Constants
• type Rules
  • func Empty() *Rules
  • func Parse(file io.Reader) (*Rules, error)
  • func ParseFile(file string) (*Rules, error)
  • func (r *Rules) AddDefaults()
  • func (r *Rules) Ignore(path string, fi os.FileInfo) bool
  • func (r *Rules) Len() int

Constants

const HelmIgnore = ".helmignore"

HelmIgnore default name of an ignorefile.

Types

type Rules

type Rules struct {
	// contains filtered or unexported fields
}

Rules is a collection of path matching rules.

Parse() and ParseFile() will construct and populate new Rules. Empty() will create an immutable empty ruleset.

func Empty

func Empty() *Rules

Empty builds an empty ruleset.

func Parse

func Parse(file io.Reader) (*Rules, error)

Parse parses a rules file

func ParseFile

func ParseFile(file string) (*Rules, error)

ParseFile parses a helmignore file and returns the *Rules.

func (*Rules) AddDefaults

func (r *Rules) AddDefaults()

AddDefaults adds default ignore patterns.

Ignore all dotfiles in "templates/"

func (*Rules) Ignore

func (r *Rules) Ignore(path string, fi os.FileInfo) bool

Ignore evaluates the file at the given path, and returns true if it should be ignored.

Ignore evaluates path against the rules in order. Evaluation stops when a match is found. Matching a negative rule will stop evaluation.

func (*Rules) Len

func (r *Rules) Len() int

Len returns the number of patterns in this rule set.