aqua

Documentation

Index

• Constants
• func FilterPackageByTag(pkg *Package, tags, excludedTags map[string]struct{}) bool
• type Checksum
  • func (c *Checksum) GetEnabled() bool
• type Config
  • func (c *Config) ChecksumEnabled(enforceValue, defValue bool) bool
  • func (c *Config) RequireChecksum(enforceValue, defValue bool) bool
• type Package
  • func (p *Package) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Registries
  • func (Registries) JSONSchema() *jsonschema.Schema
  • func (r *Registries) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Registry
  • func (r *Registry) FilePath(rootDir, cfgFilePath string) (string, error)
  • func (r *Registry) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (r *Registry) Validate() error
• type Update
  • func (u *Update) GetEnabled() bool

Constants

const (
	PkgInfoTypeGitHubRelease = "github_release"
	PkgInfoTypeGitHubContent = "github_content"
	PkgInfoTypeGitHubArchive = "github_archive"
	PkgInfoTypeHTTP          = "http"
	PkgInfoTypeGoInstall     = "go_install"
	PkgInfoTypeCargo         = "cargo"
)

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

Functions

func FilterPackageByTag

func FilterPackageByTag(pkg *Package, tags, excludedTags map[string]struct{}) bool

Types

type Checksum

type Checksum struct {
	Enabled         *bool                  `json:"enabled,omitempty"`
	RequireChecksum *bool                  `yaml:"require_checksum" json:"require_checksum,omitempty"`
	SupportedEnvs   registry.SupportedEnvs `yaml:"supported_envs" json:"supported_envs,omitempty"`
}

func (*Checksum) GetEnabled

func (c *Checksum) GetEnabled() bool

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 (c *Config) ChecksumEnabled(enforceValue, defValue bool) bool

func (*Config) RequireChecksum

func (c *Config) RequireChecksum(enforceValue, defValue bool) 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"`
	Tags          []string       `yaml:",omitempty" json:"tags,omitempty"`
	Description   string         `yaml:",omitempty" json:"description,omitempty"`
	Link          string         `yaml:",omitempty" json:"link,omitempty"`
	Update        *Update        `yaml:",omitempty" json:"update,omitempty"`
	FilePath      string         `json:"-" yaml:"-"`
	GoVersionFile string         `json:"go_version_file,omitempty" yaml:"go_version_file,omitempty"`
	Vars          map[string]any `json:"vars,omitempty" yaml:",omitempty"`
}

func (*Package) UnmarshalYAML

func (p *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 (r *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"`
	Private   bool   `json:"private,omitempty"`
}

func (*Registry) FilePath

func (r *Registry) FilePath(rootDir, cfgFilePath string) (string, error)

func (*Registry) UnmarshalYAML

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

func (*Registry) Validate

func (r *Registry) Validate() error

type Update

type Update struct {
	// # If enabled is false, aqua up command ignores the package.
	// If the package name is passed to aqua up command explicitly, enabled is ignored.
	// By default, enabled is true.
	Enabled *bool `yaml:",omitempty" json:"enabled,omitempty"`
	// The condition of allowed version.
	// expr https://github.com/expr-lang/expr is used.
	// By default, all versions are allowed.
	// The version must meet both allowed_version and types.
	AllowedVersion string `yaml:"allowed_version,omitempty" json:"allowed_version,omitempty"`
	// The list of allowed update types
	// By default, all types are allowed.
	// major, minor, patch, other
	Types []string `yaml:",omitempty" json:"types,omitempty"`
}

func (*Update) GetEnabled

func (u *Update) GetEnabled() bool