packages

Documentation

Index

• Constants
• Variables
• func IsManifestFile(path string) bool
• func IsManifestLockFile(path string) bool
• func IsTemplateFile(path string) bool
• func IsYAMLFile(path string) bool
• func NewInvalidAggregate(errorList ...error) error
• func StripTemplateSuffix(path string) string
• type InvalidError
  • func NewInvalidError(violations ...Violation) *InvalidError
  • func (e *InvalidError) Error() string
• type Violation
  • func (v Violation) String() string
• type ViolationLocation
  • func (l *ViolationLocation) String() string

Constants

const (
	ViolationReasonPackageManifestNotFound       = "PackageManifest not found"
	ViolationReasonPackageManifestUnknownGVK     = "PackageManifest unknown GVK"
	ViolationReasonPackageManifestConversion     = "PackageManifest conversion"
	ViolationReasonPackageManifestInvalid        = "PackageManifest invalid"
	ViolationReasonPackageManifestDuplicated     = "PackageManifest present multiple times"
	ViolationReasonPackageManifestLockUnknownGVK = "PackageManifestLock unknown GVK"
	ViolationReasonPackageManifestLockConversion = "PackageManifestLock conversion"
	ViolationReasonPackageManifestLockInvalid    = "PackageManifestLock invalid"
	ViolationReasonPackageManifestLockDuplicated = "PackageManifestLock present multiple times"
	ViolationReasonInvalidYAML                   = "Invalid YAML"
	ViolationReasonMissingPhaseAnnotation        = "Missing " + manifestsv1alpha1.PackagePhaseAnnotation + " Annotation"
	ViolationReasonMissingGVK                    = "GroupVersionKind not set"
	ViolationDuplicateObject                     = "Duplicate Object"
	ViolationReasonLabelsInvalid                 = "Labels invalid"
	ViolationReasonUnsupportedScope              = "Package unsupported scope"
	ViolationReasonFixtureMismatch               = "File mismatch against fixture"
)

const (
	// Default location for the PackageManifest file.
	PackageManifestFile = "manifest.yaml"

	// Default location for the PackageManifestLock file.
	PackageManifestLockFile = "manifest.lock.yaml"

	// Files suffix for all go template files that need pre-processing.
	// .gotmpl is the suffix that is being used by the go language server gopls.
	// https://go-review.googlesource.com/c/tools/+/363360/7/gopls/doc/features.md#29
	TemplateFileSuffix = ".gotmpl"

	// ImageFilePrefixPath defines under which subfolder files within a package container should be located.
	ImageFilePrefixPath = "package"
)

Variables

var (
	// PackageManifestFileNames to probe for.
	PackageManifestFileNames = []string{"manifest.yaml", "manifest.yml"}
	PackageManifestGroupKind = schema.GroupKind{Group: manifestsv1alpha1.GroupVersion.Group, Kind: "PackageManifest"}

	PackageManifestLockFileNames = []string{"manifest.lock.yaml"}
	PackageManifestLockGroupKind = schema.GroupKind{Group: manifestsv1alpha1.GroupVersion.Group, Kind: "PackageManifestLock"}
)

Functions

func IsManifestFile

func IsManifestFile(path string) bool

Is the it the manifest file.

func IsManifestLockFile

func IsManifestLockFile(path string) bool

Is the it the manifest file.

func IsTemplateFile

func IsTemplateFile(path string) bool

Is path suffixed by .gotmpl.

func IsYAMLFile

func IsYAMLFile(path string) bool

Is path suffixed by .yml or .yaml.

func NewInvalidAggregate

func NewInvalidAggregate(errorList ...error) error

func StripTemplateSuffix

func StripTemplateSuffix(path string) string

StripTemplateSuffix removes a .gotmpl suffix from a string if present.

Types

type InvalidError

type InvalidError struct {
	Violations []Violation
}

func NewInvalidError

func NewInvalidError(violations ...Violation) *InvalidError

func (*InvalidError) Error

func (e *InvalidError) Error() string

type Violation

type Violation struct {
	Reason  string
	Details string

	Location *ViolationLocation
}

func (Violation) String

func (v Violation) String() string

type ViolationLocation

type ViolationLocation struct {
	Path          string
	DocumentIndex *int
}

func (*ViolationLocation) String

func (l *ViolationLocation) String() string