githelper

Documentation

Index

• type Config
• type Plugin
  • func New() *Plugin
  • func (p *Plugin) Boot(conf interface{}, dependencies ...interface{}) plugins.Plugin
  • func (p *Plugin) Close() error
  • func (p *Plugin) GitCommitMessage() string
  • func (p *Plugin) GitTag(annotation string, msg string) error
  • func (p *Plugin) IsEnabled() bool
  • func (p *Plugin) Name() string
  • func (p *Plugin) NextVersion(v string, next Semver) (*semver.Version, error)
  • func (p *Plugin) SemVer(msg string) Semver
  • func (p *Plugin) Start() error
  • func (p *Plugin) TagVersion() (*semver.Version, error)
• type Semver

Types

type Config

type Config struct {
	Enable bool `env:"GITHELPER_ENABLE" default:"false" yaml:"enable" json:"enable"`
}

type Plugin

type Plugin struct {
	Logger *log.Entry
	// contains filtered or unexported fields
}

func New

func New() *Plugin

func (*Plugin) Boot

func (p *Plugin) Boot(conf interface{}, dependencies ...interface{}) plugins.Plugin

func (*Plugin) Close

func (p *Plugin) Close() error

func (*Plugin) GitCommitMessage

func (p *Plugin) GitCommitMessage() string

func (*Plugin) GitTag

func (p *Plugin) GitTag(annotation string, msg string) error

func (*Plugin) IsEnabled

func (p *Plugin) IsEnabled() bool

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) NextVersion

func (p *Plugin) NextVersion(v string, next Semver) (*semver.Version, error)

func (*Plugin) SemVer

func (p *Plugin) SemVer(msg string) Semver

func (*Plugin) Start

func (p *Plugin) Start() error

func (*Plugin) TagVersion

func (p *Plugin) TagVersion() (*semver.Version, error)

type Semver

type Semver int

const (
	Name        = "githelper"
	None Semver = iota
	Major
	Minor
	Patch
)