WPSDK/v-wordpress-plugin-updater
0
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/djav1985/v-wordpress-plugin-updater.git synced 2026-04-24 04:03:01 +08:00
Code Issues Packages Activity Actions
v-wordpress-plugin-updater/vendor/sebastian/version
History
Exact
nikolai@vontainment.com afe656c55b modified: .gitignore 
modified:   composer.lock
	modified:   mu-plugin/v-sys-plugin-updater-mu.php
	modified:   mu-plugin/v-sys-plugin-updater.php
	modified:   mu-plugin/v-sys-theme-updater-mu.php
	modified:   mu-plugin/v-sys-theme-updater.php
	modified:   tests/ApiKeyHelperTest.php
	modified:   update-api/app/Controllers/ApiController.php
	modified:   update-api/app/Controllers/HomeController.php
	deleted:    update-api/app/Controllers/KeyController.php
	modified:   update-api/app/Core/Router.php
	modified:   update-api/app/Models/HostsModel.php
	modified:   update-api/config.php
	modified:   update-api/public/install.php
	deleted:    update-api/storage/test.sqlite
2025-10-20 06:55:25 -04:00
..
src modified: .gitignore 2025-10-20 06:55:25 -04:00
ChangeLog.md modified: .gitignore 2025-10-20 06:55:25 -04:00
composer.json modified: .gitignore 2025-10-20 06:55:25 -04:00
LICENSE modified: .gitignore 2025-10-20 06:55:25 -04:00
README.md modified: .gitignore 2025-10-20 06:55:25 -04:00
SECURITY.md modified: .gitignore 2025-10-20 06:55:25 -04:00

README.md

Latest Stable 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:

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 declare(strict_types=1);
use SebastianBergmann\Version;

$version = new Version('1.0.0', __DIR__);

var_dump($version->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.