PHPackages                             digilive/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. digilive/git-changelog

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

digilive/git-changelog
======================

Generate a changelog from git commits of the local repository

v2.0.1(3y ago)72.0k3BSD-3-ClausePHPPHP ^7.3 || ^8.0

Since Oct 21Pushed 3y ago2 watchersCompare

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

READMEChangelog (5)Dependencies (3)Versions (14)Used By (3)

gitChangelog
============

[](#gitchangelog)

[![GitHub release](https://camo.githubusercontent.com/8a05a4e1faab5f981dbaf906870ba0fb798ef8608dfe1ee7d22673d376d97899/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f446967694c6976652f6769744368616e67656c6f67)](https://github.com/DigiLive/gitChangelog/releases)[![License](https://camo.githubusercontent.com/b3775a2de17853a90995faa104f941eef3ad3c40cc89e34b8b1eaea014614d4e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d425344253230332d2d436c617573652d626c75652e737667)](https://opensource.org/licenses/BSD-3-Clause)[![Codacy Badge](https://camo.githubusercontent.com/7f996265dd7415344a5797c4218ec6e90ed0e0d7e7250fa61381f5372cfc2883/68747470733a2f2f6170702e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f3766303434373536333636313439346461616330633466616534333335616330)](https://www.codacy.com/gh/DigiLive/gitChangelog/dashboard?utm_source=github.com&utm_medium=referral&utm_content=DigiLive/gitChangelog&utm_campaign=Badge_Grade)

Generate a changelog from git commits of the local repository.

This library parses information which is stored in a Git repository. From this information, it generates a changelog which can be saved to a file. The information is extracted from the branch which is currently checked out.

Take a look at this [example](CHANGELOG.md). It is the changelog of the GitChangelog repository, build by this library.

If you have any questions, comments or ideas concerning this library, Please consult the [Wiki](https://github.com/DigiLive/gitChangelog/wiki) at first. Create a new [issue](https://github.com/DigiLive/gitChangelog/issues/new) if your concerns remain unanswered.

Features
--------

[](#features)

### Main

[](#main)

- Markdown and Html renderers included.
- Choose included renderers or create your own.
- List Tags and their date.
- List unique commit titles per tag.
- List commit hashes per unique title (optional).
- Include commit titles (and hashes) of the HEAD revision (E.g. Unreleased changes).

### Other

[](#other)

- Use another local repository as information source.
- Set a tag range to limit the changelog.
- Filter titles by labels1.
- Set a custom title for the changelog (E.g. a header).
- Set a custom title for the HEAD revision (E.g. Next release version).
- Set a custom date for the HEAD revision (E.g. Next release date).
- Set a custom message to indicate there are no commits present.
- In- or exclude merge commits.
- Set an ordering key for sorting tags/releases2.
- Set the sort order of tags/releases.
- Set the sort order of titles.

1. A label is considered to be the first word of a commit title.
2. Using an invalid key will result in unlisted changes or when enabled, just the changes of the HEAD revision.

#### Markdown Renderer

[](#markdown-renderer)

- Define a custom format for Tag/Release lines.
- Define a custom format for title lines.
- Format hashes into links to the commit-view of the remote repository provider.
- Format issues into links to issue-tracker of the remote repository provider.
- Format issues into links to merge-request (aka pull-request) view of the remote repository provider.

#### Html Renderer

[](#html-renderer)

- Format hashes into links to the commit-view of the remote repository provider.
- Format issues into links to issue-tracker of the remote repository provider.
- Format issues into links to merge-request (aka pull-request) view of the remote repository provider.

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

[](#installation)

The preferred method is to install the library with [Composer](http://getcomposer.org).

```
> composer require digilive/git-changelog:^2
```

Set the version constraint to a value which suits you best.
Alternatively you can download the latest release from [GitHub](https://github.com/DigiLive/gitChangelog/releases).

Minimal Example use
-------------------

[](#minimal-example-use)

```