build

type Advisories map[string][]AdvisoryContent

type AdvisoryContent struct {
	Timestamp       time.Time         `yaml:"timestamp"`
	Status          vex.Status        `yaml:"status"`
	Justification   vex.Justification `yaml:"justification,omitempty"`
	ImpactStatement string            `yaml:"impact,omitempty"`
	ActionStatement string            `yaml:"action,omitempty"`
	FixedVersion    string            `yaml:"fixed-version,omitempty"`
}

type BuildOption struct {
	Vars        map[string]string `yaml:"vars,omitempty"`
	Environment EnvironmentOption `yaml:"environment,omitempty"`
}

type CacheMembershipMap map[string]bool

type Configuration struct {
	Package     Package
	Environment apko_types.ImageConfiguration
	Pipeline    []Pipeline   `yaml:"pipeline,omitempty"`
	Subpackages []Subpackage `yaml:"subpackages,omitempty"`
	Data        []RangeData  `yaml:"data,omitempty"`
	Secfixes    Secfixes     `yaml:"secfixes,omitempty"`
	Advisories  Advisories   `yaml:"advisories,omitempty"`
	Update      Update       `yaml:"update,omitempty"`

	Vars map[string]string `yaml:"vars,omitempty"`

	VarTransforms []VarTransforms `yaml:"var-transforms,omitempty"`

	Options map[string]BuildOption `yaml:"options,omitempty"`
}

type ConfigurationParsingOption func(*configOptions)

type ContentsOption struct {
	Packages ListOption `yaml:"packages,omitempty"`
}

type Context struct {
	Configuration      Configuration
	ConfigFile         string
	SourceDateEpoch    time.Time
	WorkspaceDir       string
	WorkspaceIgnore    string
	PipelineDir        string
	BuiltinPipelineDir string
	SourceDir          string
	GuestDir           string
	SigningKey         string
	SigningPassphrase  string
	Namespace          string
	GenerateIndex      bool
	EmptyWorkspace     bool
	OutDir             string
	Logger             *log.Logger
	Arch               apko_types.Architecture
	ExtraKeys          []string
	ExtraRepos         []string
	DependencyLog      string
	BinShOverlay       string
	CreateBuildLog     bool

	CacheDir        string
	CacheSource     string
	BreakpointLabel string
	ContinueLabel   string

	StripOriginName bool
	EnvFile         string
	VarsFile        string
	Runner          container.Runner

	Debug bool

	EnabledBuildOptions []string
	// contains filtered or unexported fields
}

type Copyright struct {
	Paths       []string `yaml:"paths,omitempty"`
	Attestation string   `yaml:"attestation,omitempty"`
	License     string   `yaml:"license"`
}

type DataItem struct {
	Key, Value string
}

type DataItemList []DataItem

type Dependencies struct {
	Runtime  []string `yaml:"runtime,omitempty"`
	Provides []string `yaml:"provides,omitempty"`
	Replaces []string `yaml:"replaces,omitempty"`

	ProviderPriority int `yaml:"provider-priority,omitempty"`
}

type DependencyGenerator func(*PackageContext, *Dependencies) error

type EnvironmentOption struct {
	Contents ContentsOption `yaml:"contents,omitempty"`
}

type GitHubMonitor struct {
	Identifier  string `yaml:"identifier"`             // org/repo for GitHub
	StripPrefix string `yaml:"strip-prefix,omitempty"` // if the version in GitHub contains a prefix which needs to be stripped when updating the melange package
	TagFilter   string `yaml:"tag-filter,omitempty"`   // filter to apply when searching tags on a GitHub repository
	UseTags     bool   `yaml:"use-tag,omitempty"`      // override the default of using a GitHub release to identify related tag to fetch.  Not all projects use GitHub releases but just use tags
}

type Input struct {
	Description string
	Default     string
	Required    bool
}

type ListOption struct {
	Add    []string `yaml:"add,omitempty"`
	Remove []string `yaml:"remove,omitempty"`
}

type Logger interface {
	Printf(format string, v ...any)
	SetPrefix(prefix string)
}

type Needs struct {
	Packages []string
}

type Option func(*Context) error

type Package struct {
	Name               string        `yaml:"name"`
	Version            string        `yaml:"version"`
	Epoch              uint64        `yaml:"epoch"`
	Description        string        `yaml:"description,omitempty"`
	URL                string        `yaml:"url,omitempty"`
	Commit             string        `yaml:"commit,omitempty"`
	TargetArchitecture []string      `yaml:"target-architecture,omitempty"`
	Copyright          []Copyright   `yaml:"copyright,omitempty"`
	Dependencies       Dependencies  `yaml:"dependencies,omitempty"`
	Options            PackageOption `yaml:"options,omitempty"`
	Scriptlets         Scriptlets    `yaml:"scriptlets,omitempty"`
}

type PackageContext struct {
	Context       *Context
	Origin        *Package
	PackageName   string
	OriginName    string
	InstalledSize int64
	DataHash      string
	OutDir        string
	Logger        *log.Logger
	Dependencies  Dependencies
	Arch          string
	Options       PackageOption
	Scriptlets    Scriptlets
	Description   string
	URL           string
	Commit        string
}

type PackageOption struct {
	NoProvides bool `yaml:"no-provides"`
	NoDepends  bool `yaml:"no-depends"`
	NoCommands bool `yaml:"no-commands"`
}

type Pipeline struct {
	Name       string             `yaml:"name,omitempty"`
	Uses       string             `yaml:"uses,omitempty"`
	With       map[string]string  `yaml:"with,omitempty"`
	Runs       string             `yaml:"runs,omitempty"`
	Pipeline   []Pipeline         `yaml:"pipeline,omitempty"`
	Inputs     map[string]Input   `yaml:"inputs,omitempty"`
	Needs      Needs              `yaml:"needs,omitempty"`
	Label      string             `yaml:"label,omitempty"`
	If         string             `yaml:"if,omitempty"`
	Assertions PipelineAssertions `yaml:"assertions,omitempty"`
	WorkDir    string             `yaml:"working-directory,omitempty"`

	SBOM SBOM `yaml:"sbom,omitempty"`
	// contains filtered or unexported fields
}

type PipelineAssertions struct {
	RequiredSteps int `yaml:"required-steps,omitempty"`
}

type PipelineContext struct {
	Context    *Context
	Package    *Package
	Subpackage *Subpackage
}

type RangeData struct {
	Name  string       `yaml:"name"`
	Items DataItemList `yaml:"items"`
}

type ReleaseMonitor struct {
	Identifier int `yaml:"identifier"` // ID number for release monitor
}

type SBOM struct {
	Language string `yaml:"language"`
}

type Scriptlets struct {
	Trigger struct {
		Script string
		Paths  []string
	} `yaml:"trigger,omitempty"`

	PreInstall    string `yaml:"pre-install,omitempty"`
	PostInstall   string `yaml:"post-install,omitempty"`
	PreDeinstall  string `yaml:"pre-deinstall,omitempty"`
	PostDeinstall string `yaml:"post-deinstall,omitempty"`
	PreUpgrade    string `yaml:"pre-upgrade,omitempty"`
	PostUpgrade   string `yaml:"post-upgrade,omitempty"`
}

type Secfixes map[string][]string

type Subpackage struct {
	If           string        `yaml:"if,omitempty"`
	Range        string        `yaml:"range,omitempty"`
	Name         string        `yaml:"name"`
	Pipeline     []Pipeline    `yaml:"pipeline,omitempty"`
	Dependencies Dependencies  `yaml:"dependencies,omitempty"`
	Options      PackageOption `yaml:"options,omitempty"`
	Scriptlets   Scriptlets    `yaml:"scriptlets,omitempty"`
	Description  string        `yaml:"description,omitempty"`
	URL          string        `yaml:"url,omitempty"`
	Commit       string        `yaml:"commit,omitempty"`
}

type Update struct {
	Enabled          bool            `yaml:"enabled"`                     // toggle if updates should occur
	Shared           bool            `yaml:"shared,omitempty"`            // indicate that an update to this package requires an epoch bump of downstream dependencies, e.g. golang, java
	VersionSeparator string          `yaml:"version-separator,omitempty"` // override the version separator if it is nonstandard
	ReleaseMonitor   *ReleaseMonitor `yaml:"release-monitor,omitempty"`
	GitHubMonitor    *GitHubMonitor  `yaml:"github,omitempty"`
}

type VarTransforms struct {
	From    string `yaml:"from"`
	Match   string `yaml:"match"`
	Replace string `yaml:"replace"`
	To      string `yaml:"to"`
}