This package is intended to give a useful option for getting the hash from the current commit.
try {
$retriever = Retriever::getWithFactory(GitHashFinderFactory::withDefaultFinders());
echo $retriever->getHash($path)->hash() . PHP_EOL;
} catch (GitHashException $exception) {
echo 'Failed to get the hash ' . $exception->getMessage() . PHP_EOL;
}See docs/examples for examples about how to use this package.
You can install this package with composer by executing the command: composer require tjvb/githash.
The package provide 3 different GitHashFinder they all have some pro's and con's.
| GitHashFinder | Requirements | Benefits | Cons |
|---|---|---|---|
| GitProcessCommandHashFinder | The symfony/process package and git executable. | This execute the git commands with the symfony/process package to get good feedback. | You need to install this package and have the git command available. |
| GitShellExecCommandHashFinder | The shell_exec PHP function and git executable. | This execute the git commands. | You need to have shell_exec and the git command available. |
| GitFileSystemHashFinder | A branch. | It reads the git files and doesn't need to have a git executable. | The repository need to have a branch, it doesn't work with a detached head. |
If you use Laravel you can use tjvb/laravel-githash, this package can add the hash to your log files and provides a blade component to show the hash.
We (try to) document all the changes in CHANGELOG so read it for more information.
You are welcome to contribute, read about it in CONTRIBUTING
The MIT License (MIT). Please see License File for more information.