You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

43 lines
2.0 KiB

3 years ago
  1. # Version
  2. **Version** is a library that helps with managing the version number of Git-hosted PHP projects.
  3. ## Installation
  4. You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
  5. composer require sebastian/version
  6. 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:
  7. composer require --dev sebastian/version
  8. ## Usage
  9. The constructor of the `SebastianBergmann\Version` class expects two parameters:
  10. * `$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.
  11. * `$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.
  12. Apart from the constructor, the `SebastianBergmann\Version` class has a single public method: `getVersion()`.
  13. Here is a contrived example that shows the basic usage:
  14. <?php
  15. $version = new SebastianBergmann\Version(
  16. '3.7.10', '/usr/local/src/phpunit'
  17. );
  18. var_dump($version->getVersion());
  19. ?>
  20. string(18) "3.7.10-17-g00f3408"
  21. When a new release is prepared, the string that is passed to the constructor as the first argument needs to be updated.
  22. ### How SebastianBergmann\Version::getVersion() works
  23. * If `$path` is not (part of) a Git repository and `$release` is in `X.Y.Z` format then `$release` is returned as-is.
  24. * If `$path` is not (part of) a Git repository and `$release` is in `X.Y` format then `$release` is returned suffixed with `-dev`.
  25. * 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.
  26. * 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`.