parkr / changelog

Read & write changelogs

changelog

Parse markdown-esque changelogs (like our example in History.markdown), parse out versions, sections, changes & references. Motivation: automate update of changelogs

Bundled with a command, changelogger.

Supports several header formats such as SemVer and KeepAChangelog.

changelogger command

Installation

$ go get github.com/parkr/changelog/changelogger

Usage

$ $GOPATH/bin/changelogger
$ $GOPATH/bin/changelogger -h

changelog package

Installation

$ go get github.com/parkr/changelog

Usage

// Parse changelog at a given filename
changes, err := changelog.NewChangelogFromFile("CHANGELOG.md")

// Discover the filename of your changelog
filename := changelog.HistoryFilename()

// Parse changelog from some io.Reader
changes, err := changelog.NewChangeLogFromReader(req.Body)

License

MIT License, Copyright 2015 Parker Moore. See LICENSE for details.

changelog's Issues

Add support to single `#` as the version header

Some changelog presets, like conventional-changelog-angular, use # as the version header.

By the way, in this particular preset, both # and ## are used as version headers (## for patches, # for the other version types).

Instead of adding a parser preset and add complexity to the project, we could just support these two header levels.

I could create a PR if you agree with that :)

Add ability to get or create if not present

We have getVersion and getSubsection. Would be cool to also have GetVersionOrCreate and GetSubsectionOrCreate.

Support - (dash) as change line prefix

How about adding support to - as the change line prefix?

Support other date separators in the version header

Unless the intention is opinionating / as the date separator, we could just match the date itself on the version header RegExp.

IMHO I see no use case for having more than one date on it, so it would be just fine.

By doing this we would enable to support to the following header formats:

• $VERSION - $DATE
• $VERSION / $DATE
• $VERSION ($DATE)
• and so many others... 😄

Dependabot couldn't find a Gopkg.toml for this project

Dependabot couldn't find a Gopkg.toml for this project.

Dependabot requires a Gopkg.toml to evaluate your project's current Go dependencies. It had expected to find one at the path: /Gopkg.toml.

If this isn't a Go project, or if it is a library, you may wish to disable updates for it from within Dependabot.

You can mention @dependabot in the comments below to contact the Dependabot team.