spec

Documentation

Index

• type Build
  • func (b *Build) FlagSet() *flag.FlagSet
  • func (b Build) WithDefaults() Build
• type Release
  • func (r *Release) FlagSet() *flag.FlagSet
  • func (r Release) WithDefaults() Release
• type Spec
  • func FromFile() (Spec, error)
  • func (s Spec) WithDefaults() Spec

Types

type Build

type Build struct {
	CrossCompile   bool     `json:"crossCompile" yaml:"cross_compile"`
	MainFile       string   `json:"mainFile" yaml:"main_file"`
	BinaryFile     string   `json:"binaryFile" yaml:"binary_file"`
	VersionPackage string   `json:"versionPackage" yaml:"version_package"`
	GoVersions     []string `json:"goVersions" yaml:"go_versions"`
	Platforms      []string `json:"platforms" yaml:"platforms"`
}

Build has the specifications for build command.

func (*Build) FlagSet

func (b *Build) FlagSet() *flag.FlagSet

FlagSet returns a flag set for arguments of build command.

func (Build) WithDefaults

func (b Build) WithDefaults() Build

WithDefaults returns a new object with default values.

type Release

type Release struct {
	Build bool `json:"build" yaml:"build"`
}

Release has the specifications for release command.

func (*Release) FlagSet

func (r *Release) FlagSet() *flag.FlagSet

FlagSet returns a flag set for arguments of release command.

func (Release) WithDefaults

func (r Release) WithDefaults() Release

WithDefaults returns a new object with default values.

type Spec

type Spec struct {
	ToolName    string `json:"-" yaml:"-"`
	ToolVersion string `json:"-" yaml:"-"`

	Version  string  `json:"version" yaml:"version"`
	Language string  `json:"language" yaml:"language"`
	Build    Build   `json:"build" yaml:"build"`
	Release  Release `json:"release" yaml:"release"`
}

Spec has all the specifications for Cherry.

func FromFile

func FromFile() (Spec, error)

FromFile reads and returns specifications from a file. If no spec file is found, a new spec with zero values will be returned.

func (Spec) WithDefaults

func (s Spec) WithDefaults() Spec

WithDefaults returns a new object with default values.