搜索kanuuu / laravel-git-version
获取应用程序当前 Git 版本的辅助工具
Requires
- illuminate/support: >=4
This package is not auto-updated.
Last update: 2024-09-22 09:18:40 UTC
README
获取项目当前 Git 版本的辅助类。
预期条件是项目基础路径下的 version 文件存在，包含版本字符串，或者 Git 二进制文件可用。
框架版本
此包与 Laravel 4 和 5 以及 Lumen 都兼容。
安装
在 Laravel/Lumen 项目中要求它
composer require kanuuu/laravel-git-version
使用
您可以使用以下方式获取 Git 版本字符串
\Kanuuu\LaravelGitVersion\GitVersionHelper::getVersion()
或者，您可以使用以下方式获取您的应用程序名称和版本号，例如 my-project/1.0
\Kanuuu\LaravelGitVersion\GitVersionHelper::getNameAndVersion()
应用程序的名称来自 Config::get('app.name', 'app')，因此您可以在您的 config/app.php 文件中配置它或将其保留为默认的 app。
推荐的使用模式
确保您的 Git 标签已推送到您的服务器，以便正确描述版本。
在开发阶段以及可能在测试环境中，允许版本自动确定（这是通过 git describe 完成的）。
作为您生产部署程序的一部分，编写一个 version 文件（例如，通过类似 git describe --always --tags --dirty >version 的命令，因为这是此包将运行的命令）。当此 version 文件存在时，包将使用其内容而不是执行 git，从而节省一些处理器和 I/O 时间。
将 /version 添加到您的 .gitignore 文件中，以确保您的工作树保持干净，并且您不会意外提交它。
视图
提供了一个视图，它仅输出一个包含 getNameAndVersion() 返回值的 HTML 注释。我喜欢将其包含在项目的布局模板中。
要使用此功能，请通过将其添加到您的 config/app.php 文件中来安装服务提供程序
'providers' => [
...
Kanuuu\LaravelGitVersion\GitVersionServiceProvider::class,
],
然后视图就可用
@include('git-version::version-comment')