changelog

Documentation

Index

• type UnifiedChangelog
  • func NewUnifiedChangelog(changelogs ...*VersionChangelog) UnifiedChangelog
  • func (c UnifiedChangelog) String() string
• type VersionChangelog
  • func Parse(repo string, changelog string) ([]*VersionChangelog, error)

Types

type UnifiedChangelog

type UnifiedChangelog map[string][]string

UnifiedChangelog is a map of repos to their changelog sections

func NewUnifiedChangelog

func NewUnifiedChangelog(changelogs ...*VersionChangelog) UnifiedChangelog

NewUnifiedChangelog creates a unified changelog from varios per-version and per-repo changelogs

func (UnifiedChangelog) String

func (c UnifiedChangelog) String() string

type VersionChangelog

type VersionChangelog struct {
	Repo     string
	Version  string
	Date     string
	Sections map[string][]string
}

VersionChangelog contains a full changelog for a version of a repo

func Parse

func Parse(repo string, changelog string) ([]*VersionChangelog, error)

Parse extracts and returns a slice of changelogs, one for each version. Parse assumes a changelog in the [keep a changelog](https://keepachangelog.com/) format:

changelog title

A cool description (optional).

## unreleased * foo

## x.y.z - YYYY-MM-DD (or DD.MM.YYYY, D/M/YY, etc.) * bar

## a.b.c

### Changes

* Update API * Fix bug #1

## 2.2.3-pre.1 - 2013-02-14 * Update API

## 2.0.0-x.7.z.92 - 2013-02-14 * bark bark * woof * arf

## v1.3.0

* make it so

## [1.2.3](link) * init