linker

Documentation

Overview

Package linker implements linking dependency changelogs when they get updated.

Index

• type Linker
  • func New(mappers ...Mapper) Linker
  • func (l Linker) Link(cl *changelog.Changelog) error
  • func (l Linker) Map(dep changelog.Dependency) string
• type Mapper

Types

type Linker

type Linker struct {
	Mappers []Mapper
}

Linker is an object containing a map of Mappers that will be applied to Map a changelog to a dependency.

func New

func New(mappers ...Mapper) Linker

func (Linker) Link

func (l Linker) Link(cl *changelog.Changelog) error

Link will try to Link all the dependencies in a changelog.yml to the changelogs found in the mappers.

func (Linker) Map

func (l Linker) Map(dep changelog.Dependency) string

Map will iterate all the mappers to map dependencies with their changelogs.

type Mapper

type Mapper interface {
	Map(dep changelog.Dependency) string
}

Mapper is any object that can link to a changelog for a dependency.