rtablada/version-master

A git based versioning tool for PHP projects with Laravel Service Providers

v1.1.0 2015-10-04 20:28 UTC

This package is not auto-updated.

Last update: 2022-09-17 07:59:41 UTC


README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

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 of Illuminate\Filesystem - Used to read from the Git File Tree
  • required - 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.