changelog

package
v1.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 22, 2022 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
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

View Source 
var (

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

Functions

This section is empty.

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.