Chris@0: # Version
Chris@0: 
Chris@0: **Version** is a library that helps with managing the version number of Git-hosted PHP projects.
Chris@0: 
Chris@0: ## Installation
Chris@0: 
Chris@14: You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
Chris@14: 
Chris@14:     composer require sebastian/version
Chris@14: 
Chris@14: If you only need this library during development, for instance to run your project's test suite, then you should add it as a development-time dependency:
Chris@14: 
Chris@14:     composer require --dev sebastian/version
Chris@0: 
Chris@0: ## Usage
Chris@0: 
Chris@0: The constructor of the `SebastianBergmann\Version` class expects two parameters:
Chris@0: 
Chris@0: * `$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.
Chris@0: * `$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.
Chris@0: 
Chris@0: Apart from the constructor, the `SebastianBergmann\Version` class has a single public method: `getVersion()`.
Chris@0: 
Chris@0: Here is a contrived example that shows the basic usage:
Chris@0: 
Chris@0:     <?php
Chris@0:     $version = new SebastianBergmann\Version(
Chris@0:       '3.7.10', '/usr/local/src/phpunit'
Chris@0:     );
Chris@0: 
Chris@0:     var_dump($version->getVersion());
Chris@0:     ?>
Chris@0: 
Chris@0:     string(18) "3.7.10-17-g00f3408"
Chris@0: 
Chris@0: When a new release is prepared, the string that is passed to the constructor as the first argument needs to be updated.
Chris@0: 
Chris@0: ### How SebastianBergmann\Version::getVersion() works
Chris@0: 
Chris@0: * If `$path` is not (part of) a Git repository and `$release` is in `X.Y.Z` format then `$release` is returned as-is.
Chris@0: * If `$path` is not (part of) a Git repository and `$release` is in `X.Y` format then `$release` is returned suffixed with `-dev`.
Chris@0: * 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.
Chris@0: * 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`.