Documentation
¶
Overview ¶
Package lint contains functions for verifying zarf yaml files are valid
Package lint contains functions for verifying zarf yaml files are valid ¶
Package lint contains functions for verifying zarf yaml files are valid
Index ¶
- Constants
- type LintError
- type PackageFinding
- func CheckComponentValues(c v1alpha1.ZarfComponent, i int) []PackageFinding
- func ValidateComponentConfigSchemaBytesV1Beta1(b []byte) ([]PackageFinding, error)
- func ValidatePackageSchemaAtPath(path string, setVariables map[string]string) ([]PackageFinding, error)
- func ValidatePackageSchemaBytesV1Alpha1(b []byte, setVariables map[string]string) ([]PackageFinding, error)
- func ValidatePackageSchemaBytesV1Beta1(b []byte) ([]PackageFinding, error)
- type Severity
Constants ¶
const ( SevErr = "Error" SevWarn = "Warning" )
Severity definitions.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LintError ¶ added in v0.39.0
type LintError struct {
PackageName string
Findings []PackageFinding
}
LintError represents an error containing lint findings.
func (*LintError) OnlyWarnings ¶ added in v0.39.0
OnlyWarnings returns true if all findings have severity warning.
type PackageFinding ¶
type PackageFinding struct {
// YqPath is the path to the key where the error originated from, this is sometimes empty in the case of a general error
YqPath string
Description string
// Item is the value of a key that is causing an error, for example a bad image name
Item string
// Severity of finding.
Severity Severity
}
PackageFinding is a struct that contains a finding about something wrong with a package
func CheckComponentValues ¶
func CheckComponentValues(c v1alpha1.ZarfComponent, i int) []PackageFinding
CheckComponentValues runs lint rules validating values on component keys, should be run after templating
func ValidateComponentConfigSchemaBytesV1Beta1 ¶ added in v0.84.0
func ValidateComponentConfigSchemaBytesV1Beta1(b []byte) ([]PackageFinding, error)
ValidateComponentConfigSchemaBytesV1Beta1 checks a v1beta1 Zarf component config against the v1beta1 component schema.
func ValidatePackageSchemaAtPath ¶ added in v0.42.0
func ValidatePackageSchemaAtPath(path string, setVariables map[string]string) ([]PackageFinding, error)
ValidatePackageSchemaAtPath checks the Zarf package against the Zarf schema If path is a directory, it will look for layout.ZarfYAML within it. If path is a file, it will use that file directly.
func ValidatePackageSchemaBytesV1Alpha1 ¶ added in v0.84.0
func ValidatePackageSchemaBytesV1Alpha1(b []byte, setVariables map[string]string) ([]PackageFinding, error)
ValidatePackageSchemaBytesV1Alpha1 checks v1alpha1 Zarf package bytes against the v1alpha1 package schema.
func ValidatePackageSchemaBytesV1Beta1 ¶ added in v0.84.0
func ValidatePackageSchemaBytesV1Beta1(b []byte) ([]PackageFinding, error)
ValidatePackageSchemaBytesV1Beta1 checks v1beta1 Zarf package bytes against the v1beta1 package schema.
func (PackageFinding) ItemizedDescription ¶ added in v0.39.0
func (f PackageFinding) ItemizedDescription() string
ItemizedDescription returns a string with the description and item if finding contains one.
Source Files