manifest

Documentation

Index

• func Platform() string
• func XPlatform(platform string) string
• type PackageManifest
  • func NewPackageManfiest(name string, ctx *PackageManifestContext, overrides *PackageManifestOptions) (*PackageManifest, error)
  • func (man *PackageManifest) UpdateRepos() error
• type PackageManifestConfig
  • func NewPackageManfiestConfig(name string) (*PackageManifestConfig, error)
  • func (*PackageManifestConfig) GetManifestTemplate(name string) ([]byte, error)
  • func (conf *PackageManifestConfig) Merge(overrides *PackageManifestOptions, ctx *PackageManifestContext) error
  • func (conf *PackageManifestConfig) Parse() error
  • func (conf *PackageManifestConfig) Render(ctx *PackageManifestContext) error
• type PackageManifestContext
  • func NewManifestContext(name string, version string) *PackageManifestContext
• type PackageManifestOptions
• type PackageManifestVersionBlock

Functions

func Platform

func Platform() string

func XPlatform

func XPlatform(platform string) string

Types

type PackageManifest

type PackageManifest struct {
	Name string

	PackageManifestOptions
}

PackageManifest contains the parsed result of the .hcl config file for a package. It's used to determine how to download a specific package project

func NewPackageManfiest

func NewPackageManfiest(
	name string,
	ctx *PackageManifestContext,
	overrides *PackageManifestOptions,
) (*PackageManifest, error)

func (*PackageManifest) UpdateRepos

func (man *PackageManifest) UpdateRepos() error

type PackageManifestConfig

type PackageManifestConfig struct {
	Name        string `hcl:"name"`
	Description string `hcl:"description,optional"`

	PackageManifestOptions
	Versions []PackageManifestVersionBlock `hcl:"with-version,block,optional"`
}

func NewPackageManfiestConfig

func NewPackageManfiestConfig(name string) (*PackageManifestConfig, error)

func (*PackageManifestConfig) GetManifestTemplate

func (*PackageManifestConfig) GetManifestTemplate(name string) ([]byte, error)

func (*PackageManifestConfig) Merge

func (conf *PackageManifestConfig) Merge(
	overrides *PackageManifestOptions,
	ctx *PackageManifestContext,
) error

func (*PackageManifestConfig) Parse

func (conf *PackageManifestConfig) Parse() error

func (*PackageManifestConfig) Render

func (conf *PackageManifestConfig) Render(ctx *PackageManifestContext) error

type PackageManifestContext

type PackageManifestContext struct {
	Version   string
	Platform  string
	XPlatform string
	OutputDir string
}

func NewManifestContext

func NewManifestContext(name string, version string) *PackageManifestContext

type PackageManifestOptions

type PackageManifestOptions struct {
	Version string            `hcl:"version,optional"`
	Exec    string            `hcl:"exec,optional"`
	Bins    map[string]string `hcl:"bins,optional"`
	Source  string            `hcl:"source,optional"`
	Extract string            `hcl:"extract,optional"`
	Test    string            `hcl:"test,optional"`
}

type PackageManifestVersionBlock

type PackageManifestVersionBlock struct {
	Version string `hcl:"version,label"`
	PackageManifestOptions
}