latest

type AlpinePackageCache interface {
	// Put stores the given data in the cache
	Put(map[string]*AlpinePackageInfo) error
	// Get retrieves the existing cached data, or an empty map if not available
	Get() (map[string]*AlpinePackageInfo, error)
}

type AlpinePackageInfo = apkutils.PackageInfo

type AlpinePackageOptions struct {
	AlpinePackagesOptions

	// The cache to use for persisting package information. Defaults to a new
	// in-memory cache, which will cause the package list to be updated every
	// time AlpinePackage is called.
	Cache AlpinePackageCache
}

type AlpinePackagesOptions struct {
	// The provider for Alpine Linux public keys, used to verify the signature of the APKINDEX.
	// Defaults to using all known keys provided by apkutil.
	KeyProvider apkutils.KeyProvider
	// The alpine mirror to use. Defaults to `https://dl-cdn.alpinelinux.org/alpine/`
	Mirror string
	// The architecture to use. Defaults to "x86_64".
	Arch string
	// The alpine branch to get packages for. Defaults to "latest-stable"
	Branch string
	// The alpine repository to get packages from. Defaults to "main"
	Repository string
}

type AlpineReleaseOptions struct {
	// The alpine mirror to use. Defaults to `https://dl-cdn.alpinelinux.org/alpine/`
	Mirror string
	// The architecture to select. Defaults to "x86_64".
	Arch string
	// The flavour of alpine to return download links and checksums for. Defaults to "standard".
	Flavour string
}

type GoOptions struct {
	// If set, only return files for this OS.
	Os string
	// If set, only return files for this Architecture.
	Arch string
	// The kind of file to return. Defaults to "source".
	//
	// Valid kinds at time of writing are: "source", "archive" and "installer".
	Kind string
}

type ImageOptions struct {
	// The registry to use if image names aren't fully-qualified.
	// Defaults to "docker.io".
	Registry string
	// The username to use to authenticate to registries.
	// If not set, will attempt to use the docker config file.
	Username string
	// The password to use to authenticate to registries.
	// If not set, will attempt to use the docker config file.
	Password string
}

type ImageTagOptions struct {
	ImageOptions
	TagOptions
}

type TagOptions struct {
	// Should tags that look like dates (starting yyyymmdd or yyyy-mm-dd) be ignored?
	IgnoreDates bool
	// Should tags that are not parseable as semver be silently ignored?
	IgnoreErrors bool
	// Should pre-releases (-alpha, -beta, etc) be ignored?
	IgnorePreRelease bool
	// Only consider tags with prerelease identifiers matching one of these (case-insensitive)
	PreReleases []string
	// Strings to remove from the start of tags. Processed in order.
	TrimPrefixes []string
	// Strings to remove from the ends of tags. Processed in order.
	TrimSuffixes []string
	// The maximum major version to consider.
	MajorVersionMax int
}