config

Documentation

Overview

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

Index

• type Archive
• type Artifactory
• type Build
• type Changelog
• type Checksum
• type CommitAuthor
• type Docker
• type FPM
• type Filters
• type FormatOverride
• type GitHubURLs
• 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 Snapcraft
• type SnapcraftAppMetadata
• type Snapshot

Types

type Archive

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

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Archive config used for the archive

type Artifactory

type Artifactory struct {
	Target   string `yaml:",omitempty"`
	Name     string `yaml:",omitempty"`
	Username string `yaml:",omitempty"`
	Mode     string `yaml:",omitempty"`

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Artifactory server configuration

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"`

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Build contains the build configuration section

type Changelog

type Changelog struct {
	Filters Filters `yaml:",omitempty"`
	Sort    string  `yaml:",omitempty"`

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Changelog Config

type Checksum

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

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Checksum config

type CommitAuthor

type CommitAuthor struct {
	Name  string `yaml:",omitempty"`
	Email string `yaml:",omitempty"`
}

CommitAuthor is the author of a Git commit

type Docker

type Docker struct {
	Binary      string   `yaml:",omitempty"`
	Goos        string   `yaml:",omitempty"`
	Goarch      string   `yaml:",omitempty"`
	Goarm       string   `yaml:",omitempty"`
	Image       string   `yaml:",omitempty"`
	Dockerfile  string   `yaml:",omitempty"`
	Latest      bool     `yaml:",omitempty"`
	TagTemplate string   `yaml:"tag_template,omitempty"`
	Files       []string `yaml:"extra_files,omitempty"`

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Docker image config

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"`
	Bindir       string            `yaml:",omitempty"`
	Files        map[string]string `yaml:",omitempty"`

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

FPM config

type Filters

type Filters struct {
	Exclude []string `yaml:",omitempty"`

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Filters config

type FormatOverride

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

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

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

type GitHubURLs

type GitHubURLs struct {
	API      string `yaml:"api,omitempty"`
	Upload   string `yaml:"upload,omitempty"`
	Download string `yaml:"download,omitempty"`
}

GitHubURLs holds the URLs to be used when using github enterprise

type Homebrew

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

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Homebrew contains the brew section

type Hooks

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

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Hooks define actions to run before and/or after something

type IgnoredBuild

type IgnoredBuild struct {
	Goos, Goarch, Goarm string

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

IgnoredBuild represents a build ignored by the user

type Project

type Project struct {
	ProjectName   string        `yaml:"project_name,omitempty"`
	Release       Release       `yaml:",omitempty"`
	Brew          Homebrew      `yaml:",omitempty"`
	Builds        []Build       `yaml:",omitempty"`
	Archive       Archive       `yaml:",omitempty"`
	FPM           FPM           `yaml:",omitempty"`
	Snapcraft     Snapcraft     `yaml:",omitempty"`
	Snapshot      Snapshot      `yaml:",omitempty"`
	Checksum      Checksum      `yaml:",omitempty"`
	Dockers       []Docker      `yaml:",omitempty"`
	Artifactories []Artifactory `yaml:",omitempty"`
	Changelog     Changelog     `yaml:",omitempty"`
	Dist          string        `yaml:",omitempty"`

	// this is a hack ¯\_(ツ)_/¯
	SingleBuild Build `yaml:"build,omitempty"`

	// should be set if using github enterprise
	GitHubURLs GitHubURLs `yaml:"github_urls,omitempty"`

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

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"`
	Prerelease   bool   `yaml:",omitempty"`
	NameTemplate string `yaml:"name_template,omitempty"`
	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Release config used for the GitHub release

type Repo

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

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

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 Snapcraft

type Snapcraft struct {
	Name        string                          `yaml:",omitempty"`
	Summary     string                          `yaml:",omitempty"`
	Description string                          `yaml:",omitempty"`
	Grade       string                          `yaml:",omitempty"`
	Confinement string                          `yaml:",omitempty"`
	Apps        map[string]SnapcraftAppMetadata `yaml:",omitempty"`

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Snapcraft config

type SnapcraftAppMetadata

type SnapcraftAppMetadata struct {
	Plugs  []string
	Daemon string
}

SnapcraftAppMetadata for the binaries that will be in the snap package

type Snapshot

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

	// Capture all undefined fields and should be empty after loading
	XXX map[string]interface{} `yaml:",inline"`
}

Snapshot config