rtablada / version-master
A git based versioning tool for PHP projects with Laravel Service Providers
Installs: 1 188
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Requires
- php: >=5.3.0
- illuminate/filesystem: ^5.1
- illuminate/support: ^5.1
Requires (Dev)
- phpunit/phpunit: 4.*
- scrutinizer/ocular: ~1.1
This package is not auto-updated.
Last update: 2024-12-21 20:00:47 UTC
README
Version Master is a git based versioning tool for PHP projects with Laravel Service Providers.
This package uses the .git
storage file to read the current hash for the specified project or folder.
Since, the GitHashReader
uses file access, it does not need to have access to the git
command or exec
privileges which may not be available in production environments.
Install
Via Composer
$ composer require rtablada/version-master
Usage
The basic class for this package is the GitHashReader
.
It requires two arguments:
required
- An instance ofIlluminate\Filesystem
- Used to read from the Git File Treerequired
- A string path for the root of the git project.optional
- A string path for the name of the git storage folder (defaults to.git
)
$reader = new Rtablada\VersionMaster\GitHashReader(); echo $reader->getFullVersion(); // Outputs latest hash on git HEAD
Laravel Usage
This package also includes a Service Provider to allow use in Laravel Applications.
This Service Provider acts in two ways:
- Registers a singleton so that
Rtablada\VersionMaster\GitHashReader
can be injected. - Registers a
@version()
helper in Blade to output the short version number.
To install this Service Provider just add Rtablada\VersionMaster\GitVersionProvider::class
in your providers
array in config/app.php
.
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email ryan.tablada@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.