config

Documentation

Index

• func LoadEnvFile(filename string) (map[string]string, error)
• type Archive
  • func (a *Archive) Init() error
• type ArchiveFileInfo
• type ArchiveSettings
  • func (a *ArchiveSettings) Init() error
• type ArchiveType
  • func (a *ArchiveType) Init() error
  • func (a ArchiveType) IsZero() bool
• type Archives
• type Build
  • func (b *Build) Init() error
  • func (b Build) IsZero() bool
• type BuildArch
  • func (b BuildArch) BinaryPath() string
• type BuildArchPath
• type BuildOs
• type BuildSettings
  • func (b BuildSettings) Fields() logg.Fields
• type Builds
• type Config
  • func DecodeAndApplyDefaults(r io.Reader) (Config, error)
  • func (c Config) FindArchs(filter matchers.Matcher) []BuildArchPath
  • func (c Config) FindReleases(filter matchers.Matcher) []Release
• type GoSettings
• type Plugin
  • func (t *Plugin) Clear()
  • func (t *Plugin) Init() error
  • func (t Plugin) IsZero() bool
• type Release
  • func (a *Release) Init() error
• type ReleaseNotesGroup
  • func (g *ReleaseNotesGroup) Init() error
• type ReleaseNotesSettings
  • func (g *ReleaseNotesSettings) Init() error
• type ReleaseSettings
  • func (r *ReleaseSettings) Init() error
• type Releases

Functions

func LoadEnvFile

func LoadEnvFile(filename string) (map[string]string, error)

LoadEnvFile loads environment variables from text file on the form key=value. It ignores empty lines and lines starting with # and lines without an equals sign.

Types

type Archive

type Archive struct {
	// Glob of Build paths to archive. Multiple paths will be ANDed.
	Paths           []string        `json:"paths"`
	ArchiveSettings ArchiveSettings `json:"archive_settings"`

	PathsCompiled matchers.Matcher `json:"-"`
	ArchsCompiled []BuildArchPath  `json:"-"`
}

func (*Archive) Init

func (a *Archive) Init() error

type ArchiveFileInfo

type ArchiveFileInfo struct {
	SourcePath string      `json:"source_path"`
	TargetPath string      `json:"target_path"`
	Mode       fs.FileMode `json:"mode"`
}

type ArchiveSettings

type ArchiveSettings struct {
	Type ArchiveType `json:"type"`

	BinaryDir    string            `json:"binary_dir"`
	NameTemplate string            `json:"name_template"`
	ExtraFiles   []ArchiveFileInfo `json:"extra_files"`
	Replacements map[string]string `json:"replacements"`
	Plugin       Plugin            `json:"plugin"`

	// CustomSettings is archive type specific metadata.
	// See in the documentation for the configured archive type.
	CustomSettings map[string]any `json:"custom_settings"`

	ReplacementsCompiled *strings.Replacer `json:"-"`
}

func (*ArchiveSettings) Init

func (a *ArchiveSettings) Init() error

type ArchiveType

type ArchiveType struct {
	Format    string `json:"format"`
	Extension string `json:"extension"`

	FormatParsed archiveformats.Format `json:"-"`
}

func (*ArchiveType) Init

func (a *ArchiveType) Init() error

func (ArchiveType) IsZero

func (a ArchiveType) IsZero() bool

IsZero is needed to get the shallow merge correct.

type Archives

type Archives []Archive

type Build

type Build struct {
	Path string    `json:"path"`
	Os   []BuildOs `json:"os"`

	BuildSettings BuildSettings `json:"build_settings"`
}

func (*Build) Init

func (b *Build) Init() error

func (Build) IsZero

func (b Build) IsZero() bool

type BuildArch

type BuildArch struct {
	Goarch string `json:"goarch"`

	BuildSettings BuildSettings `json:"build_settings"`

	// Tree navigation.
	Build *Build   `json:"-"`
	Os    *BuildOs `json:"-"`
}

func (BuildArch) BinaryPath

func (b BuildArch) BinaryPath() string

BinaryPath returns the path to the built binary starting below /builds.

type BuildArchPath

type BuildArchPath struct {
	Arch BuildArch `json:"arch"`
	Path string    `json:"path"`

	// Name is the name of the archive with the extension.
	Name string `json:"name"`

	// Any archive aliase names, with the extension.
	Aliases []string `json:"aliases"`
}

type BuildOs

type BuildOs struct {
	Goos  string      `json:"goos"`
	Archs []BuildArch `json:"archs"`

	BuildSettings BuildSettings `json:"build_settings"`

	// Tree navigation.
	Build *Build `json:"-"`
}

type BuildSettings

type BuildSettings struct {
	Binary string `json:"binary"`

	Env     []string `json:"env"`
	Ldflags string   `json:"ldflags"`
	Flags   []string `json:"flags"`

	GoSettings GoSettings `json:"go_settings"`
}

func (BuildSettings) Fields

func (b BuildSettings) Fields() logg.Fields

Fields is used by the logging framework.

type Builds

type Builds []Build

type Config

type Config struct {
	// A bucket for anchors that defines reusable YAML fragments.
	Definitions map[string]any ` json:"definitions"`

	Project                  string            `json:"project"`
	ArchiveAliasReplacements map[string]string `json:"archive_alias_replacements"`

	GoSettings GoSettings `json:"go_settings"`

	Builds   Builds   `json:"builds"`
	Archives Archives `json:"archives"`
	Releases Releases `json:"releases"`

	BuildSettings   BuildSettings   `json:"build_settings"`
	ArchiveSettings ArchiveSettings `json:"archive_settings"`
	ReleaseSettings ReleaseSettings `json:"release_settings"`
}

func DecodeAndApplyDefaults

func DecodeAndApplyDefaults(r io.Reader) (Config, error)

DecodeAndApplyDefaults first expand any environment variables in r (${var}), decodes it and applies default values.

func (Config) FindArchs

func (c Config) FindArchs(filter matchers.Matcher) []BuildArchPath

FindArchs returns the archs that match the given filter

func (Config) FindReleases

func (c Config) FindReleases(filter matchers.Matcher) []Release

type GoSettings

type GoSettings struct {
	GoExe   string `json:"go_exe"`
	GoProxy string `json:"go_proxy"`
}

type Plugin

type Plugin struct {
	ID      string   `json:"id"`
	Type    string   `json:"type"`
	Command string   `json:"command"`
	Dir     string   `json:"dir"`
	Env     []string `json:"env"`

	TypeParsed plugintypes.Type `json:"-"`
}

func (*Plugin) Clear

func (t *Plugin) Clear()

func (*Plugin) Init

func (t *Plugin) Init() error

func (Plugin) IsZero

func (t Plugin) IsZero() bool

type Release

type Release struct {
	// Paths with Glob of releases paths to release. Multiple paths will be ANDed.
	Paths []string `json:"paths"`

	// Path is the directory below /dist/releases where the release artifacts gets stored.
	// This must be unique for each release within one configuration file.
	Path string `json:"path"`

	ReleaseSettings ReleaseSettings `json:"release_settings"`

	PathsCompiled matchers.Matcher `json:"-"`

	// Builds matching Paths.
	ArchsCompiled []BuildArchPath `json:"-"`
}

func (*Release) Init

func (a *Release) Init() error

type ReleaseNotesGroup

type ReleaseNotesGroup struct {
	Title   string `json:"title"`
	Regexp  string `json:"regexp"`
	Ignore  bool   `json:"ignore"`
	Ordinal int    `json:"ordinal"`

	RegexpCompiled matchers.Matcher `json:"-"`
}

func (*ReleaseNotesGroup) Init

func (g *ReleaseNotesGroup) Init() error

type ReleaseNotesSettings

type ReleaseNotesSettings struct {
	Generate         bool                `json:"generate"`
	GenerateOnHost   bool                `json:"generate_on_host"`
	Filename         string              `json:"filename"`
	TemplateFilename string              `json:"template_filename"`
	Groups           []ReleaseNotesGroup `json:"groups"`

	// Can be used to collapse releases with a few number (less than threshold) of changes into one title.
	ShortThreshold int    `json:"short_threshold"`
	ShortTitle     string `json:"short_title"`
}

func (*ReleaseNotesSettings) Init

func (g *ReleaseNotesSettings) Init() error

type ReleaseSettings

type ReleaseSettings struct {
	Type string `json:"type"`

	Name            string `json:"name"`
	Repository      string `json:"repository"`
	RepositoryOwner string `json:"repository_owner"`
	Draft           bool   `json:"draft"`
	Prerelease      bool   `json:"prerelease"`

	ReleaseNotesSettings ReleaseNotesSettings `json:"release_notes_settings"`

	TypeParsed releasetypes.Type `json:"-"`
}

func (*ReleaseSettings) Init

func (r *ReleaseSettings) Init() error

type Releases

type Releases []Release