mrombout / gochange

Go tool that helps creating and manipulating changelogs that comply to the format of Keep a Changelog.

GoChange

Go tool that helps writing changelogs.

Usage

To initialize an empty changelog for your project use the command described below.

gochange init

To add a new entry to the unreleased section of the changelog use the commands described below. The section is determined by the first world in your sentence.

gochange "Added links to navigational page."
gochange "Changed way navigation is handled."
gochange "Deprecated the use of the navigational page."
gochange "Removed links to navigational page."
gochange "Fixed link to navigation page."
gochange "Security navigational page is not longer a threat."

To bump all changes in the unreleased section up to a specific version use the command described below.

gochange release 0.1.0

gochange's Issues

Rename tool and repository

This tool is not specific to Go, so it's better to give it a more generic name like simply changelog for example.

Add support for `[YANKED]` releases

Yanked releases are versions that had to be pulled because of a serious bug or security issue. Often these versions don't even appear in change logs. They should. This is how you should display them:

[0.0.5] - 2014-12-13 [YANKED]

The [YANKED] tag is loud for a reason. It's important for people to notice it. Since it's surrounded by brackets it's also easier to parse programmatically.

• Parser should recognize the [YANKED] tag and set the Yanked field on that Release to true.
• gochange yank <release> should mark that release as [YANKED], or fail if that release doesn't exist.

No diff link rendered for first release

When doing the a first release, all items are properly moved from the Unreleased section to the release section. But at the bottom of the page, no diff link is rendered for this release:

# Changelog

Lorum ipsum dolor sit amet.

## [Unreleased]

## [v0.0.1] - 2023-04-09

### Added

- Added some new stuff.

### Changed

- Changed an existing feature.

### Deprecated

- Deprecated some old stuff, to be removed in the next release.

### Removed

- Removed some old stuff.

### Fixed

- Fixed some bugs.

### Security

- Security fix for CVE-1234-1234.

[Unreleased]: http://github.com/HEAD...HEAD

Only after the changelog is then modified again (either through a release or adding a new entry) the link is properly rendered and the link is changed to [Unreleased]: http://github.com/v0.0.1...HEAD as it should be.