aqua

Documentation

Index

• Constants
• type Checksum
  • func (chk *Checksum) GetEnabled() bool
• type ChekcsumExclude
• type Config
  • func (cfg *Config) ChecksumEnabled() bool
• type Package
  • func (pkg *Package) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Registries
  • func (Registries) JSONSchema() *jsonschema.Schema
  • func (registries *Registries) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Registry
  • func (registry *Registry) GetFilePath(rootDir, cfgFilePath string) string
  • func (registry *Registry) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (registry *Registry) Validate() error

Constants

const (
	PkgInfoTypeGitHubRelease = "github_release"
	PkgInfoTypeGitHubContent = "github_content"
	PkgInfoTypeGitHubArchive = "github_archive"
	PkgInfoTypeHTTP          = "http"
	PkgInfoTypeGo            = "go"
	PkgInfoTypeGoInstall     = "go_install"
)

const (
	RegistryTypeGitHubContent = "github_content"
	RegistryTypeLocal         = "local"
	RegistryTypeStandard      = "standard"
)

Types

type Checksum

type Checksum struct {
	Enabled                  *bool              `json:"enabled,omitempty"`
	RequireChecksumInAdvance bool               `yaml:"require_checksum_in_advance" json:"-"`
	CreateJSON               bool               `yaml:"create_json" json:"-"`
	RequireChecksum          bool               `yaml:"require_checksum" json:"-"`
	SaveCalculatedChecksum   bool               `yaml:"save_calculated_checksum" json:"-"`
	Excludes                 []*ChekcsumExclude `json:"-"`
}

func (*Checksum) GetEnabled

func (chk *Checksum) GetEnabled() bool

type ChekcsumExclude

type ChekcsumExclude struct {
	Name     string   `json:"name,omitempty"`
	Registry string   `json:"registry,omitempty"`
	Version  string   `json:"version,omitempty"`
	Envs     []string `json:"envs,omitempty"`
}

type Config

type Config struct {
	Packages   []*Package `validate:"dive" json:"packages"`
	Registries Registries `validate:"dive" json:"registries"`
	Checksum   *Checksum  `json:"checksum,omitempty"`
}

func (*Config) ChecksumEnabled

func (cfg *Config) ChecksumEnabled() bool

type Package

type Package struct {
	Name     string `validate:"required" json:"name,omitempty"`
	Registry string `` /* 145-byte string literal not displayed */
	Version  string `validate:"required" yaml:",omitempty" json:"version,omitempty"`
	Import   string `yaml:",omitempty" json:"import,omitempty"`
}

func (*Package) UnmarshalYAML

func (pkg *Package) UnmarshalYAML(unmarshal func(interface{}) error) error

type Registries

type Registries map[string]*Registry

func (Registries) JSONSchema

func (Registries) JSONSchema() *jsonschema.Schema

func (*Registries) UnmarshalYAML

func (registries *Registries) UnmarshalYAML(unmarshal func(interface{}) error) error

type Registry

type Registry struct {
	Name      string `validate:"required" json:"name,omitempty"`
	Type      string `validate:"required" json:"type,omitempty" jsonschema:"enum=standard,enum=local,enum=github_content"`
	RepoOwner string `yaml:"repo_owner" json:"repo_owner,omitempty"`
	RepoName  string `yaml:"repo_name" json:"repo_name,omitempty"`
	Ref       string `json:"ref,omitempty"`
	Path      string `validate:"required" json:"path,omitempty"`
}

func (*Registry) GetFilePath

func (registry *Registry) GetFilePath(rootDir, cfgFilePath string) string

func (*Registry) UnmarshalYAML

func (registry *Registry) UnmarshalYAML(unmarshal func(interface{}) error) error

func (*Registry) Validate

func (registry *Registry) Validate() error