template

Documentation

Index

• Variables
• func Render(t *FulfilledTemplate, targetPath string) error
• type Argument
• type FulfilledTemplate
• type Parameter
  • func (p Parameter) ValidateAndMap(value string) (any, error)
• type ParameterType
  • func (t ParameterType) ValidateAndMap(value string) (any, error)
• type Spec
  • func FindByName(templatesPath string, name string) (*Spec, error)
  • func List(templatesPath string) ([]Spec, error)
  • func (t *Spec) GetParameter(name string) *Parameter
  • func (t *Spec) IsValid() bool

Variables

var ImplicitParameters = []Parameter{
	{
		Name:        "name",
		Description: "application name",
		Type:        StringParamType,
		Optional:    false,
	},
	{
		Name:        "tenant",
		Description: "tenant used to deploy the application",
		Type:        StringParamType,
		Optional:    false,
	},
	{
		Name:        "working_directory",
		Description: "working directory where application is located",
		Type:        StringParamType,
		Optional:    false,
		Default:     "./",
	},
	{
		Name:        "version_prefix",
		Description: "version prefix for application",
		Type:        StringParamType,
		Optional:    false,
		Default:     "v",
	},
}

Functions

func Render

func Render(t *FulfilledTemplate, targetPath string) error

Types

type Argument

type Argument struct {
	Name  string
	Value any
}

type FulfilledTemplate

type FulfilledTemplate struct {
	Spec      *Spec
	Arguments []Argument
}

type Parameter

type Parameter struct {
	Name        string        `yaml:"name"`
	Description string        `yaml:"description"`
	Type        ParameterType `yaml:"type"`
	Default     string        `yaml:"default"`
	Optional    bool          `yaml:"optional"`
}

func (Parameter) ValidateAndMap

func (p Parameter) ValidateAndMap(value string) (any, error)

type ParameterType

type ParameterType string

var (
	StringParamType ParameterType = "string"
	IntParamType    ParameterType = "int"
)

func (ParameterType) ValidateAndMap

func (t ParameterType) ValidateAndMap(value string) (any, error)

type Spec

type Spec struct {
	Name         string      `yaml:"name"`
	Description  string      `yaml:"description"`
	SkeletonPath string      `yaml:"skeletonPath"`
	Parameters   []Parameter `yaml:"parameters"`
	// contains filtered or unexported fields
}

func FindByName

func FindByName(templatesPath string, name string) (*Spec, error)

func List

func List(templatesPath string) ([]Spec, error)

func (*Spec) GetParameter

func (t *Spec) GetParameter(name string) *Parameter

func (*Spec) IsValid

func (t *Spec) IsValid() bool