eiriksm / git-log-format
This package is abandoned and no longer maintained.
The author suggests using the violinist-dev/git-log-format package instead.
There is no license information available for the latest version (1.0.0) of this package.
Format changelog-like git logs
1.0.0
2019-01-29 20:52 UTC
Requires (Dev)
- phpunit/phpunit: ^6
- satooshi/php-coveralls: ^2.0
- squizlabs/php_codesniffer: ^3.4
This package is not auto-updated.
Last update: 2019-02-20 21:12:17 UTC
README
A convenience package to get formatted versions of the output of git log --oneline.
This is part of what powers the changelogs in the messages from Violinist.io.
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:
git log abababa..fefefef --oneline
In the above example, abababa and fefefef are both hashes in the commit history.
The output would be somewhat like this:
fefefef Fix bugs and add tests
cdcdcdc Release features and probably introduce bugs
Then, pass the output to this package:
$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