hnhdigital-os / laravel-git-info
Get information about the current git state.
Installs: 11 772
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 2
Open Issues: 1
Requires
- php: >=5.6.0
Requires (Dev)
- codeclimate/php-test-reporter: dev-master
- mockery/mockery: 0.9.*
- phpmd/phpmd: @stable
- phpunit/phpunit: 5.*
- squizlabs/php_codesniffer: ^2.0
README
This package has been developed by H&H|Digital, an Australian botique developer. Visit us at hnh.digital.
Provides a wrapper for getting info from GIT.
Install
Via composer:
$ composer require hnhdigital-os/laravel-git-info ~1.0
Laravel configuration
Enable the facade by editing config/app.php:
'aliases' => [ ... 'Git' => Bluora\LaravelGitInfo\Facade::class, ... ];
The service provider will autoload from Laravel 5.5.
To enable the service provider in versions prior to Laravel 5.4, edit the config/app.php:
Enable the service provider by editing config/app.php:
'providers' => [ ... Bluora\LaravelGitInfo\ServiceProvider::class, ... ];
Usage
Laravel
Current version. Eg 'de83088-dirty'.
echo Git::version();
Current branch. Eg 'master'.
echo Git::branch();
Current total commits. Eg 7.
echo Git::commits();
Commit difference between current branch and master.
Optional arguments include specifying a branch and returning a text version.
echo Git::commitsBehind($branch = 'master', $return_text = true);
Show the status of the submodules.
echo Git::submoduleStatus();
PHP
use Bluora\LaravelGitInfo\GitInfo; echo (new GitInfo())->version();
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.