violinist-dev/git-log-format

Format changelog-like git logs

git-log-format

, _(*1)

A convenience package to get formatted versions of the output of git log --oneline., _(*2)

This is part of what powers the changelogs in the messages from Violinist.io., _(*3)

Installation

composer require violinist-dev/git-log-format

Usage

Somehow get a string output from a git log. A command line way to do so is the following:, _(*4)

git log abababa..fefefef --oneline

In the above example, abababa and fefefef are both hashes in the commit history., _(*5)

The output would be somewhat like this:, _(*6)

fefefef Fix bugs and add tests
cdcdcdc Release features and probably introduce bugs

Then, pass the output to this package:, _(*7)

$data = \Violinist\GitLogFormat\ChangeLogData::createFromString('fefefef Fix bugs and add tests
cdcdcdc Release features and probably introduce bugs');
// Now add some info about what the source of the log is. Like so:
$data->setGitSource('https://github.com/myname/mypackage');
// Then get convenient output back, with links to the actual commits:
print $data->getAsMarkdown();
// Prints:
// - [fefefef](https://github.com/myname/mypackage/commit/fefefef) `Fix bugs and add tests`
// - [cdcdcdc](https://github.com/myname/mypackage/commit/cdcdcdc) `Release features and probably introduce bugs`