saviorenato/版本

v1.0.0 2023-12-21 23:17 UTC

This package is auto-updated.

Last update: 2024-09-22 01:06:15 UTC


README

saviorenato/version 是一个库,它帮助管理Git托管PHP项目的版本号。

安装

您可以使用 Composer 将此库添加到您的项目中,作为本地、按项目的依赖项。

composer require saviorenato/version

如果您仅需要在开发期间使用此库,例如运行您的项目测试套件,那么您应将其添加为开发时间依赖项。

composer require --dev saviorenato/version

使用方法

SavioPereira\Version 类的构造函数期望两个参数

  • $release 是最新版本的版本号(例如 X.Y.Z)或尚未从该分支/版本系列发布时的版本系列名称(X.Y)。
  • $path 是可以找到项目源代码的目录(或其子目录)的路径。通常只需传递 __DIR__ 即可。

除了构造函数之外,SavioPereira\Version 类还有一个公共方法: versionGit()

以下是一个虚构示例,展示了基本用法

<?php 
use SavioPereira\Version;

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

var_dump($version->versionGit());
string(18) "1.0.0-51-6c0648fcb"

准备新的发布时,传递给构造函数的第一个参数中的字符串需要更新。

SavioPereira\Version::versionGit() 的工作原理

  • 如果 $path 不是(部分)Git仓库,并且 $releaseX.Y.Z 格式存在,则返回 $release 作为原样。
  • 如果 $path 不是(部分)Git仓库,并且 $releaseX.Y 格式存在,则返回带有 -dev 后缀的 $release
  • 如果 $path 是(部分)Git仓库,并且 $releaseX.Y.Z 格式存在,则返回 git describe --tags 的输出作为原样。
  • 如果 $path 是(部分)Git仓库,并且 $releaseX.Y 格式存在,则返回一个以 X.Y 开头并带有 git describe --tags 提供的信息结尾的字符串。