README

控制你的Laravel应用程序版本

描述

这是一个Laravel (5.5+) 工具包，可以帮助您保留和管理应用程序版本，增加版本号（主要、次要、补丁、提交），还可以使用您的最后提交哈希值。

此包的最终结果包括

• 在页面上打印版本。
• 在控制台通过Artisan命令打印。

完全兼容SemVer

此包可以解析SemVer版本

v2.0.1-alpha.1227

并将其转换为可使用

label: v
major: 2
minor: 0
patch: 1
prerelease: alpha
buildmetadata: 1227
commit: 49ffe2

您可以使用格式化函数重写并在您的应用程序中显示，例如，如下所示

MyApp version 2.0.1 - alpha 1227 (commit 49ffe2)

这些结果的一些用例可能包括

• 确保回滚成功。
• 了解更新是否到达了所有服务器。
• 检查用户是否正在查看您的应用程序的最新版本。
• 验证Travis CI是否正在测试它应该测试的版本。
• 您只是喜欢为您的项目进行版本控制，并希望在整个页面上查看它们？这也很好。 :)
• 您的用例是什么？ 告诉我们！

特性

使用YAML配置文件轻松控制您应用程序的版本

version: 
    current:
        major: 1
        minor: 0
        patch: 0
        format: '{$major}.{$minor}.{$patch}'
    commit:
        mode: number
        number: 701036

使用您的git提交作为应用程序的提交哈希/编号

配置它

commit:
    mode: git-local

您可能会得到如下输出

MyApp version 1.0.0 (commit a9c03f)

或者只使用增量提交哈希/编号

commit:
    mode: number
    number: 701036

以获取

MyApp version 1.0.0 (commit 701036)

使用Artisan命令轻松增加版本号

php artisan version:commit

它应该打印新版本号

New commit: 701037
MyApp version 1.0.0 (commit 701037) 

全部可用

$ php artisan version:major   
$ php artisan version:minor   
$ php artisan version:patch   
$ php artisan version:build   

输出格式可高度配置

您可以配置

format:
  version: "{$major}.{$minor}.{$patch}"
  full: "version {{'format.version'}} (commit {$commit})"
  compact: "v{{'format.version'}}-{$commit}"

以下是full和compact格式的结果

MyApp version 1.0.0 (commit 701037)
MyApp v1.0.0-701037

它为您提供了对动态方法的访问

Version::compact()

如果您创建了一个新的

format:
  awesome: "awesome version {$major}.{$minor}.{$patch}"

它也将成为可调用的

Version::awesome()

还有一个门面可用

Version::version() // 1.2.25

Version::commit() // 703110

Version::major() // 1

Version::minor() // 2

Version::patch() // 25

Version::format('full') // version 1.0.0 (commit 703110)

Version::full() // version 1.0.0 (commit 703110) -- dynamic method

Version::format('compact') // v.1.0.0-703110

Version::compact() // v.1.0.0-703110 -- dynamic method

实例化它

如果您不希望使用门面

dd(
    Version::format()
);

实例化它的最佳方式是

一个简单的PHP对象实例化

$version = new \PragmaRX\Version\Package\Version();

dd(
    $version->format()
);

或者从容器中获取已经实例化的Version对象

dd(
    app(\PragmaRX\Version\Package\Version::class)->format()
);

但是您必须确保您已经 发布了配置文件

Blade指令也已准备好在您的视图中使用

您可以使用此指令渲染完整的版本格式

@version

或选择格式

@version('full')
@version('compact')

您可以配置指令名称

blade_directive: printversion

然后

@printversion('compact')

Git标签

您可以使用Git标签作为应用程序版本，您只需要将版本源设置为"git"。

version_source: git

如果您在标签中添加了提交哈希/编号

$ git tag -a -f v0.1.1.3128

版本将使用它作为您的应用程序提交哈希/编号

匹配其他版本（Git标签）格式

您可能只需要更改Git版本匹配器

git:
  ...
  version:
    matcher: "/[V|v]*[ersion]*\\s*\\.*(\\d+)\\.(\\d+)\\.(\\d+)\\.*(\\w*)/"

例如，假设您将发布标记为

2017120299
YYYYMMDD##

您可以将匹配器更改为

git:
  version:
    matcher: "/(\d{4})(\d{2})(\d{2})(?:\d{2})/"

并从格式中删除点

format:
  compact: "v{$major}{$minor}{$patch}-{$commit}"

在您的代码中使用当前应用程序版本

以下是一个社区示例，说明如何将应用程序版本号发送到Bugsnag进行异常记录

<?php

namespace App\Exceptions;

use PragmaRX\Version\Package\Version;
use Bugsnag\BugsnagLaravel\Facades\Bugsnag;

class Handler extends ExceptionHandler
{
    public function report(Exception $exception)
    {
        if ($this->shouldReport($exception)) {
            Bugsnag::setAppVersion((new Version())->format('version'));
            Bugsnag::notifyException($exception);
        }
    }
}

提交时间戳

此包还允许您将最后提交的时间戳或当前日期存储到version.yml文件中。这是配置文件中的格式

timestamp:
  year:
  month:
  day:
  hour:
  minute:
  second:
  timezone:

要吸收，只需配置mode: absorb然后执行

php artisan version:absorb

但您也可以设置mode: increment然后执行

php artisan version:timestamp

将当前日期和时间存储到配置文件中

$ php artisan version:minor
New timestamp: 2019-09-16 18:23:03
MyApp version 2.3.2 (commit 49ffe2)

然后您可以在您的应用程序中使用它

Version::format('timestamp-full')

Artisan命令

这些是您可用的命令

version:show

显示当前应用程序版本

$ php artisan version:show
PragmaRX version 1.0.0 (build 701031)

$ php artisan version:show --format=compact
PragmaRX v1.0.0-701031

$ php artisan version:show --format=compact --suppress-app-name
v1.0.0-701031

version:absorb

您需要设置mode: absorb。

版本可以吸收git版本和提交到配置文件中，因此您可以删除.git文件夹，同时保留您的版本和提交以便快速访问。您必须在配置文件中配置git_absorb

commit:
  #...  
  git_absorb: git-local # "false", "git-local" or "git-remote"

然后运行它

$ php artisan version:absorb

实现吸收的常规配置设置是

version_source: config             ## must be set as config
current:
    major: 1                       ## |
    minor: 0                       ## | --> will be changed by absorb
    patch: 0                       ## |
    git_absorb: git-local          ## configure to get from local or remote
commit:
    mode: number                   ## must be set as number
    number: f477c8                 ## will be changed by absorb
    git_absorb: git-local          ## configure to get from local or remote 

version:(major|minor|patch|commit)

您需要设置mode: increment。

增加版本项

$ php artisan version:minor
New minor version: 5
MyApp version 1.5.0 (commit 701045)

正则表达式匹配器

这是当前用于分割版本字符串的正则表达式

^(?P<label>[v|V]*[er]*[sion]*)[\.|\s]*(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

您可以在网上测试它：https://regex101.com/r/Ly7O1x/42

安装

通过Composer

$ composer require pragmarx/version

然后发布您将拥有的配置文件

$ php artisan vendor:publish --provider="PragmaRX\Version\Package\ServiceProvider"

然后您应该可以使用它来在您的视图中使用它

@version

由于git版本是缓存的，您可以通过将刷新命令添加到post-autoload-dump来告诉Composer在每次更新或安装时刷新您的版本号

"post-autoload-dump": [
    ...
    "@php artisan version:refresh"
]

[可选] 您还可以通过在.git/hooks/post-commit中设置来自动化此过程。一旦您提交，它将自动运行命令。

#!/bin/sh

php artisan version:refresh

如果您正在使用Git提交来标记提交号，您可能需要将git存储库添加到您的.env文件中

VERSION_GIT_REMOTE_REPOSITORY=https://github.com/antonioribeiro/version.git

如果您正在使用git-local，请确保当前文件夹是git存储库

最低要求

• Laravel 5.5
• PHP 7.0

测试

$ composer test

故障排除

• 如果您由于symfony/router（3.3/3.4）或symfony/yaml（3.3/3.4）而遇到安装问题，您可以尝试

rm -rf vendor
rm composer.lock
composer install

作者

Antonio Carlos Ribeiro

许可

此软件包根据MIT许可证授权 - 请参阅LICENSE文件以获取详细信息

贡献

欢迎拉取请求和问题。