f3ath/git-changelog

Changelog Release Notes Generator for Git and PHP

Changelog generator for Git and PHP

Generates release notes in changelog format. Like this:, _(*1)

## [0.0.1] - 2016-12-24
- RepoDetector fix
- Update README.md
- composer binary
- Initial commit

And like this:, _(*2)

## [0.0.2](https://github.com/f3ath/git-changelog/compare/0.0.1...0.0.2) - 2016-12-24
- Added: README example

Install

With composer:, _(*3)

composer require f3ath/git-changelog --dev

Usage

For the latest tag:, _(*4)

vendor/bin/changelog

For an arbitrary tag:, _(*5)

vendor/bin/changelog 0.0.3

Configuration

By default, the remote named "origin" is used for getting details about tags, building the comparison URL, etc. It is possible to change this behavior by placing a configuration file .changelog.json in the current directory., _(*6)

{
  "remote": "upstream"
}

Troubleshooting

Make sure you have fetched the latest state of your remote before running the generator., _(*7)

git fetch upstream

Contributing

is always welcome., _(*8)