changelog

Documentation

Index

• Constants
• Variables
• type Task
  • func (t Task) Run(ctx *context.Context) error
  • func (t Task) Skip(ctx *context.Context) bool
  • func (t Task) String() string

Constants

const (
	//  MarkdownFile defines the name of the changelog markdown file within a repository
	MarkdownFile = "CHANGELOG.md"

	// ChangeDate defines a date formatting used when logging a new change
	ChangeDate = "2006-01-02"
)

Variables

var (

	// ErrNoAppendHeader is reported if a changelog is missing the expected append header
	ErrNoAppendHeader = errors.New("changelog missing supported append header")
)

Types

type Task

type Task struct{}

Task that generates a changelog for the current repository

func (Task) Run

func (t Task) Run(ctx *context.Context) error

Run the task

func (Task) Skip

func (t Task) Skip(ctx *context.Context) bool

Skip running the task if no changelog is needed

func (Task) String

func (t Task) String() string

String generates a string representation of the task