mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-10 03:47:03 +02:00
299 lines
9.2 KiB
Go
299 lines
9.2 KiB
Go
// Package config contains the model and loader of the goreleaser configuration
|
|
// file.
|
|
package config
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"io/ioutil"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/apex/log"
|
|
yaml "gopkg.in/yaml.v2"
|
|
)
|
|
|
|
// GitHubURLs holds the URLs to be used when using github enterprise
|
|
type GitHubURLs struct {
|
|
API string `yaml:"api,omitempty"`
|
|
Upload string `yaml:"upload,omitempty"`
|
|
Download string `yaml:"download,omitempty"`
|
|
}
|
|
|
|
// Repo represents any kind of repo (github, gitlab, etc)
|
|
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"`
|
|
}
|
|
|
|
// String of the repo, e.g. owner/name
|
|
func (r Repo) String() string {
|
|
return r.Owner + "/" + r.Name
|
|
}
|
|
|
|
// Homebrew contains the brew section
|
|
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"`
|
|
}
|
|
|
|
// CommitAuthor is the author of a Git commit
|
|
type CommitAuthor struct {
|
|
Name string `yaml:",omitempty"`
|
|
Email string `yaml:",omitempty"`
|
|
}
|
|
|
|
// Hooks define actions to run before and/or after something
|
|
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"`
|
|
}
|
|
|
|
// IgnoredBuild represents a build ignored by the user
|
|
type IgnoredBuild struct {
|
|
Goos, Goarch, Goarm string
|
|
|
|
// Capture all undefined fields and should be empty after loading
|
|
XXX map[string]interface{} `yaml:",inline"`
|
|
}
|
|
|
|
// Build contains the build configuration section
|
|
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"`
|
|
}
|
|
|
|
// FormatOverride is used to specify a custom format for a specific GOOS.
|
|
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"`
|
|
}
|
|
|
|
// Archive config used for the 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"`
|
|
}
|
|
|
|
// Release config used for the GitHub 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"`
|
|
}
|
|
|
|
// FPM config
|
|
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"`
|
|
Files map[string]string `yaml:",omitempty"`
|
|
|
|
// Capture all undefined fields and should be empty after loading
|
|
XXX map[string]interface{} `yaml:",inline"`
|
|
}
|
|
|
|
// SnapcraftAppMetadata for the binaries that will be in the snap package
|
|
type SnapcraftAppMetadata struct {
|
|
Plugs []string
|
|
Daemon string
|
|
}
|
|
|
|
// Snapcraft config
|
|
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"`
|
|
}
|
|
|
|
// Snapshot config
|
|
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"`
|
|
}
|
|
|
|
// Checksum config
|
|
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"`
|
|
}
|
|
|
|
// Docker image config
|
|
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"`
|
|
Files []string `yaml:"extra_files,omitempty"`
|
|
|
|
// Capture all undefined fields and should be empty after loading
|
|
XXX map[string]interface{} `yaml:",inline"`
|
|
}
|
|
|
|
// Project includes all project configuration
|
|
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"`
|
|
|
|
// this is a hack ¯\_(ツ)_/¯
|
|
SingleBuild Build `yaml:"build,omitempty"`
|
|
|
|
// should be set if using github enterprise
|
|
GitHubURLs GitHubURLs `yaml:"github_urls,omitempty"`
|
|
|
|
// test only property indicating the path to the dist folder
|
|
Dist string `yaml:"-"`
|
|
|
|
// Capture all undefined fields and should be empty after loading
|
|
XXX map[string]interface{} `yaml:",inline"`
|
|
}
|
|
|
|
// Load config file
|
|
func Load(file string) (config Project, err error) {
|
|
f, err := os.Open(file)
|
|
if err != nil {
|
|
return
|
|
}
|
|
log.WithField("file", file).Info("loading config file")
|
|
return LoadReader(f)
|
|
}
|
|
|
|
// LoadReader config via io.Reader
|
|
func LoadReader(fd io.Reader) (config Project, err error) {
|
|
data, err := ioutil.ReadAll(fd)
|
|
if err != nil {
|
|
return config, err
|
|
}
|
|
if err := yaml.Unmarshal(data, &config); err != nil {
|
|
return config, err
|
|
}
|
|
log.WithField("config", config).Debug("loaded config file")
|
|
return config, checkOverflows(config)
|
|
}
|
|
|
|
func checkOverflows(config Project) error {
|
|
var overflow = &overflowChecker{}
|
|
overflow.check(config.XXX, "")
|
|
overflow.check(config.Archive.XXX, "archive")
|
|
for i, ov := range config.Archive.FormatOverrides {
|
|
overflow.check(ov.XXX, fmt.Sprintf("archive.format_overrides[%d]", i))
|
|
}
|
|
overflow.check(config.Brew.XXX, "brew")
|
|
overflow.check(config.Brew.GitHub.XXX, "brew.github")
|
|
for i, build := range config.Builds {
|
|
overflow.check(build.XXX, fmt.Sprintf("builds[%d]", i))
|
|
overflow.check(build.Hooks.XXX, fmt.Sprintf("builds[%d].hooks", i))
|
|
for j, ignored := range build.Ignore {
|
|
overflow.check(ignored.XXX, fmt.Sprintf("builds[%d].ignored_builds[%d]", i, j))
|
|
}
|
|
}
|
|
overflow.check(config.FPM.XXX, "fpm")
|
|
overflow.check(config.Snapcraft.XXX, "snapcraft")
|
|
overflow.check(config.Release.XXX, "release")
|
|
overflow.check(config.Release.GitHub.XXX, "release.github")
|
|
overflow.check(config.SingleBuild.XXX, "build")
|
|
overflow.check(config.SingleBuild.Hooks.XXX, "builds.hooks")
|
|
for i, ignored := range config.SingleBuild.Ignore {
|
|
overflow.check(ignored.XXX, fmt.Sprintf("builds.ignored_builds[%d]", i))
|
|
}
|
|
overflow.check(config.Snapshot.XXX, "snapshot")
|
|
overflow.check(config.Checksum.XXX, "checksum")
|
|
for i, docker := range config.Dockers {
|
|
overflow.check(docker.XXX, fmt.Sprintf("docker[%d]", i))
|
|
}
|
|
return overflow.err()
|
|
}
|
|
|
|
type overflowChecker struct {
|
|
fields []string
|
|
}
|
|
|
|
func (o *overflowChecker) check(m map[string]interface{}, ctx string) {
|
|
for k := range m {
|
|
var key = fmt.Sprintf("%s.%s", ctx, k)
|
|
if ctx == "" {
|
|
key = k
|
|
}
|
|
o.fields = append(o.fields, key)
|
|
}
|
|
}
|
|
|
|
func (o *overflowChecker) err() error {
|
|
if len(o.fields) == 0 {
|
|
return nil
|
|
}
|
|
return fmt.Errorf(
|
|
"unknown fields in the config file: %s",
|
|
strings.Join(o.fields, ", "),
|
|
)
|
|
}
|