render

Documentation

Index

• Constants
• func Exists(path string) bool
• func Walk(fs billy.Filesystem, root string, walkFn filepath.WalkFunc) error
• type Artifact
  • func GetArtifact(outPath string) (*Artifact, error)
• type File
  • func (file *File) Write(outPath string, overwrite bool) error
• type Files
  • func (files Files) WriteAll(outPath string, overwrite bool) error
• type InputMode
• type Root
• type Template
  • func (t Template) GetArgsValues(args blueprint.Args, inputMode InputMode, valuesData *values.ValuesData, ...) (values.ArgsValues, error)
  • func (t *Template) GetRoots(blueprint *blueprint.Blueprint) []string
  • func (t *Template) LoadBlueprint() (*blueprint.Blueprint, error)
  • func (t *Template) Render(inputMode InputMode, valuesData *values.ValuesData, ...) (Files, error)

Constants

const ArtifactFilename = ".rendr.yaml"

Functions

func Exists

func Exists(path string) bool

func Walk

func Walk(fs billy.Filesystem, root string, walkFn filepath.WalkFunc) error

Walk walks the file tree rooted at root, calling fn for each file or directory in the tree, including root. All errors that arise visiting files and directories are filtered by fn: see the WalkFunc documentation for details.

The files are walked in lexical order, which makes the output deterministic but requires Walk to read an entire directory into memory before proceeding to walk that directory. Walk does not follow symbolic links.

Function adapted from https://github.com/golang/go/blob/3b770f2ccb1fa6fecc22ea822a19447b10b70c5c/src/path/filepath/path.go#L500

Types

type Artifact

type Artifact struct {
	BuildCommand string `yaml:"build"`
}

func GetArtifact

func GetArtifact(outPath string) (*Artifact, error)

type File

type File struct {
	Path       string
	Content    string
	Executable bool
	Template   bool
}

func (*File) Write

func (file *File) Write(outPath string, overwrite bool) error

type Files

type Files []File

func (Files) WriteAll

func (files Files) WriteAll(outPath string, overwrite bool) error

type InputMode

type InputMode string

const (
	RegularInputMode InputMode = "regular"
	NoInputMode      InputMode = "no"
	ForceInputMode   InputMode = "force"
)

type Root

type Root struct {
	Source string
	Path   string
}

type Template

type Template struct {
	Source        string
	BlueprintPath string
	ExtraRoots    []string
}

func (Template) GetArgsValues

func (t Template) GetArgsValues(args blueprint.Args, inputMode InputMode, valuesData *values.ValuesData, overridesKeysValues []string) (values.ArgsValues, error)

func (*Template) GetRoots

func (t *Template) GetRoots(blueprint *blueprint.Blueprint) []string

func (*Template) LoadBlueprint

func (t *Template) LoadBlueprint() (*blueprint.Blueprint, error)

func (*Template) Render

func (t *Template) Render(inputMode InputMode, valuesData *values.ValuesData, overridesKeysValues []string) (Files, error)