changelog

Documentation

Index

• func FormatBitbucketReference(ref Reference, w io.Writer) (int64, error)
• func FormatGithubReference(ref Reference, w io.Writer) (int64, error)
• func Init(wr io.Writer, data InitTemplateData) error
• type Changes
  • func NewChanges(tag string) *Changes
  • func (changes *Changes) WriteTo(w io.Writer) (int64, error)
• type Contents
  • func Parse(r io.Reader) (*Contents, error)
  • func (contents *Contents) WriteTo(w io.Writer) (int64, error)
• type InitTemplateData
• type Reference
  • func NewReferenceFromRegexp(matches []string) Reference
  • func (ref *Reference) WriteTo(w io.Writer) (int64, error)
• type ReferenceType

Functions

func FormatBitbucketReference

func FormatBitbucketReference(ref Reference, w io.Writer) (int64, error)

func FormatGithubReference

func FormatGithubReference(ref Reference, w io.Writer) (int64, error)

func Init

func Init(wr io.Writer, data InitTemplateData) error

Types

type Changes

type Changes struct {
	Tag        string
	Added      string
	Changed    string
	Deprecated string
	Fixed      string
	Removed    string
	Security   string
	Time       time.Time
}

func NewChanges

func NewChanges(tag string) *Changes

func (*Changes) WriteTo

func (changes *Changes) WriteTo(w io.Writer) (int64, error)

type Contents

type Contents struct {
	Header     string
	Changes    []*Changes
	Unreleased *Changes
	Last       *Changes
	Rest       string
	Refs       []Reference
}

func Parse

func Parse(r io.Reader) (*Contents, error)

func (*Contents) WriteTo

func (contents *Contents) WriteTo(w io.Writer) (int64, error)

type InitTemplateData

type InitTemplateData struct {
	ProjectURL string
	InitialTag string
}

type Reference

type Reference struct {
	Type      ReferenceType
	Tag       string
	Raw       string
	From      string
	To        string
	BaseURL   string
	Separator string
}

func NewReferenceFromRegexp

func NewReferenceFromRegexp(matches []string) Reference

func (*Reference) WriteTo

func (ref *Reference) WriteTo(w io.Writer) (int64, error)

type ReferenceType

type ReferenceType string

const (
	GITHUB_REFERENCE    ReferenceType = "github"
	BITBUCKET_REFERENCE               = "bitbucket"
)