buildpack

Documentation

Index

• func HasDockerLocator(locator string) bool
• func ParseIDLocator(locator string) (id string, version string)
• func ParsePackageLocator(locator string) (imageName string)
• func ParseRegistryID(registryID string) (namespace string, name string, version string, err error)
• type LocatorType
  • func GetLocatorType(locator string, relativeBaseDir string, ...) (LocatorType, error)
  • func (l LocatorType) String() string

Functions

func HasDockerLocator

func HasDockerLocator(locator string) bool

func ParseIDLocator

func ParseIDLocator(locator string) (id string, version string)

ParseIDLocator parses a buildpack locator in the following formats into its ID and version.

• <id>[@<version>]
• urn:cnb:builder:<id>[@<version>]
• urn:cnb:registry:<id>[@<version>]
• from=builder:<id>[@<version>] (deprecated)

If version is omitted, the version returned will be empty. Any "from=builder:" or "urn:cnb" prefix will be ignored.

func ParsePackageLocator

func ParsePackageLocator(locator string) (imageName string)

ParsePackageLocator parses a locator (in format `[docker://][<host>/]<path>[:<tag>⏐@<digest>]`) to image name (`[<host>/]<path>[:<tag>⏐@<digest>]`)

func ParseRegistryID

func ParseRegistryID(registryID string) (namespace string, name string, version string, err error)

ParseRegistryID parses a registry id (ie. `<namespace>/<name>@<version>`) into namespace, name and version components.

Supported formats:

• <ns>/<name>[@<version>]
• urn:cnb:registry:<ns>/<name>[@<version>]

Types

type LocatorType

type LocatorType int

const (
	InvalidLocator LocatorType = iota
	FromBuilderLocator
	URILocator
	IDLocator
	PackageLocator
	RegistryLocator
)

func GetLocatorType

func GetLocatorType(locator string, relativeBaseDir string, buildpacksFromBuilder []dist.BuildpackInfo) (LocatorType, error)

GetLocatorType determines which type of locator is designated by the given input. If a type cannot be determined, `INVALID_LOCATOR` will be returned. If an error is encountered, it will be returned.

func (LocatorType) String

func (l LocatorType) String() string