Documentation
¶
Overview ¶
Package pkgcfg loads and applies schema migrations to zarf.yaml files.
Index ¶
- Variables
- func ParseAs[T any](ctx context.Context, b []byte, d Decoder[T]) (T, error)
- func ParseMultiDoc(ctx context.Context, b []byte) (api.Package, error)
- func ParseMultiDocNative(ctx context.Context, b []byte) (any, api.Package, error)
- func SelectVersion(ctx context.Context, b []byte) (string, error)
- type Decoder
Constants ¶
This section is empty.
Variables ¶
var V1Alpha1 = Decoder[v1alpha1.ZarfPackage]{ // contains filtered or unexported fields }
V1Alpha1 decodes the v1alpha1 ZarfPackage schema.
var V1Beta1 = Decoder[v1beta1.Package]{ // contains filtered or unexported fields }
V1Beta1 decodes the v1beta1 Package schema.
Functions ¶
func ParseAs ¶ added in v0.84.0
ParseAs returns the document matching the decoder's apiVersion from a package definition that may contain multiple documents, decoded into its native type.
func ParseMultiDoc ¶ added in v0.75.1
ParseMultiDoc parses a multi doc zarf.yaml file into an operational Package. Multi doc definitions may contain one document per apiVersion; the highest-priority known version wins.
func ParseMultiDocNative ¶ added in v0.87.0
ParseMultiDocNative parses a multi-document zarf.yaml once and returns both the selected native wire definition and its operational representation.
func SelectVersion ¶ added in v0.84.0
SelectVersion returns the apiVersion Zarf will decode from a package definition that may contain multiple documents; the highest-priority known version wins. Use it to pick the decode target before calling ParseAs.
Source Files