deprecated

Documentation

Overview

Package deprecated handles package deprecations and migrations

Package deprecated handles package deprecations and migrations

Package deprecated handles package deprecations and migrations

Index

• Constants
• func MigrateComponent(build types.ZarfBuildData, component types.ZarfComponent) (migratedComponent types.ZarfComponent, warnings []string)
• func PrintBreakingChanges(deployedZarfVersion string)
• type BreakingChange

Constants

const (
	// This should be updated when a breaking change is introduced to the Zarf package structure.  See: https://github.com/defenseunicorns/zarf/releases/tag/v0.27.0
	LastNonBreakingVersion   = "v0.27.0"
	ScriptsToActionsMigrated = "scripts-to-actions"
	PluralizeSetVariable     = "pluralize-set-variable"
)

List of migrations tracked in the zarf.yaml build data.

Functions

func MigrateComponent

func MigrateComponent(build types.ZarfBuildData, component types.ZarfComponent) (migratedComponent types.ZarfComponent, warnings []string)

MigrateComponent runs all migrations on a component. Build should be empty on package create, but include just in case someone copied a zarf.yaml from a zarf package.

func PrintBreakingChanges

func PrintBreakingChanges(deployedZarfVersion string)

PrintBreakingChanges prints the breaking changes between the provided version and the current CLIVersion

Types

type BreakingChange

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

BreakingChange represents a breaking change that happened on a specified Zarf version