https://github.com/sebastianbergmann/version

Library that helps with managing the version number of Git-hosted PHP projects
https://github.com/sebastianbergmann/version

Last synced: 14 days ago
JSON representation

Library that helps with managing the version number of Git-hosted PHP projects

• Host: GitHub
• URL: https://github.com/sebastianbergmann/version
• Owner: sebastianbergmann
• License: bsd-3-clause
• Created: 2013-01-05T14:17:33.000Z (almost 12 years ago)
• Default Branch: main
• Last Pushed: 2024-03-22T13:55:05.000Z (8 months ago)
• Last Synced: 2024-05-18T11:42:22.962Z (6 months ago)
• Language: PHP
• Homepage:
• Size: 8.31 MB
• Stars: 6,476
• Watchers: 10
• Forks: 29
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![Latest Stable Version](https://poser.pugx.org/sebastian/version/v)](https://packagist.org/packages/sebastian/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](https://getcomposer.org/):

```

composer require sebastian/version

```

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:

```

composer require --dev sebastian/version

```

## 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:

```php

asString());

```

```

string(18) "1.0.0-17-g00f3408"

```

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 in `X.Y.Z` format then `$release` is returned as-is.

* If `$path` is not (part of) a Git repository and `$release` is in `X.Y` format then `$release` is returned suffixed with `-dev`.

* 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.

* 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`.