metadata

Documentation

Index

• type PackageDependency
• type PackageMetadata
• type PackageMetadataList
  • func LoadPackageMetadata(path string) (PackageMetadataList, error)

Types

type PackageDependency

type PackageDependency struct {
	// Name is the name of the package.
	Name string `json:"name"`
	// VersionConstraint is a version constraint that's embedded in the spec file.
	VersionConstraint string `json:"versionConstraint"`
}

PackageDependency is a struct that defines a single runtime dependency.

type PackageMetadata

type PackageMetadata struct {
	// VersionConstraint is a semver range that defines the version of the package for which the metadata is valid.
	VersionConstraint string `json:"versionConstraint"`
	// SourceURLTemplate is a template for the URL from which to download artifacts needed to build the package.
	SourceURLTemplate string `json:"sourceURLTemplate"`
	// SourceTarGz is an indicator if artifacts are packed in a .tar.gz archive.
	SourceTarGz bool `json:"sourceTarGz"`
	// Dependencies is a list of dependencies needed to install the package.
	Dependencies []PackageDependency `json:"dependencies,omitempty"`
}

PackageMetadata is a struct that contains the following information about a package: - URL from which to download artifacts needed to build the package - Indicator if artifacts are packed in a .tar.gz archive - Dependencies needed to install the package Package's metadata is versioned based on the given version constraint.

type PackageMetadataList

type PackageMetadataList map[string][]PackageMetadata

PackageMetadataList is a map that represents metadata.yaml file.

func LoadPackageMetadata

func LoadPackageMetadata(path string) (PackageMetadataList, error)

LoadPackageMetadata loads metadata.yaml file from the given path.