git-changelog

command module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 28, 2016 License: MIT Imports: 11 Imported by: 0

README

git changelog - Automatic markdown changelog generator

Preconditions

This will help you if following preconditiona are met:

  • Your project follows http://semver.org
  • Semver versions are git tags
  • You accept changes exclusevely via PRs (i.e. there are git merges)
  • Each PR has tags in the beggining of git title (ex. [fixes] [bug] [new feature] etc)

Installation

$ go get github.com/kron4eg/git-changelog
$ mv $GOPATH/bin/git-changelog /usr/loca/bin/ # actually anywhere in the $PATH

Usage

$ cd your/git/repo
$ git changelog > CHANGELOG.md
$ git add CHANGELOG.md; git commit

Limitations

Currently only one tag per merge (PR) is supported

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL