README.md (1863B)
1 # Version 2 3 **Version** is a library that helps with managing the version number of Git-hosted PHP projects. 4 5 ## Installation 6 7 Simply add a dependency on `sebastian/version` to your project's `composer.json` file if you use [Composer](http://getcomposer.org/) to manage the dependencies of your project. 8 9 ## Usage 10 11 The constructor of the `SebastianBergmann\Version` class expects two parameters: 12 13 * `$release` is the version number of the latest release (`X.Y.Z`, for instance) or the name of the release series (`X.Y`) when no release has been made from that branch / for that release series yet. 14 * `$path` is the path to the directory (or a subdirectory thereof) where the sourcecode of the project can be found. Simply passing `__DIR__` here usually suffices. 15 16 Apart from the constructor, the `SebastianBergmann\Version` class has a single public method: `getVersion()`. 17 18 Here is a contrived example that shows the basic usage: 19 20 <?php 21 $version = new SebastianBergmann\Version( 22 '3.7.10', '/usr/local/src/phpunit' 23 ); 24 25 var_dump($version->getVersion()); 26 ?> 27 28 string(18) "3.7.10-17-g00f3408" 29 30 When a new release is prepared, the string that is passed to the constructor as the first argument needs to be updated. 31 32 ### How SebastianBergmann\Version::getVersion() works 33 34 * If `$path` is not (part of) a Git repository and `$release` is in `X.Y.Z` format then `$release` is returned as-is. 35 * If `$path` is not (part of) a Git repository and `$release` is in `X.Y` format then `$release` is returned suffixed with `-dev`. 36 * If `$path` is (part of) a Git repository and `$release` is in `X.Y.Z` format then the output of `git describe --tags` is returned as-is. 37 * If `$path` is (part of) a Git repository and `$release` is in `X.Y` format then a string is returned that begins with `X.Y` and ends with information from `git describe --tags`.