lint

Documentation

Overview

Package lint contains functions for verifying zarf yaml files are valid

Package lint contains functions for verifying zarf yaml files are valid

Index

• Variables
• func GroupFindingsByPath(findings []types.PackageFinding, severity types.Severity, packageName string) map[string][]types.PackageFinding
• func HasSeverity(findings []types.PackageFinding, severity types.Severity) bool
• func Validate(ctx context.Context, pkg types.ZarfPackage, createOpts types.ZarfCreateOptions) ([]types.PackageFinding, error)

Variables

var ZarfSchema fs.ReadFileFS

ZarfSchema is exported so main.go can embed the schema file

Functions

func GroupFindingsByPath

func GroupFindingsByPath(findings []types.PackageFinding, severity types.Severity, packageName string) map[string][]types.PackageFinding

GroupFindingsByPath groups findings by their package path

func HasSeverity

func HasSeverity(findings []types.PackageFinding, severity types.Severity) bool

HasSeverity returns true if the findings contain a severity equal to or greater than the given severity

func Validate

func Validate(ctx context.Context, pkg types.ZarfPackage, createOpts types.ZarfCreateOptions) ([]types.PackageFinding, error)

Validate the given Zarf package. The Zarf package should not already be composed when sent to this function.