bootstrap

type Config struct {
	// Version specifies the bootstrap config schema version.
	Version string `yaml:"version"`

	// Packages lists all available packages in the repository.
	Packages []PackageSpec `yaml:"packages"`

	// Profiles defines named sets of packages for different use cases.
	Profiles map[string]Profile `yaml:"profiles,omitempty"`

	// Machines maps host patterns to profiles, in evaluation order.
	// The first entry whose pattern matches the hostname wins.
	Machines []MachineRule `yaml:"machines,omitempty"`

	// Defaults specifies default settings for installation.
	Defaults Defaults `yaml:"defaults,omitempty"`
}

type Defaults struct {
	// ConflictPolicy is the default conflict resolution strategy.
	// Valid values: fail, backup, overwrite, skip
	ConflictPolicy string `yaml:"on_conflict"`

	// Profile is the default profile to use if none specified.
	Profile string `yaml:"profile"`
}

type FS interface {
	ReadFile(ctx context.Context, path string) ([]byte, error)
}

type GenerateOptions struct {
	// FromManifest only includes packages present in manifest
	FromManifest bool

	// ConflictPolicy sets default conflict resolution policy
	ConflictPolicy string

	// IncludeComments adds helpful comments to generated config
	IncludeComments bool
}

type Generator struct{}

type Layout string

type MachineRule struct {
	// Host is a glob pattern matched against the machine hostname.
	// Pattern syntax is path.Match: * and ? and [class] ranges, with no
	// special treatment of dots.
	Host string `yaml:"host"`

	// Profile names the profile applied on matching hosts.
	Profile string `yaml:"profile"`
}

type PackageSpec struct {
	// Name is the package directory name.
	Name string `yaml:"name"`

	// Required indicates if this package must be installed.
	Required bool `yaml:"required"`

	// Platform restricts installation to specific operating systems.
	// Valid values: linux, darwin, windows, freebsd
	Platform []string `yaml:"platform,omitempty"`

	// ConflictPolicy specifies how to handle conflicts for this package.
	// Valid values: fail, backup, overwrite, skip
	ConflictPolicy string `yaml:"on_conflict,omitempty"`
}

type Profile struct {
	// Description provides human-readable explanation of the profile.
	Description string `yaml:"description"`

	// Extends names a single parent profile whose packages are inherited.
	// Inherited packages come first, in parent chain order, followed by the
	// packages declared on this profile.
	Extends string `yaml:"extends,omitempty"`

	// Packages lists the package names included in this profile.
	Packages []string `yaml:"packages"`
}