manifest

Documentation

Overview

Package manifest represents internal structure of a release job.

Index

• type Job
• type Manifest
  • func NewManifestFromBytes(bytes []byte) (Manifest, error)
  • func NewManifestFromPath(path string, fs boshsys.FileSystem) (Manifest, error)
• type PropertyDefinition
• type PropertyExampleDefinition
• type PropertyMappings
• type SyntaxValidator
  • func NewSyntaxValidator(manifest *Manifest) SyntaxValidator
  • func (v SyntaxValidator) Validate() error
• type TemplateNames

Types

type Job

type Job struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`

	TemplateNames TemplateNames `yaml:"templates"`

	PackageNames []string `yaml:"packages"`

	PropertyMappings PropertyMappings `yaml:"properties"`
}

type Manifest

type Manifest struct {
	Job Job
}

func NewManifestFromBytes

func NewManifestFromBytes(bytes []byte) (Manifest, error)

func NewManifestFromPath

func NewManifestFromPath(path string, fs boshsys.FileSystem) (Manifest, error)

type PropertyDefinition

type PropertyDefinition struct {
	Description string `yaml:"description"`

	// Non-raw field is populated by the validator.
	DefaultRaw interface{} `yaml:"default"`
	Default    interface{}

	// Non-raw field is populated by the validator.
	ExampleRaw interface{} `yaml:"example"`
	Example    interface{}

	Examples []PropertyExampleDefinition `yaml:"examples"`
}

type PropertyExampleDefinition

type PropertyExampleDefinition struct {
	Description string

	// Non-raw field is populated by the validator.
	ValueRaw interface{} `yaml:"value"`
	Value    interface{}
}

type PropertyMappings

type PropertyMappings map[string]PropertyDefinition

type SyntaxValidator

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

func NewSyntaxValidator

func NewSyntaxValidator(manifest *Manifest) SyntaxValidator

func (SyntaxValidator) Validate

func (v SyntaxValidator) Validate() error

type TemplateNames

type TemplateNames map[string]string