config

Documentation

Overview

Package config contains the model and loader of the goreleaser configuration file.

Index

• type Archive
• type Build
• type FPM
• type FormatOverride
• type Homebrew
• type Hooks
• type IgnoredBuild
• type Project
  • func Load(file string) (config Project, err error)
  • func LoadReader(fd io.Reader) (config Project, err error)
• type Release
• type Repo
  • func (r Repo) String() string
• type Snapshot

Types

type Archive

type Archive struct {
	Format          string            `yaml:",omitempty"`
	FormatOverrides []FormatOverride  `yaml:"format_overrides,omitempty"`
	NameTemplate    string            `yaml:"name_template,omitempty"`
	Replacements    map[string]string `yaml:",omitempty"`
	Files           []string          `yaml:",omitempty"`
}

Archive config used for the archive

type Build

type Build struct {
	Goos    []string       `yaml:",omitempty"`
	Goarch  []string       `yaml:",omitempty"`
	Goarm   []string       `yaml:",omitempty"`
	Ignore  []IgnoredBuild `yaml:",omitempty"`
	Main    string         `yaml:",omitempty"`
	Ldflags string         `yaml:",omitempty"`
	Flags   string         `yaml:",omitempty"`
	Binary  string         `yaml:",omitempty"`
	Hooks   Hooks          `yaml:",omitempty"`
	Env     []string       `yaml:",omitempty"`
}

Build contains the build configuration section

type FPM

type FPM struct {
	Formats      []string `yaml:",omitempty"`
	Dependencies []string `yaml:",omitempty"`
	Conflicts    []string `yaml:",omitempty"`
	Vendor       string   `yaml:",omitempty"`
	Homepage     string   `yaml:",omitempty"`
	Maintainer   string   `yaml:",omitempty"`
	Description  string   `yaml:",omitempty"`
	License      string   `yaml:",omitempty"`
}

FPM config

type FormatOverride

type FormatOverride struct {
	Goos   string `yaml:",omitempty"`
	Format string `yaml:",omitempty"`
}

FormatOverride is used to specify a custom format for a specific GOOS.

type Homebrew

type Homebrew struct {
	GitHub       Repo     `yaml:",omitempty"`
	Folder       string   `yaml:",omitempty"`
	Caveats      string   `yaml:",omitempty"`
	Plist        string   `yaml:",omitempty"`
	Install      string   `yaml:",omitempty"`
	Dependencies []string `yaml:",omitempty"`
	Conflicts    []string `yaml:",omitempty"`
	Description  string   `yaml:",omitempty"`
	Homepage     string   `yaml:",omitempty"`
}

Homebrew contains the brew section

type Hooks

type Hooks struct {
	Pre  string `yaml:",omitempty"`
	Post string `yaml:",omitempty"`
}

Hooks define actions to run before and/or after something

type IgnoredBuild

type IgnoredBuild struct {
	Goos, Goarch, Goarm string
}

IgnoredBuild represents a build ignored by the user

type Project

type Project struct {
	Release  Release  `yaml:",omitempty"`
	Brew     Homebrew `yaml:",omitempty"`
	Build    Build    `yaml:",omitempty"`
	Archive  Archive  `yaml:",omitempty"`
	FPM      FPM      `yaml:",omitempty"`
	Snapshot Snapshot `yaml:",omitempty"`

	// test only property indicating the path to the dist folder
	Dist string `yaml:"-"`
}

Project includes all project configuration

func Load

func Load(file string) (config Project, err error)

Load config file

func LoadReader

func LoadReader(fd io.Reader) (config Project, err error)

LoadReader config via io.Reader

type Release

type Release struct {
	GitHub Repo `yaml:",omitempty"`
	Draft  bool `yaml:",omitempty"`
}

Release config used for the GitHub release

type Repo

type Repo struct {
	Owner string `yaml:",omitempty"`
	Name  string `yaml:",omitempty"`
}

Repo represents any kind of repo (github, gitlab, etc)

func (Repo) String

func (r Repo) String() string

String of the repo, e.g. owner/name

type Snapshot

type Snapshot struct {
	NameTemplate string `yaml:"name_template,omitempty"`
}

Snapshot config