changes

Documentation

Index

• func ExtractSection(fn string, vstring string) (io.Reader, error)
• type CheckMode
• type Error
  • func (e *Error) Error() string
• type Failure
• type Failures
  • func (fs Failures) String() string
• type Linter
  • func NewLinter(r io.Reader, mode CheckMode) *Linter
  • func (l *Linter) Check() error

Functions

func ExtractSection

func ExtractSection(fn string, vstring string) (io.Reader, error)

ExtractSection will return a reader that will output the bullets that are written below the changelog heading for the given version. The first argument is the file name of the changelog to open and the second line is a semver string to search for. Returns an error if there is a problem reading the file or if the version heading is not found.

Types

type CheckMode

type CheckMode int

const (
	CheckStandard CheckMode = 0 + iota
	CheckPreRelease
	CheckRelease
)

type Error

type Error struct {
	Failures
}

func (*Error) Error

func (e *Error) Error() string

type Failure

type Failure struct {
	Line    int
	Message string
}

type Failures

type Failures []Failure

func (Failures) String

func (fs Failures) String() string

type Linter

type Linter struct {
	// contains filtered or unexported fields
}

func NewLinter

func NewLinter(r io.Reader, mode CheckMode) *Linter

func (*Linter) Check

func (l *Linter) Check() error