config

Documentation

Overview

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

Index

• type Archive
• type Build
• type FPM
• type FPMOptions
• type Homebrew
• type Hooks
• type Project
  • func Load(file string) (config Project, err error)
• type Release
• type Repo
  • func (r Repo) String() string

Types

type Archive

type Archive struct {
	Format       string
	NameTemplate string `yaml:"name_template"`
	Replacements map[string]string
	Files        []string
}

Archive config used for the archive

type Build

type Build struct {
	Goos       []string
	Goarch     []string
	Main       string
	Ldflags    string
	Flags      string
	BinaryName string `yaml:"binary_name"` // deprecated
	Binary     string
	Hooks      Hooks
}

Build contains the build configuration section

type FPM

type FPM struct {
	Formats      []string
	Dependencies []string
	Conflicts    []string
	Options      FPMOptions
}

FPM config

type FPMOptions

type FPMOptions struct {
	Vendor      string
	URL         string
	Maintainer  string
	Description string
	License     string
}

FPM config options

type Homebrew

type Homebrew struct {
	Repo         string // deprecated!
	GitHub       Repo
	Folder       string
	Caveats      string
	Plist        string
	Install      string
	Dependencies []string
	Conflicts    []string
}

Homebrew contains the brew section

type Hooks

type Hooks struct {
	Pre  string
	Post string
}

Hooks define actions to run before and/or after something

type Project

type Project struct {
	Release Release
	Brew    Homebrew
	Build   Build
	Archive Archive
	FPM     FPM `yaml:"fpm"`

	// 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

type Release

type Release struct {
	Repo   string // deprecated!
	GitHub Repo
}

Release config used for the GitHub release

type Repo

type Repo struct {
	Owner string
	Name  string
}

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