Download the PHP package sebastian/version without Composer
On this page you can find all versions of the php package sebastian/version. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sebastian/version
More information about sebastian/version
Files in sebastian/version
Package version
Short Description Library that helps with managing the version number of Git-hosted PHP projects
License BSD-3-Clause
Homepage https://github.com/sebastianbergmann/version
Informations about the package version
sebastian/version
sebastian/version is a library that helps with managing the version number of Git-hosted PHP projects.
Installation
You can add this library as a local, per-project dependency to your project using Composer:
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:
Usage
The constructor of the SebastianBergmann\Version
class expects two parameters:
$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.$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.
Apart from the constructor, the SebastianBergmann\Version
class has a single public method: asString()
.
Here is a contrived example that shows the basic usage:
When a new release is prepared, the string that is passed to the constructor as the first argument needs to be updated.
How SebastianBergmann\Version::asString() works
- If
$path
is not (part of) a Git repository and$release
is inX.Y.Z
format then$release
is returned as-is. - If
$path
is not (part of) a Git repository and$release
is inX.Y
format then$release
is returned suffixed with-dev
. - If
$path
is (part of) a Git repository and$release
is inX.Y.Z
format then the output ofgit describe --tags
is returned as-is. - If
$path
is (part of) a Git repository and$release
is inX.Y
format then a string is returned that begins withX.Y
and ends with information fromgit describe --tags
.