releaseman

Documentation

Index

• Constants
• Variables
• func WriteChangelog(commits, taggedCommits []git.CommitModel, config Config, append bool) error
• type Changelog
• type ChangelogContentItemModel
• type ChangelogModel
• type Config
  • func NewConfigFromBytes(bytes []byte) (Config, error)
  • func NewConfigFromFile(pth string) (Config, error)
  • func (config Config) Print(mode PrintMode)
• type PrintMode
• type Release

Constants

const ChangelogContentTemplate = `` /* 251-byte string literal not displayed */

ChangelogContentTemplate ...

const ChangelogFooterTemplate = `Updated: {{.CurrentDate.Format "2006 Jan 02"}}`

ChangelogFooterTemplate ...

const ChangelogHeaderTemplate = `## Changelog (Current version: {{.Version}})`

ChangelogHeaderTemplate ...

const (
	// DefaultConfigPth ...
	DefaultConfigPth = "./release_config.yml"
)

Variables

var (
	// IsCIMode ...
	IsCIMode = false
)

Functions

func WriteChangelog

func WriteChangelog(commits, taggedCommits []git.CommitModel, config Config, append bool) error

WriteChangelog ...

Types

type Changelog

type Changelog struct {
	Path            string `yaml:"path"`
	ContentTemplate string `yaml:"content_template"`
	HeaderTemplate  string `yaml:"header_template"`
	FooterTemplate  string `yaml:"footer_template"`
}

Changelog ...

type ChangelogContentItemModel

type ChangelogContentItemModel struct {
	StartTaggedCommit git.CommitModel
	EndTaggedCommit   git.CommitModel
	Commits           []git.CommitModel
}

ChangelogContentItemModel ...

type ChangelogModel

type ChangelogModel struct {
	ContentItems []ChangelogContentItemModel
	Version      string
	CurrentDate  time.Time
}

ChangelogModel ..

type Config

type Config struct {
	Release   Release   `yaml:"release,omitempty"`
	Changelog Changelog `yaml:"changelog,omitempty"`
}

Config ...

func NewConfigFromBytes

func NewConfigFromBytes(bytes []byte) (Config, error)

NewConfigFromBytes ...

func NewConfigFromFile

func NewConfigFromFile(pth string) (Config, error)

NewConfigFromFile ...

func (Config) Print

func (config Config) Print(mode PrintMode)

Print ...

type PrintMode

type PrintMode uint8

PrintMode ...

const (
	// FullMode ...
	FullMode PrintMode = iota
	// ChangelogMode ...
	ChangelogMode
	// ReleaseMode ...
	ReleaseMode
)

type Release

type Release struct {
	DevelopmentBranch string `yaml:"development_branch"`
	ReleaseBranch     string `yaml:"release_branch"`
	Version           string `yaml:"version,omitempty"`
}

Release ...