GiienaAstrella/changelog

A simple tool to manage Keep a Changelog changelogs

★ 0Forks 0GoGitHub ↗Compare
changeloggokeep-a-changelognodejsnpm

README

Changelog

A simple tool to manage Keep a Changelog changelogs.

USAGE:
    changelog command [command options] [arguments...]

COMMANDS:
    get      show changes for a specific version(s)
    prepare  prepare changelog for next cycle
    promote  promote unreleased
    version  print the app version
    help, h  Shows a list of commands or help for one command

Why

Communicating changes between versions in a project is important. There are various ways to do this and various formats. With multiple projects, this can easily grow out of hands.

Personally, I follow the Keep a Changelog format. At DDV, we also use the Keep a Changelog format.

Why Go

My projects and DDV projects are written in various languages, using various tech stacks, on various platforms. To avoid rewriting this tool as hacky scripts for every single project (been there, done that), and to keep the dependency list minimal, whatever language I use must compile into native binaries. Many languages can achieve this goal, but I am most comfortable with Go.

Installation

There are various ways to install Changelog.

Manual

You can download the pre-compiled binaries for supported platforms from the release page.

Simply extract this archive.

From source

On systems with Go installed, run the tool install from source.

go install giiena.me/changelog@latest

Contributors

GiienaAstrella

Issues