command
module
Version:
v0.1.3
Opens a new window with list of versions in this module.
Published: Jan 28, 2016
License: MIT
Opens a new window with license information.
Imports: 11
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
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
¶
There is no documentation for this package.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.