variables

Documentation

Index

• func ValidateAndReplaceForCommands(variables map[string]string, commands []v1alpha2.Command) map[string][]string
• func ValidateAndReplaceForComponents(variables map[string]string, components []v1alpha2.Component) map[string][]string
• func ValidateAndReplaceForProjects(variables map[string]string, projects []v1alpha2.Project) map[string][]string
• func ValidateAndReplaceForStarterProjects(variables map[string]string, starterProjects []v1alpha2.StarterProject) map[string][]string
• type InvalidKeysError
  • func (e *InvalidKeysError) Error() string
• type VariableWarning
  • func ValidateAndReplaceGlobalVariable(workspaceTemplateSpec *v1alpha2.DevWorkspaceTemplateSpec) VariableWarning

Functions

func ValidateAndReplaceForCommands

func ValidateAndReplaceForCommands(variables map[string]string, commands []v1alpha2.Command) map[string][]string

ValidateAndReplaceForCommands validates the commands data for global variable references and replaces them with the variable value. Returns a map of command ids and invalid variable references if present.

func ValidateAndReplaceForComponents

func ValidateAndReplaceForComponents(variables map[string]string, components []v1alpha2.Component) map[string][]string

ValidateAndReplaceForComponents validates the components data for global variable references and replaces them with the variable value Returns a map of component names and invalid variable references if present.

func ValidateAndReplaceForProjects

func ValidateAndReplaceForProjects(variables map[string]string, projects []v1alpha2.Project) map[string][]string

ValidateAndReplaceForProjects validates the projects data for global variable references and replaces them with the variable value. Returns a map of project names and invalid variable references if present.

func ValidateAndReplaceForStarterProjects

func ValidateAndReplaceForStarterProjects(variables map[string]string, starterProjects []v1alpha2.StarterProject) map[string][]string

ValidateAndReplaceForStarterProjects validates the starter projects data for global variable references and replaces them with the variable value. Returns a map of starter project names and invalid variable references if present.

Types

type InvalidKeysError

type InvalidKeysError struct {
	Keys []string
}

InvalidKeysError returns an error for the invalid keys

func (*InvalidKeysError) Error

func (e *InvalidKeysError) Error() string

type VariableWarning

type VariableWarning struct {
	// Commands stores a map of command ids to the invalid variable references
	Commands map[string][]string

	// Components stores a map of component names to the invalid variable references
	Components map[string][]string

	// Projects stores a map of project names to the invalid variable references
	Projects map[string][]string

	// StarterProjects stores a map of starter project names to the invalid variable references
	StarterProjects map[string][]string
}

VariableWarning stores the invalid variable references for each devfile object

func ValidateAndReplaceGlobalVariable

func ValidateAndReplaceGlobalVariable(workspaceTemplateSpec *v1alpha2.DevWorkspaceTemplateSpec) VariableWarning

ValidateAndReplaceGlobalVariable validates the workspace template spec data for global variable references and replaces them with the variable value