PHPackages                             cshekharsharma/git-changelog - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. cshekharsharma/git-changelog

ActiveLibrary[Utility & Helpers](/categories/utility)

cshekharsharma/git-changelog
============================

Changelog generator from git log history

v1.0.0(8y ago)61.5k1[2 issues](https://github.com/cshekharsharma/git-changelog/issues)MITPHPPHP >=5.5.0

Since Mar 18Pushed 7y ago1 watchersCompare

[ Source](https://github.com/cshekharsharma/git-changelog)[ Packagist](https://packagist.org/packages/cshekharsharma/git-changelog)[ RSS](/packages/cshekharsharma-git-changelog/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

Git Change Log
--------------

[](#git-change-log)

A simple PHP library for generating changelog file by parsing git log history.

[![Latest Stable Version](https://camo.githubusercontent.com/7b8b9185ca6f69eaa4db4e0a79f7efc1cfd999451ebbc590d49257de81aceaeb/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f637368656b686172736861726d612f6769742d6368616e67656c6f672e737667)](https://packagist.org/packages/cshekharsharma/git-changelog)[![Minimum PHP Version](https://camo.githubusercontent.com/98118bf0a3c8b650013ffc8a5d96731efc81154ae06ef7133f378875dedea4f6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344253230352e352d3838393242462e737667)](https://php.net/)[![Build Status](https://camo.githubusercontent.com/39880c62f7b6f64020f16a7668c9af6956bb5f83b015e8b0b2f86a6478d5ee8d/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f637368656b686172736861726d612f6769742d6368616e67656c6f672f6d61737465722e737667)](https://travis-ci.org/cshekharsharma/git-changelog)[![License](https://camo.githubusercontent.com/f45d904953153ca304a2328243d2733e095eee13a631a1f390709885d41dd692/68747470733a2f2f706f7365722e707567782e6f72672f6c61726176656c2f6672616d65776f726b2f6c6963656e73652e737667)](https://packagist.org/packages/cshekharsharma/git-changelog)

git-changelog parses the git history at provided `working directory` within the duration of `start date` and `end date`, and generates change logs.

Changelogs can be generated in following output formats, by setting `output format` property while generating logs.

- Markdown (Standard MD format)
- Remarkup (See Phabricator remarkup guide)
- HTML
- JSON

Commit format
-------------

[](#commit-format)

git-changelog expects commits to be in following format-

`type : commit-message`

Type can be one of the following values-

- fix
- feature
- general
- security

if commit message does not follow this format, or the provided `type` is other than the provided 4 types, then the commit message is categories under `general` type.

Installation
------------

[](#installation)

Install the latest version with

```
$ composer require cshekharsharma/git-changelog
```

Basic Usage
-----------

[](#basic-usage)

```