go-semantic-release/pkg/config/config.go

// Package config provides defimition of .release.yml and read method
package config

import (
	"io/ioutil"
	"os"

	log "github.com/sirupsen/logrus"
	"gopkg.in/yaml.v2"
)

const (
	DefaultTagPrefix = "v"
)

// AnalyzerConfig struct
type AnalyzerConfig struct {
	TokenSeparators []string `yaml:"tokenSeparators"`
}

// ChangelogConfig struct
type ChangelogConfig struct {
	PrintAll         bool            `yaml:"printAll,omitempty"`
	TemplateTitle    string          `yaml:"title,omitempty"`
	TemplatePath     string          `yaml:"templatePath,omitempty"`
	ShowBodyAsHeader bool            `yaml:"showBodyAsHeader,omitempty"`
	ShowAuthors      bool            `yaml:"showAuthors,omitempty"`
	Docker           ChangelogDocker `yaml:"docker,omitempty"`
	NPM              ChangelogNPM    `yaml:"npm,omitempty"`
}

//ChangelogDocker type struct
type ChangelogDocker struct {
	Latest     bool   `yaml:"latest"`
	Repository string `yaml:"repository"`
}

//ChangelogNPM type struct
type ChangelogNPM struct {
	Repository  string `yaml:"repository"`
	PackageName string `yaml:"name"`
}

//Asset type struct
type Asset struct {
	Path     string `yaml:"path"`
	Rename   string `yaml:"rename,omitempty"`
	Name     string `yaml:"name,omitempty"` // Deprecated
	Compress bool   `yaml:"compress"`
}

// GitHubProvider struct
type GitHubProvider struct {
	Repo        string `yaml:"repo"`
	User        string `yaml:"user"`
	CustomURL   string `yaml:"customUrl,omitempty"`
	AccessToken string
	TagPrefix   *string `yaml:"tagPrefix,omitempty"`
}

// GitLabProvider struct
type GitLabProvider struct {
	Repo        string `yaml:"repo"`
	CustomURL   string `yaml:"customUrl,omitempty"`
	AccessToken string
	TagPrefix   *string `yaml:"tagPrefix,omitempty"`
}

// GitProvider struct
type GitProvider struct {
	Email     string  `yaml:"email"`
	Username  string  `yaml:"user"`
	Auth      string  `yaml:"auth"`
	SSH       bool    `yaml:"ssh"`
	TagPrefix *string `yaml:"tagPrefix,omitempty"`
}

// Hooks struct
type Hooks struct {
	PreRelease  []string `yaml:"preRelease"`
	PostRelease []string `yaml:"postRelease"`
}

// Checksum struct
type Checksum struct {
	Algorithm string `yaml:"algorithm"`
}

// Checksum struct
type Integrations struct {
	NPM IntegrationNPM `yaml:"npm"`
}

// Checksum struct
type IntegrationNPM struct {
	Enabled bool   `yaml:"enabled"`
	Path    string `yaml:"path"`
}

// ReleaseConfig struct
type ReleaseConfig struct {
	CommitFormat   string            `yaml:"commitFormat"`
	Branch         map[string]string `yaml:"branch"`
	Analyzer       AnalyzerConfig    `yaml:"analyzer"`
	Changelog      ChangelogConfig   `yaml:"changelog,omitempty"`
	Release        string            `yaml:"release,omitempty"`
	GitHubProvider GitHubProvider    `yaml:"github,omitempty"`
	GitLabProvider GitLabProvider    `yaml:"gitlab,omitempty"`
	GitProvider    GitProvider       `yaml:"git,omitempty"`
	Assets         []Asset           `yaml:"assets"`
	Checksum       Checksum          `yaml:"checksum,omitempty"`
	Hooks          Hooks             `yaml:"hooks"`
	Integrations   Integrations      `yaml:"integrations"`
	ReleaseTitle   string            `yaml:"title"`
	IsPreRelease   bool
}

// Read ReleaseConfig
func Read(configPath string) (*ReleaseConfig, error) {

	content, err := ioutil.ReadFile(configPath)
	if err != nil {
		return &ReleaseConfig{}, err
	}

	log.Tracef("Found config %s", string(content))
	releaseConfig := &ReleaseConfig{}
	err = yaml.Unmarshal(content, releaseConfig)
	if err != nil {
		return &ReleaseConfig{}, err
	}

	org := *releaseConfig

	releaseConfig.Hooks = Hooks{}

	configWithoutHooks, err := yaml.Marshal(releaseConfig)
	if err != nil {
		return &ReleaseConfig{}, err
	}
	configWithoutHooks = []byte(os.ExpandEnv(string(configWithoutHooks)))
	releaseConfigWithExpanedEnvs := &ReleaseConfig{}
	err = yaml.Unmarshal(configWithoutHooks, releaseConfigWithExpanedEnvs)
	if err != nil {
		return &ReleaseConfig{}, err
	}

	releaseConfigWithExpanedEnvs.Hooks = org.Hooks

	log.Tracef("Found config %+v", releaseConfigWithExpanedEnvs)

	return releaseConfigWithExpanedEnvs, nil
}