config

Documentation

Overview

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

Index

• Constants
• type AnalyzerConfig
• type Asset
• type ChangelogConfig
• type ChangelogDocker
• type ChangelogNPM
• type Checksum
• type GitHubProvider
• type GitLabProvider
• type GitProvider
• type Hooks
• type ReleaseConfig
  • func Read(configPath string) (*ReleaseConfig, error)

Constants

const (
	DefaultTagPrefix = "v"
)

Types

type AnalyzerConfig

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

AnalyzerConfig struct

type Asset

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

Asset type struct

type ChangelogConfig

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

ChangelogConfig struct

type ChangelogDocker

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

ChangelogDocker type struct

type ChangelogNPM

type ChangelogNPM struct {
	YARN       bool   `yaml:"latest"`
	Repository string `yaml:"repository"`
}

ChangelogNPM type struct

type Checksum

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

Checksum struct

type GitHubProvider

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

GitHubProvider struct

type GitLabProvider

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

GitLabProvider struct

type GitProvider

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

GitProvider struct

type Hooks

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

Hooks struct

type ReleaseConfig

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"`
	ReleaseTitle   string            `yaml:"title"`
	IsPreRelease   bool
}

ReleaseConfig struct

func Read

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

Read ReleaseConfig