sydnerdrage/php-gitver

There is no license information available for the latest version (v0.0.1) of this package.

v0.0.1 2013-10-07 07:25 UTC

Requires (Dev)

• phpunit/phpunit: 3.7.*

Unknown License

README

Simple class to parse version tags from a git working directory.

Usage

Gitver defaults to the current working directory. As such it requires no immediate configuration

use \Gitver\Git;

$gitver = new Git(__DIR__);
echo $gitver->version();

This will output a git describe of the current working directory. e.g. v0.1.1-0-abcdefg

This is a combination of:

• Most recent tag (matching a $prefixX.Y.Z format - see configuration below)
• Number of commits since that tag
• Current commit prefixed with 'g' (identifying the repository as git).

Configuration

• Working directory to retrieve version from (defaults to the current working directory)
• Tag match prefix (defaults to "v")

For example if you version tags are in the format of release-X.Y.Z then you would call

$gitver = new Git(__DIR__, "version-");

CakePHP Sample

<?php
use \Gitver\Git;

App::uses('Controller', 'Controller');

class AppController extends Controller
{
    public function beforeFilter()
    {
        parent::beforeFilter();
        $this->set("VERSION", (new Git(__DIR__))->version());
    }
}